I n st a l l a t i on a n d

Con f i gu r a t i on
Gu i de

Version 2021
M i cr o St r at egy 2021

Decem b er 2021
Copyright © 2021 by MicroStrategy Incorporated. All rights reserved.
Trademark Information
The following are either trademarks or registered trademarks of MicroStrategy Incorporated or its affiliates in the United States and certain other
countries:

Dossier, Enterprise Semantic Graph, Expert.Now, HyperIntelligence, HyperMobile, HyperScreen, HyperVision,

HyperVoice, HyperWeb, Information Like Water, Intelligent Enterprise, MicroStrategy, MicroStrategy 2019, MicroStrategy
2020, MicroStrategy 2021, MicroStrategy Analyst Pass, MicroStrategy Architect, MicroStrategy Architect Pass,
MicroStrategy Badge, MicroStrategy Cloud, MicroStrategy Cloud Intelligence, MicroStrategy Command Manager,
MicroStrategy Communicator, MicroStrategy Consulting, MicroStrategy Desktop, MicroStrategy Developer, MicroStrategy
Distribution Services, MicroStrategy Education, MicroStrategy Embedded Intelligence, MicroStrategy Enterprise Manager,
MicroStrategy Federated Analytics, MicroStrategy Geospatial Services, MicroStrategy Identity, MicroStrategy Identity
Manager, MicroStrategy Identity Server, MicroStrategy Integrity Manager, MicroStrategy Intelligence Server, MicroStrategy
Library, MicroStrategy Mobile, MicroStrategy Narrowcast Server, MicroStrategy Object Manager, MicroStrategy Office,
MicroStrategy OLAP Services, MicroStrategy Parallel Relational In-Memory Engine (MicroStrategy PRIME), MicroStrategy
R Integration, MicroStrategy Report Services, MicroStrategy SDK, MicroStrategy System Manager, MicroStrategy
Transaction Services, MicroStrategy Usher, MicroStrategy Web, MicroStrategy Workstation, MicroStrategy World, Usher,
and Zero-Click Intelligence.

Other product and company names mentioned herein may be the trademarks of their respective owners.
Specifications subject to change without notice. MicroStrategy is not responsible for errors or omissions. MicroStrategy makes no warranties or
commitments concerning the availability of future products or versions that may be planned or under development.
CON TEN TS
1. Planning Your Installation 9

MicroStrategy Products and Components 10

Installation Prerequisites 96
Installation Considerations 120
Methods of Installation 132

Licensing Information 139

Installation and Configuration Checklists 139

2. Installing MicroStrategy on Windows 144

Installation Procedure in Windows 146

Configuring your MicroStrategy Installation 177
R and R Package Installer for Windows 177

3. Installing MicroStrategy on Linux 184

Installation Procedures on Linux 185

Configuring your MicroStrategy Installation 214
R and R Package Installer for Linux 214

Installing and Configuring MicroStrategy Library 222

Library Administration Control Panel 225

Installing MicroStrategy Library on Windows 237
Installing MicroStrategy Library on Linux 249

MicroStrategy Library Server Configuration Properties 263

Configuring Collaboration Server 268
Set Up Application Servers 291
 Linking MicroStrategy Library to MicroStrategy Web 292
Deep Link to Library from Other Applications 293
Privileges in Library Web 296
How to Enable Seamless Login Between Web, Library, and Workstation 299
Ensuring Images in MicroStrategy Web Work With Content in the Library 302
MicroStrategy Library Web Internationalization 303
Load Balancer and Clustering Considerations for Library and Collaboration Server 307
Command Line Tools to Create Security Artifacts 313

Troubleshooting Your MicroStrategy Library Installation 314

Certificate Store Integration with MicroStrategy Library 330
Configuring the Modeling Service 338

4. Activating Your Installation 356

Requesting an Activation Code 357

Activating Your Installation Using License Manager 359
Activating Your Installation Using Silent Mode 361
Server Activation FAQ 364
Configuring your MicroStrategy Installation 371

5. Configuring and Connecting Intelligence Server 372

Communicating with Databases 373

Initial MicroStrategy configuration 385
Connecting to a Data Warehouse and Other Repositories 440
Creating a Project 460
How to Connect the Intelligence Server to a specific Export Engine 460

Configuring your MicroStrategy Installation 461

Data Import with Proxy 462
6. Deploying MicroStrategy Web and Mobile Server 468

Deploying with IIS (Windows) 469

General Steps to Deploy MicroStrategy JSP Applications 473
Deploying with Tomcat (Windows) 478
Deploying with Tomcat (Linux) 484
Deploying with JBoss (Windows) 490
Administering Your MicroStrategy Web Deployment 496
Using Absolute Paths to Share Configuration Files 498

Configuring Third-Party Data Sources for Importing Data 499

Configuring your MicroStrategy Installation 502

7. Setting Up Documents and HTML Documents 503

Prerequisites 504
Executing Documents and HTML Documents in Linux 504
Configuring your MicroStrategy Installation 512

8. Automated Installation on Windows 513

Installation Log File 514

Methods of Installation 516
Configuring your MicroStrategy Installation 574

9. Automated Installation on Linux 575

Silent Installation 576

Configuring MicroStrategy in Command Line Mode 620
Configuring your MicroStrategy Installation 620

10. Deploying OEM Applications 621

Creating DSNs for OEM Environments 623

 Configuring a MicroStrategy Installation 625
Designing a Project and Reporting Environment 625
Customizing MicroStrategy Web 626
Deploying a MicroStrategy OEM Application 627
Tuning an OEM Deployment 633
Updating OEM Applications 634

11. Configuring MicroStrategy Using Command Line Tools 637

Creating a DSN for a Data Source 638

Testing ODBC connectivity 639

Configuring MicroStrategy with a response.ini file 642
Supporting Reserved Words and Characters 668
Configuring your MicroStrategy Installation 669

12. Adding or Removing MicroStrategy Components 670

Adding or Removing MicroStrategy Components on Windows 671

Re-installing MicroStrategy components on Windows 672
Uninstalling MicroStrategy Components on Windows 674
Uninstalling MicroStrategy Components on Linux 677

13. Export Engine Configuration 679

Installation of Export Engine 680

Export Engine: Puppeteer Integration 683
Export Engine Configuration Properties 687
Enable Local Resource Loading for the Export Engine 692

Configure Secure Communication Between the Export Engine and Intelligence

Server 693
A.Connecting to Databases and Data Sources 697

Creating DSNs for Specific Data Sources 697

Creating Database Connections in Web 737
Configuring ODBC Parameters with ODBC.ini 740

MicroStrategy Hadoop Gateway Simplified Installation 742

Introduction to the MicroStrategy Hadoop Gateway 742

Environment Considerations 744
Using the MicroStrategy Hadoop Gateway 750

Troubleshooting 759
Known Issues 768
Frequently Asked Questions 770

Installing and Configuring Topology 776

Introduction to Topology 776

Installing Topology 779
Deploying MicroStrategy Library through a WAR File 782
Enabling Topology Communication Through a Firewall 784
Removing a Service from the Topology Monitor 789
Restarting the Consul 790

Specifying the Topology Communication Agent 790

Changing the Monitoring Agent to a Communication Agent 793
Starting and Stopping Services 794
Supported MicroStrategy Platform Services 798
Troubleshooting Topology 814

Configuring Environments with Dynamic or Multiple IP Addresses 825

Certified Operating Systems for Topology 828
 Certified Web Containers for Topology 829

How to Install the Kerberos Authentication Service 830

B.Troubleshooting 834

Reviewing General Installation Errors 834

Graph and Document Support of Non-Western European Fonts 834
Server Port Number Errors 835
DSN Connection Errors 836
Metadata and Other Repository Creation Errors 836

Permission Errors 837

Core Dump File Problems 841
In st allat io n an d Co n figu r at io n Gu id e

PLAN N IN G YOUR
I N STALLATION

Copyright © 2021 All Rights Reserved 9

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy business intelligence tools help organizations to monitor,

report, and analyze all of their enterprise data. MicroStrategy helps you
make decisions based upon the data within your organization's enterprise
data warehouses and other business data sources.

An overview of the different MicroStrategy components and products is

provided so that you can decide what you need to install. This includes
details on supported functionality and describes important installation
prerequisites that should be considered before you start installing
MicroStrategy products.

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

If you are upgrading to a new version of MicroStrategy, see the Upgrade Help
before upgrading existing metadata.

Starting in MicroStrategy 2021 Update 4, you can install an update using a

full platform installer on both Windows and Linux. This change enables
customers to apply an update without first installing the full platform release.

You can begin determining your installation and configuration plan by

reviewing the following topics:

MicroStrategy Products and Components

Learn about each part of the Intelligence Platform architecture.

MicroStrategy Web
MicroStrategy Web is an interactive, easy to use interface for all Business
Intelligence (BI) reporting, analysis, and monitoring. With MicroStrategy
Web, business users perform any of or all the major styles of BI - Scorecards
and Dashboards, Enterprise Reporting, OLAP Analysis, Predictive Analysis,
and Alerts and Proactive Notification - within a single, unified Web interface.

Copyright © 2021 All Rights Reserved 10

In st allat io n an d Co n figu r at io n Gu id e

Business users move seamlessly between all five styles of BI and even
combine multiple styles within a single report display.

MicroStrategy Web can also be integrated with mapping services to create

sophisticated Geospatial Information System (GIS) applications through the
use of MicroStrategy GIS Connectors. GIS lets business users visualize data
in forms such as maps, globes, reports, and charts so that they can identify
and analyze relationships, patterns, and trends in their data. This Readme
includes MicroStrategy GIS Connectors certification information in the
Certified and Supported Configurations page of the Readme.

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

on a Windows platform.
l You can download the software from the MicroStrategy download site.
l The MicroStrategy Knowledge Base includes technical notes that
document the history of changes to MicroStrategy Web files between
various MicroStrategy releases. To find and review this information,
search the knowledge base using a keyword.

System Requirements
For all certified systems, see Platform Certifications.

Compatibility and Interoperability

MicroStrategy Web 2021 should be connected only to a MicroStrategy
Intelligence Server of the same version or later for production purposes. For
the complete MicroStrategy Platform Compatibility and Interoperability
specification, see Compatibility and Interoperability.

Web Client

Á
Protocols and Ports

HTTP: 8080

Copyright © 2021 All Rights Reserved 11

In st allat io n an d Co n figu r at io n Gu id e

HTTPS: 8443

Linux Inform ation

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

Installation: <InstallPath>/WebUniversal

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

Windows Inform ation

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 following table lists folders and files of interest that are
included in the default directory structure after deploying your MicroStrategy
Web WAR file:

Directory Contents

\assets Supporting files

\html Supporting files

\images All image files

\import Sample files for Data Import analysis

Copyright © 2021 All Rights Reserved 12

In st allat io n an d Co n figu r at io n Gu id e

Directory Contents

\javascript Interface JavaScript files

\jsp Interface JSP code files

\plugins Plug-in files for customizations

\resBundles Flash descriptor files

\style Interface style files

\swf Supporting files for widgets

\VisFramework Supporting files for visualizations

\WEB-INF Configuration information for MicroStrategy Web

ASP.NET interface: The following table lists folders and files of interest that
are included in the default directory structure after an installation of
MicroStrategy Web.

Directory Contents

\asp .Net files

\bin binary files

\images All image files

\javascript Interface JavaScript files

\plugins Plug-in files for customizations

\resBundles Flash descriptor files

\style Interface style files

\swf Supporting files for widgets

\VisFramework Supporting files for visualizations

\WEB-INF Configuration information for MicroStrategy Web

Copyright © 2021 All Rights Reserved 13

In st allat io n an d Co n figu r at io n Gu id e

Web Server

Á
Protocols and Ports

HTTP (JSP): 8080

HTTPS (JSP): 8443

HTTP (ASP): 80

HTTPS (ASP): 443

Linux Inform ation

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

Installation: <InstallPath>/WebUniversal

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

Windows Inform ation

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

MicroStrategy Mobile
MicroStrategy Mobile is an interactive interface of the MicroStrategy BI
platform that lets mobile business users harness the analytical power of
MicroStrategy through the use of their mobile devices. It's the easiest,
fastest, and most affordable way to mobilize analytics, and information-rich
apps to an increasingly mobile and 24 x 7 workforce.

Copyright © 2021 All Rights Reserved 14

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Mobile and the MicroStrategy Mobile Server provide

MicroStrategy reporting and analysis capabilities on Apple iOS and Android
devices. MicroStrategy uses the intuitive interfaces of these mobile devices
to let users explore information using touch and smart gestures.
MicroStrategy Mobile Business Intelligence applications can support
workflows that lead users through data to decisions.

MicroStrategy Mobile also provides application developers a new way to

develop and deploy Mobile applications that is faster, easier, and more
maintainable than using traditional Integrated Development Environments.
MicroStrategy Mobile offers the following benefits:

l Reduces the time to develop new Mobile applications: MicroStrategy's

Mobile application platform includes the infrastructure needed to support
each new Mobile application, so that application developers only need to
focus on creating the user experience and not on the back-end
infrastructure.
l Easy for non-developers to create professional Mobile applications:
MicroStrategy's Mobile applications do not require any coding. Using
MicroStrategy's Mobile application platform, Mobile applications are
assembled in a point-and-click fashion. Application designers can choose
from an array of finely-designed displays and controls that are optimized
for mobile devices.
l Easy for companies to rapidly deploy Mobile application updates:
MicroStrategy's Mobile application platform uses an on-demand form of
application deployment called "in-stream" deployment. As soon as new or
updated applications are ready, they are instantly available to Mobile
users directly from MicroStrategy's Mobile application platform.
l One design for all devices: MicroStrategy Mobile's ability to render the
same application across different mobile device operating systems means
less development time, less application management, and quicker support
for a heterogeneous deployment of mobile devices.

To learn more about MicroStrategy Mobile, see the MicroStrategy Mobile

Administration Help and the MicroStrategy Mobile Analysis Help.

Copyright © 2021 All Rights Reserved 15

In st allat io n an d Co n figu r at io n Gu id e

For information on how to deploy MicroStrategy Mobile Server (ASP.NET)

and MicroStrategy Mobile Server (JSP), see Chapter 6, Deploying
MicroStrategy Web and Mobile Server.

System Requirements
For all certified systems, see Platform Certifications.

Compatibility

MicroStrategy Mobile Clients

See Platform Certifications for supported versions of iOS and Android

operating systems.

Creating a Configuration of Multiple MicroStrategy Mobile Servers

To create a configuration that includes multiple MicroStrategy Mobile

Servers all of the MicroStrategy Mobile Servers must be the same version.
For example, you can use a MicroStrategy 2021 Mobile Server to create a
configuration including multiple MicroStrategy 2021 Mobile Servers.

For the complete MicroStrategy Platform Compatibility and Interoperability

specifications, see Compatibility and Interoperability.

Mobile Client

Á
Protocols and Ports

HTTP: 8080

HTTPS: 8443

Copyright © 2021 All Rights Reserved 16

In st allat io n an d Co n figu r at io n Gu id e

Linux Inform ation

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

Installation: <InstallPath>/Mobile/MobileServer

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

Windows Inform ation

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

Installation: <InstallPath>\MicroStrategy\Web JSP

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

Mobile Server

Á
Protocols and Ports

HTTP (JSP): 8080

HTTPS (JSP): 8443

HTTP (ASP): 80

HTTPS (ASP): 443

Linux Inform ation

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

Installation: <InstallPath>/Mobile/MobileServer

Copyright © 2021 All Rights Reserved 17

In st allat io n an d Co n figu r at io n Gu id e

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

Windows Inform ation

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

Installation: <InstallPath>\MicroStrategy\Web JSP

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

MicroStrategy Intelligence Server

MicroStrategy Server benefits all user roles. The fully featured server
infrastructure is the backbone of any MicroStrategy implementation and
offers all the core platform services, which include:

l 64-bit server infrastructure to scale to big data volumes and a large

number of users.
l Ability to connect to and join data from multiple data sources.
l In-memory acceleration of analytical processing for instantaneous
response.
l Processing of all analytic styles from self-service data discovery to
beautiful, immersive information apps to the industry's broadest spectrum
of advanced analytics.
l Proactive distribution of personalized reports and alerts.
l Ability to embed actionable intelligence in analytical applications.

In addition to all the features above, the Server product includes highly
useful monitoring and automation tools for organizations to effectively and
efficiently manage their deployments.

Copyright © 2021 All Rights Reserved 18

In st allat io n an d Co n figu r at io n Gu id e

Windows Installer 3.0 or later is required to install MicroStrategy products

on a Windows platform.

To install MicroStrategy software, you can download it from the

MicroStrategy download site.

To support the use of a graphical user interface for MicroStrategy tools and
installing MicroStrategy products on Red Hat Enterprise Linux 6, you must
install the libstdc++-4.4.4-XX.el6.i686 package included with your
install media. If you are using Red Hat Enterprise Linux 6.1, you must also
install the libstdc++-4.4.5-XX.el6.i686, elfutils-libelf-
devel.x86-64.rpm, and libXp.x86-64.rpm packages included with
your install media. If you are using Red Hat Enterprise Linux 6.x or 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-bit

Windows operating systems.

MicroStrategy Intelligence Server

MicroStrategy Intelligence Server delivers world-class monitoring, reporting,
and analysis on a single integrated platform, offering next generation BI
capabilities for the full range of BI applications. MicroStrategy Intelligence
Server is the architectural foundation of the MicroStrategy platform. It
performs the following critical tasks for the MicroStrategy BI platform:

l Runs queries, performs calculations, and formats reports

l Significantly improves user-perceived query performance
l Efficiently manages thousands of end-user requests (jobs)
l Serves as a central point for the MicroStrategy metadata

Intelligence Server also provides a library of over 150 different sophisticated

mathematical and statistical functions, which can be added to. See the
Functions Reference for details about these functions.

Copyright © 2021 All Rights Reserved 19

In st allat io n an d Co n figu r at io n Gu id e

All other products in the platform work in conjunction with Intelligence

Server and benefit from its broad functionality.

The subcomponents of MicroStrategy Intelligence Server are as follows:

l MicroStrategy OLAP Services, page 21

l MicroStrategy Report Services, page 22
l MicroStrategy Distribution Services, page 23
l MicroStrategy Transaction Services, page 24
l MultiSource Option, page 24
l Clustering Option, which allows you to cluster a group of Intelligence
Server machines (up to four Intelligence Server machines) to take
advantage of the many benefits available in a clustered environment.

For information on clustering Intelligence Servers, see the System

Administration Help.

Á
Protocols and Ports

TCP: 30241

TCP: 34952

TCP: 34962

Two-Way SSL: 39320

Two-Way SSL: 39321

Linux Inform ation

Configuration: Metadata object - Registry File

Log Location: <logpath>/DSSerrors.log

Copyright © 2021 All Rights Reserved 20

In st allat io n an d Co n figu r at io n Gu id e

Windows Inform ation

Configuration: Metadata object - ServerDef Windows Registry

Installation: <InstallPath>\MicroStrategy\Intelligence Server

Log Location: <InstallPath>\Common

Files\MicroStrategy\log\DSSErrors.log

Directory Structure

The following table lists folders and files of interest that are included in the
default directory structure after installing Intelligence Server.

The default folder is:

l C:\Program Files (x86)\MicroStrategy\Product Name when

installed on a 64-bit Windows environment.
l /opt/MicroStrategy/Product Name, or
$HOME/MicroStrategy/install/Product Name if you do not have
write access to /opt/MicroStrategy, when installed on Linux
environments.

If installing over previous versions of the product, the folder remains the
same.

Directory Contents

\Intelligence Server MicroStrategy Intelligence Server root folder

MicroStrategy OLAP Services

MicroStrategy OLAP Services uses the concept of Intelligent Cube, an in-
memory version of a report that can be manipulated by the Analytical
Engine. MicroStrategy Developer, MicroStrategy Web, and MicroStrategy
Office users can slice and dice data in reports within the Intelligent Cubes
without having to re-execute SQL against the data warehouse.

Copyright © 2021 All Rights Reserved 21

In st allat io n an d Co n figu r at io n Gu id e

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

MicroStrategy Report Services

MicroStrategy Report Services is the enterprise reporting engine of the
MicroStrategy business intelligence platform. A MicroStrategy Report
Services document contains objects representing data coming from one or
more reports, as well as positioning and formatting information. It is used to
format data from multiple reports in a single display of presentation quality.

Copyright © 2021 All Rights Reserved 22

In st allat io n an d Co n figu r at io n Gu id e

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

MicroStrategy Distribution Services

MicroStrategy Distribution Services provides high-volume, automated
distribution of reports, documents, dossiers, and business performance
alerts via email, file servers, FTP servers, and networked printers.

Copyright © 2021 All Rights Reserved 23

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Transaction Services

MicroStrategy Transaction Services lets you embed write-back functionality
into reports and dashboards for the purposes of decision-making or initiating
a transaction. These transactions can include one-click approvals and
denials, notes for tracking and directing business activity, and write-back to
data sources in real time.

Users of MicroStrategy Web, MicroStrategy Mobile for iPhone, and

MicroStrategy Mobile for iPad can employ these transaction capabilities
from reports, dashboards, and MicroStrategy Mobile applications.

MultiSource Option
With MultiSource Option, you can connect a project to multiple relational
data sources. This allows you to integrate all your information from various
databases and other relational data sources into a single MicroStrategy
project for reporting and analysis purpose. All data sources included using
the MultiSource Option are integrated as part of the same relational schema
for a project.

Copyright © 2021 All Rights Reserved 24

In st allat io n an d Co n figu r at io n Gu id e

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

MicroStrategy Command Manager

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

Copyright © 2021 All Rights Reserved 25

In st allat io n an d Co n figu r at io n Gu id e

For information on using Command Manager, see the System Administration

Help.

MicroStrategy Enterprise Manager

MicroStrategy Enterprise Manager provides insights about governing and
tuning all areas of your MicroStrategy environment. With Enterprise
Manager, you can see a variety of Intelligence Server usage statistics. The
statistics shown in predefined reports displayed by Enterprise Manager can
help you make scheduling decisions, analyze bottlenecks, and tune
performance.

Copyright © 2021 All Rights Reserved 26

In st allat io n an d Co n figu r at io n Gu id e

For information on using Enterprise Manager, see the Enterprise Manager

Guide.

MicroStrategy System Manager

MicroStrategy System Manager lets you define multiple configurations for
your MicroStrategy environment that can be executed in a single workflow.
This provides the ability to deploy various configurations to as many
systems as required. You can deploy these configurations using a standard
interface, an interactive command line process, or a completely silent
configuration process.

System Manager lets you create a workflow visually, allowing you to see the
step-by-step process that leads the workflow from one configuration to the
next. This visual approach to creating a workflow can help you to notice
opportunities to troubleshoot and error check configurations as part of a
workflow.

For information on using MicroStrategy System Manager to configure and

deploy your MicroStrategy environments, see the System Administration
Help.

Copyright © 2021 All Rights Reserved 27

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Narrowcast Server

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

Subscriptions can also be supported through Intelligence Server with the

introduction of Distribution Services. For information on Distribution
Services, see MicroStrategy Distribution Services, page 23.

For information on Narrowcast Server subcomponents, see the

MicroStrategy Narrowcast Server Installation and Configuration Guide.

SequeLink ODBC Socket Server

SequeLink is a complete, end-to-end solution for configuring and managing
data access across virtually any number of data stores, operating systems,
and deployment options. SequeLink ODBC Socket Server is required to
support MicroStrategy Narrowcast Server. It can also be used to access
Microsoft Access databases and Microsoft Excel files stored on a Windows
machine from an Intelligence Server hosted on a Linux machine (see
MicroStrategy ODBC Driver for SequeLink, page 711).

The SequeLink ODBC Socket Server that is provided with a MicroStrategy

installation is for exclusive use with the MicroStrategy Product Suite. You
are not licensed to use this product with any application other than
MicroStrategy products. You can contact Progress® DataDirect® to
purchase the SequeLink ODBC Socket Server for use with non-
MicroStrategy products.

Copyright © 2021 All Rights Reserved 28

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Architect
MicroStrategy Architect is designed to meet the needs of application
architects and developers. It includes all the schema development, change
management, and modeling tools that enable architects to manage the full
development life cycle of MicroStrategy applications. The Architect product
allows IT organizations to flexibly share and distribute roles and
responsibilities for development, testing, promotions, and migrations during
the application lifestyle, leading to vast improvements in organizational
efficiency.

MicroStrategy Developer

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

on a Windows platform.
l If you are installing MicroStrategy Developer on Windows Vista or later
versions, you must install Microsoft's DHTML Editing Control for
Applications Redistributable Package. The redistributable package
contains files that were removed with the release of Windows Vista, but
are required for MicroStrategy Developer to work properly. For
information on this redistributable package and the necessary installation
steps, see the following link.
l You can download the software from the MicroStrategy download site.
l To install and access MicroStrategy Server Administrator, when installing
MicroStrategy Developer, your license key must be licensed for
MicroStrategy Intelligence Server.

MicroStrategy Developer provides analytical features designed to facilitate

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

Developer also enables you to create application objects. The application

objects are built on the schema objects that are created in MicroStrategy
Architect. These application objects are used to analyze and provide insight

Copyright © 2021 All Rights Reserved 29

In st allat io n an d Co n figu r at io n Gu id e

into relevant data. The following sections provide a brief description of the
subcomponents for these products.

The subcomponents of MicroStrategy Developer include:

l MicroStrategy Analyst is a simplified version of MicroStrategy Developer,

providing the basic interactive reporting functionality required by
managers.
l MicroStrategy Developer is a full-featured version for power analysts and
application developers. With a full range of analytical functionality, a rich
library of functions, and intelligent workflow, Developer is well suited for
power users.
l MicroStrategy Architect provides project designer functionality such as
attribute, fact, hierarchy, and project creation and modification. Architect
contains the following subcomponents:
l MicroStrategy Function Plug-in Wizard is an add-in to the Microsoft
Visual C++ compiler, which comes with a standard MicroStrategy
installation. It allows you to create a C++ project, with which you can
implement your own custom MicroStrategy function plug-in. The option
to install this component is enabled only if Microsoft Visual C++ version
2005 (8.0) or version 2010 (10.0) is present on the system where the
installation is being performed.
l Customers interested in deploying analytics from the R programming
language into MicroStrategy can do so using the R Integration Pack,
available on MicroStrategy's GitHub page.
l MicroStrategy Server Administrator is a MicroStrategy Intelligence Server
administrative console that provides functionality such as system
monitoring, cache management, and user and group management.

When installing MicroStrategy Developer, your license key must be licensed

for MicroStrategy Intelligence Server to install and access MicroStrategy
Server Administrator.

Copyright © 2021 All Rights Reserved 30

In st allat io n an d Co n figu r at io n Gu id e

For information on various options present in Developer to create and run

reports, see the Basic Reporting Help. After you are familiar with basic
Developer concepts, see the Advanced Reporting Help for information on
advanced Developer functionality.

Directory Structure

The following table lists folders and files of interest that are included in the
default directory structure after an installation of Developer.

The default folder is:

C:\Program Files (x86)\MicroStrategy\Product Name when

installed on a 64-bit Windows environment.

If installed over previous versions of the product, the folder remains the
same.

Directory Contents

\MicroStrategy\Desktop MicroStrategy Developer root directory

Custom images used by the MicroStrategy

\MicroStrategy\Desktop\Images
Developer application

On a 64-bit Windows environment:

\Program Files (x86)\Common Log directory, for diagnostics output

Files\MicroStrategy\Log

MicroStrategy Architect
MicroStrategy includes a project design tool known as Architect. Architect
allows you to define all the required components of your project from a
centralized interface. Architect also provides a visual representation of your
project as you create it, which helps to provide an intuitive workflow.

For information on using Architect to design a project in MicroStrategy, see

the Project Design Help.

Copyright © 2021 All Rights Reserved 31

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Integrity Manager

MicroStrategy Integrity Manager is an automated report comparison tool.
Report SQL, report data, and graphs can be executed and compared in
Integrity Manager to help customers verify change success. In addition, the
report comparison output can be analyzed at the report level in
MicroStrategy Integrity Manager, and as HTML and XML summary files that
are generated to provide easily distributed results to other users.

To learn more about MicroStrategy Integrity Manager, see the System

Administration Help.

MicroStrategy Object Manager

MicroStrategy Object Manager provides complete life cycle management
capabilities for MicroStrategy environments. Using Object Manager, you can
copy objects within a project or across related projects.

Copyright © 2021 All Rights Reserved 32

In st allat io n an d Co n figu r at io n Gu id e

For information on using Object Manager, see the System Administration

Help.

MicroStrategy SDK
The MicroStrategy SDK is a collection of programming tools, utilities,
documentation, and libraries of functions or classes designed to customize
and extend MicroStrategy products for integration within other applications.
The programming tools provided by the MicroStrategy SDK—including
programming instructions, points of access, and guidelines for developers—
allow programmers to enhance the operation of their software by
customizing and embedding the MicroStrategy BI platform.

The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) are

not included in the MicroStrategy installation. You can download the
MicroStrategy SDK and access the MicroStrategy Developer Library from
the MicroStrategy support site.

Copyright © 2021 All Rights Reserved 33

In st allat io n an d Co n figu r at io n Gu id e

The MicroStrategy SDK provides access to the entire MicroStrategy platform

and includes everything required to build a feature-filled business
intelligence-enabled application. The MicroStrategy SDK is made up of the
following components:

l The MicroStrategy SDK includes the following individual SDKs, which are
described in detail in the MicroStrategy Developer Library:
l Web SDK
l MicroStrategy REST API
l Visualization SDK
l MicroStrategyLibrary SDK
l Embedding SDK
l Mobile SDK
l Narrowcast Server SDK
l Intelligence Server SDK
l MicroStrategy Office SDK
l Each of the individual SDKs listed above is made up of some of or all the
following components:

Copyright © 2021 All Rights Reserved 34

In st allat io n an d Co n figu r at io n Gu id e

l A comprehensive set of APIs that includes:

l REST API services
l COM-based client-server API
l XML-based Web API with support for Java/COM
l Narrowcast Server API

The set of MicroStrategy APIs provides support for a variety of

development environments, including Java, C++, VB, XML, and standard
Web and client-server technologies.

l A complete set of SDK documentation for all the MicroStrategy products

that includes:
l Reference guides such as Javadocs for the APIs.
l The MicroStrategy Developer Library (MSDL), which provides all the
information required to understand and use the MicroStrategy SDK.
l A variety of development tools that include:
l Source code and sample application code for typical customization tasks
l Development tools and production-ready utilities to reduce code
creation/maintenance and help you build customized applications.
l Specialized development tools, such as the Portal Integration Kit and
the Web Services Development Kit
l Features for packaging your application, including embedded (silent)
installation and schema services to upgrade the metadata.

MicroStrategy Sample Projects

MicroStrategy provides a set of packaged analytic components built using
the MicroStrategy platform. These include the Human Resources Analysis
Module and the MicroStrategy Tutorial.

Human Resources Analysis Module

The Human Resources Analysis Module contains sample dossiers and
reports, as well as the reporting objects that can be used to create typical

Copyright © 2021 All Rights Reserved 35

In st allat io n an d Co n figu r at io n Gu id e

Human Resources reports. The Human Resources Analysis Module

Reference is a guide that provides sample usages and descriptions for each
of the module's dossiers and reports and the supporting objects that define
them.

The Human Resources Analysis Module can be mapped to a different

warehouse or used as a starter kit to develop custom applications. The
module consists of a MicroStrategy project in a metadata, a reference guide,
and a default data model.

MicroStrategy Tutorial Reporting

MicroStrategy Tutorial Reporting is a sample MicroStrategy project with a
warehouse, and a set of demonstration dossiers, reports, and other objects,
designed to illustrate the platform's rich functionality. The MicroStrategy
Tutorial Reporting metadata is provided as part of the MicroStrategy
Analytics Modules metadata.

The theme of the Tutorial project is a retail store that sells electronics,
books, movies, and music. The key features include:

l Five hierarchies: Customer, Geography, Products, Promotions, and Time.

Each hierarchy can be viewed graphically through MicroStrategy
Developer and MicroStrategy Web (through documents).
l A large number of customers and items purchased.
l Five reporting areas: Human Resources, Inventory, Financial, Product
Sales, and Supplier.
l Options to create reports from MicroStrategy Web or Developer focusing
on a particular analysis area, such as Customer, Inventory, Time,
Products, Category, Employee, or Call Center.

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

MicroStrategy Telemetry Server

Copyright © 2021 All Rights Reserved 36

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Telemetry Server on Windows

Telemetry Server is a component that is coupled with the Intelligence
Server during installations and upgrades. Telemetry Server is configured
out-of-the-box and runs automatically after the installation is completed.

After installation, you can see the following services are automatically
started:

l Apache Kafka (C:\Program Files

(x86)\MicroStrategy\Telemetry Server\Kafka\kafka_
2.13-2.6.1)
l Apache ZooKeeper (C:\Program Files
(x86)\MicroStrategy\Telemetry Server\Kafka\kafka_
2.13-2.6.1)

By default MicroStrategy will still send Intelligence Server diagnostic

logs to local disk. Diagnostic logs will be sent to the Telemetry Server
Server after you perform the following:

l Enable MicroStrategy Telemetry Server

l Turn On the Sending Log to Telemetry Server Feature

Afterwards you will see Kafka log files created in the Kafka installation
folder:

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

Server\tmp\kafka-logs

Different Kafka topics will be created to store data for different

MicroStrategy components.

Co n f i gu r i n g Tel em et r y Ser ver af t er u p gr ad i n g

By default, MicroStrategy Telemetry Server are installed along with the

Intelligence server upgrade.

Copyright © 2021 All Rights Reserved 37

In st allat io n an d Co n figu r at io n Gu id e

Telemetry Server Workflow for Intelligence Server

l Intelligence Server is the Kafka Producer and can be deployed as a
single node or cluster.

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

Enable MicroStrategy Telemetry Server

Telemetry Server configuration is saved in the MicroStrategy Intelligence
Server configuration. It can be enabled or disabled on the fly, without
restarting your Intelligence Server.

Com m and Manager Scripts for Telem etry Server

To check if Telemetry Server is enabled, execute:

LIST ALL PROPERTIES FOR SERVER CONFIGURATION;

To enable Telemetry Server through Command Manager, execute:

ALTER SERVER CONFIGURATION ENABLETELEMETRYSERVER TRUE

CONFIGURETELEMETRYSERVER
"bootstrap.servers:10.15.208.236:9092/batch.num.messag
es:5000/queue.buffering.max.ms:2000";

Copyright © 2021 All Rights Reserved 38

In st allat io n an d Co n figu r at io n Gu id e

In the example above set:

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

number.
l batch.num.messages: to the number of messages to send in one
batch when using asynchronous mode.
l queue.buffering.max.ms: to the maximum time to buffer data
when using asynchronous mode.

You can specify more Kafka Producer configuration settings in this

command following the same format.

Turn On the Sending Log to Telemetry Server Feature

You can turn on the Sending Log to Telemetry Server feature using
either 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 Telemetry Server in the Features for
Customer Feedback section.
4. Select On from the drop-down menu.
5. Click Apply.

From Com m and Manager

1. Connect to your project source.

2. Execute the following:

ALTER FEATURE FLAG "SENDING LOG TO TELEMETRY

SERVER" ON;

Copyright © 2021 All Rights Reserved 39

In st allat io n an d Co n figu r at io n Gu id e

Modifying Telemetry Server Configuration

Apache Kafka Server

The Kafka Server can be configured by modifying the

server.properties file found in:

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

Server\Kafka\kafka_2.13-2.6.1\config

Both Apache Kafka Server and ZooKeeper should be restarted after

modifying the above configuration file.

MicroStrategy Telemetry Server Configuration for Clustered

Environments
If you have clustered your Intelligence Servers and want to use a
separate machine to run MicroStrategy Telemetry Server after
upgrading, complete the following 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 Telemetry Server

l Apache Kafka
l Apache Zookeeper

Configure Zookeeper

1. Browse to folder C:\Program Files

(x86)\MicroStrategy\Telemetry Server\Kafka\kafka_
2.13-2.6.1\config.

2. Edit file zookeeper.properties by adding following lines:

Copyright © 2021 All Rights Reserved 40

In st allat io n an d Co n figu r at io n Gu id e

clientPort=2181

dataDir=C:\\Program Files
(x86)\\MicroStrategy\\Telemetry
Server\\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 as

shown above. You attribute the server id to each machine by
creating a text file named myid, one for each server, which resides
in that server's data directory, as specified by the configuration file
parameter dataDir = C:\Program Files
(x86)\MicroStrategy\Telemetry Server\tmp\zookeeper

3. Go to folder C:\Program Files

(x86)\MicroStrategy\TelemetryServer\Kafka\kafka_
2.13-2.6.1\config.

4. Create a text file named myid containing the identifying value from
the server parameter name in the zookeeper.properties file.

Configure Kafka

1. Browse to folder C:\Program Files

(x86)\MicroStrategy\Telemetry Server\Kafka\kafka_
2.13-2.6.1\config.

Copyright © 2021 All Rights Reserved 41

In st allat io n an d Co n figu r at io n Gu id e

2. Edit file server.properties, add a row

zookeeper.connect=10.27.20.16:2181,10.27.20.60:2181
,10.15.208.236:2181 to the Zookeeper section.

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

# Zookeeper connection string (see zookeeper docs

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 string to

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:21
81

3. Modify the broker.id value to a unique integer from other Kafka

servers (the default value is 0), such as for node 10.27.20.60 we
use number 2.

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

#############################

# The id of the broker. This must be set to a

unique integer for each broker.

broker.id=2

Copyright © 2021 All Rights Reserved 42

In st allat io n an d Co n figu r at io n Gu id e

Start, Stop, Restart, and Check Status of Telemetry Server

On Windows installations, open Task Manager > Services to start, stop,
restart, and check the status of Telemetry Server components.

MicroStrategy Telemetry Server on Linux

Telemetry Server is a component that is coupled with the Intelligence
Server during installations and upgrades. Telemetry Server is configured
out-of-the-box and runs automatically after the installation is completed.

After installation, you can see the following services are automatically
started:

l Apache Kafka
(/opt/MicroStrategy/TelemetryServer/Kafka/kafka_2.13-
2.6.0)
l Apache ZooKeeper
(/opt/MicroStrategy/TelemetryServer/Kafka/kafka_2.13-
2.6.0)

By default MicroStrategy will still send Intelligence Server diagnostic

logs to local disk. Diagnostic logs will be sent to the Telemetry Server
after you perform the following:

l Enable MicroStrategy Telemetry Server

l Turn On the Sending Log to Telemetry Server Feature

Afterwards you will see Kafka log files created in the Kafka installation
folder:

/opt/MicroStrategy/TelemetryServer/Kafka/tmp/kafka-logs

Copyright © 2021 All Rights Reserved 43

In st allat io n an d Co n figu r at io n Gu id e

Different Kafka topics will be created to store data for different

MicroStrategy components.

Co n f i gu r i n g Tel em et r y Ser ver af t er u p gr ad i n g

By default, MicroStrategy Telemetry Server are installed along with the

Intelligence server upgrade.

Telemetry Server Workflow for Intelligence Server

l Intelligence Server is the Kafka Producer and can be deployed as a
single node or cluster.

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

Enable MicroStrategy Telemetry Server

Telemetry Server configuration is saved in the MicroStrategy Intelligence
Server configuration. It can be enabled or disabled on the fly, without
restarting your Intelligence Server.

Com m and Manager Scripts for Telem etry Server

To check if Telemetry Server is enabled, execute:

LIST ALL PROPERTIES FOR SERVER CONFIGURATION;

Copyright © 2021 All Rights Reserved 44

In st allat io n an d Co n figu r at io n Gu id e

To enable Telemetry Server through Command Manager, execute:

ALTER SERVER CONFIGURATION ENABLETELEMETRYSERVER TRUE

CONFIGURETELEMETRYSERVER
"bootstrap.servers:10.15.208.236:9092/batch.num.messag
es:5000/queue.buffering.max.ms:2000";

In the example above set:

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

number.
l batch.num.messages: to the number of messages to send in one
batch when using asynchronous mode.
l queue.buffering.max.ms: to the maximum time to buffer data
when using asynchronous mode.

You can specify more Kafka Producer configuration settings in this

command following the same format.

Turn On the Sending Log to Telemetry Server Feature

You can turn on the Sending Log to Telemetry Server feature using
either 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 Telemetry Server in the Features for
Customer Feedback section.
4. Select On from the drop-down menu.
5. Click Apply.

Copyright © 2021 All Rights Reserved 45

In st allat io n an d Co n figu r at io n Gu id e

From Com m and Manager

1. Connect to your project source.

2. Execute the following:

ALTER FEATURE FLAG "SENDING LOG TO TELEMETRY

SERVER" ON;

Modifying Telemetry Server Configuration

Apache Kafka Server

The Kafka Server can be configured by modifying the

server.properties file found in:

/opt/MicroStrategy/TelemetryServer/Kafka/kafka_2.13-
2.6.0

Both Apache Kafka Server and ZooKeeper should be restarted after

modifying the above configuration file.

MicroStrategy Telemetry Server Configuration for Clustered

Environments
If you have clustered your Intelligence Servers and want to use a
separate machine to run MicroStrategy Telemetry Server after
upgrading, complete the following 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 Telemetry Server

l Apache Kafka
l Apache Zookeeper

Copyright © 2021 All Rights Reserved 46

In st allat io n an d Co n figu r at io n Gu id e

Configure Zookeeper

1. Browse to folder
/opt/MicroStrategy/TelemetryServer/Kafka/kafka_
2.13-2.6.0/config.

2. Edit file zookeeper.properties by adding following lines:

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 as

shown above.

3. Go to folder
/opt/MicroStrategy/TelemetryServer/Kafka/kafka_
2.13-2.6.0/config.

4. Create a file named myid containing the identifying value from the
server parameter name in the zookeeper.properties file.

Configure Kafka

1. Browse to folder
/opt/MicroStrategy/TelemetryServer/Kafka/kafka_
2.13-2.6.0/config.

Copyright © 2021 All Rights Reserved 47

In st allat io n an d Co n figu r at io n Gu id e

2. Edit file server.properties, add a row

zookeeper.connect=10.27.20.16:2181,10.27.20.60:2181
,10.15.208.236:2181 to the Zookeeper section.

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

# Zookeeper connection string (see zookeeper docs

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 string to

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:21
81

3. Modify the broker.id value to a unique integer from other Kafka

servers (the default value is 0), such as for node 10.27.20.60 we
use number 2.

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

#############################

# The id of the broker. This must be set to a

unique integer for each broker.

broker.id=2

Copyright © 2021 All Rights Reserved 48

In st allat io n an d Co n figu r at io n Gu id e

Start, Stop, Restart, and Check Status of Telemetry Server

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

To start or stop Kafka Server and Zookeeper, go to

/opt/MicroStrategy/TelemetryServer/Kafka/kafka_2.13-
2.6.0/bin and execute one of the following:

l ./kafka-server-start.sh ../config/server.properties
l ./kafka-server-stop.sh
l ./zookeeper-server-start.sh
../config/zookeeper.properties
l ./zookeeper-server-stop.sh

MicroStrategy Platform Analytics

Platform Analytics is the next generation telemetry tool that leverages data
from across the MicroStrategy platform including:

l Environment composition
l System usage
l Project usage
l User activity
l Content usage
l Cube usage
l Subscription usage
l Quality
l Licensing
l Identity

Data is streamed in real time through the MicroStrategy Telemetry Server

layer and stored in the Platform Analytics warehouse. Platform Analytics

Copyright © 2021 All Rights Reserved 49

In st allat io n an d Co n figu r at io n Gu id e

provides several ways to access, analyze, and act on this telemetry,

including out of the box standard dossiers and native telemetry interfaces in
MicroStrategy Workstation; empowering administrators to provide a better
experience to MicroStrategy users.

Á
Protocols and Ports

TCP: 5432

Linux Inform ation

Configuration:
<InstallPath>/MicroStrategy/PlatformAnalytics/conf

Installation: <InstallPath>/MicroStrategy/PlatformAnalytics

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

Windows Inform ation

Configuration: <InstallPath>\MicroStrategy\Platform
Analytics\conf

Installation: <InstallPath>\MicroStrategy\Platform Analytics

Log Location: <InstallPath>\MicroStrategy\Platform

Analytics\log

Accessing Platform Analytics

You can access Platform Analytics data in three different ways depending on
your needs:

l By viewing the Platform Analytics data embedded in Workstation:

One of the exciting features of Platform Analytics is that it exposes some

Copyright © 2021 All Rights Reserved 50

In st allat io n an d Co n figu r at io n Gu id e

of the data that it captures directly in the user interface of Workstation.

This allows users who would otherwise not know how to consume Platform
Analytics data, to gain access to important MicroStrategy data. For more
information, see How to View Dossier Usage in the Workstation Help.
l By running the out-of-the-box Platform Analytics dossiers: Platform
Analytics ships with a MicroStrategy project that provides out-of-the-box
dossiers designed to showcase some of the data that Platform Analytics
captures for each of the different system areas. The dossiers included with
Platform Analytics are:
l Compliance Telemetry: Determine if a MicroStrategy implementation
complies with the license entitlements.
l Cube and Cache Monitoring: Ensure that cubes and caches are being
fully leveraged to improve the performance of key analytics content.
l Error Analysis: Detect errors and anomalies in the system and improve
the experience of MicroStrategy users by fixing those issues.
l Object Telemetry: Identify the most popular analytics content in the
system and determine who is viewing it and how fast it runs.
l Project Overview: Analyze the performance of the MicroStrategy
projects and determine which users connect to them and which products
they use to connect.
l Subscription Analysis: Determine which analytics content users
subscribe to and how much load these subscriptions create on the
system.
l User Activity: Monitor what users do in MicroStrategy and ensure that
they have a positive experience free of performance issues and other
errors.
l By creating your own dossiers: Platform Analytics also supports the
creation of self-service content (dossiers, reports, and documents) which
are based on the out-of-the-box schema and application objects included
in the Platform Analytics project.

Copyright © 2021 All Rights Reserved 51

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Repository
To help reduce deployment complexity MicroStrategy now includes an
embedded repository that can support the following MicroStrategy products:

l Metadata Repository
l Collaboration Server
l Platform Analytics
l Remote Repository

The infrastructure is installed and ready for use should this be the right fit
for your deployment. This embedded repository is automatically configured,
optimized, and managed for you with no manual intervention required for
routine usage.

Installation

MicroStrategy Repository is installed if either Platform Analytics,

Collaboration Server, or both are installed.

l Product Name: Repository

l Default Installation Path: C:\Program Files (x86)\Common
Files\MicroStrategy\<MSTR_INSTALL>\Repository

l Repository directory structure:

l \pgsql
l \repository-administration

How to log in to MicroStrategy Repository

The installer will create users and database tables for Platform Analytics
and Collaboration Server. Default_Accounts.txt is the file
containing the user names and passwords to the repository created
during the installation. The default location of Default_Accounts.txt

Copyright © 2021 All Rights Reserved 52

In st allat io n an d Co n figu r at io n Gu id e

is C:\Program Files (x86)\Common

Files\MicroStrategy\Default_Accounts.txt. This file should be
moved to a secure location upon completing the install.

Users created in the Repository by the installer:

User
Access Privileges
name

MicroStrategy user has access to Platform

mstr Analytics and Collaboration Server Super User
databases.

MicroStrategy user has access to the CREATE DATABASE,

Platform Analytics database, but does not SELECT DATABASE,
mstr_pa
have access to the Collaboration Server SELECT TABLE, CREATE
database. TABLE, DROP TABLE

MicroStrategy user has access to the

No Create DB, SELECT,
mstr_ Collaboration Server database but does
INSERT, CREATE TABLE,
collab not have access to the Platform Analytics
DROP TABLE
database.

Databases created in the Repository by the installer:

Product Database

Platform Analytics platform_analytics_wh

Collaboration Server mstr_collab

To log in navigate to:

C:\Program Files (x86)\Common

Files\MicroStrategy\<MSTR_
INSTALL>\Repository\pgsql\bin

Copyright © 2021 All Rights Reserved 53

In st allat io n an d Co n figu r at io n Gu id e

and run:

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

Repository is installed if either Platform Analytics, Collaboration Server,

or both installed.

l Product Name: Repository

l Default Installation Path: /opt/mstr/MicroStrategy/<MSTR_
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 verify the version of the PostgreSQL run:

/opt/mstr/MicroStrategy/<MSTR_
INSTALL>/Repository/bin/mstr_pgsql --version

How to log in to MicroStrategy Repository

The installer will create users and database tables for Platform Analytics
and Collaboration Server. Default_Accounts.txt is the file
containing the user names and passwords to the repository created
during the installation. The default location of Default_Accounts.txt
is /opt/mstr/MicroStrategy/<MSTR_

Copyright © 2021 All Rights Reserved 54

In st allat io n an d Co n figu r at io n Gu id e

INSTALL>/Repository/Default_Accounts.txt. This file should be

moved to a secure location upon completing the install.

Users created in the Repository by the installer:

User
Access Privileges
name

MicroStrategy user has access to Platform

mstr Analytics and Collaboration Server Super User
databases.

MicroStrategy user that has access to the CREATE DATABASE,

Platform Analytics database, but does not SELECT DATABASE,
mstr_pa
have access to the Collaboration Server SELECT TABLE, CREATE
database. TABLE, DROP TABLE

MicroStrategy user that has access to the

No Create DB, SELECT,
mstr_ Collaboration Server database but does
INSERT, CREATE TABLE,
collab not have access to the Platform Analytics
DROP TABLE
database.

Databases created in the Repository by the installer:

Product Database

Platform Analytics platform_analytics_wh

Collaboration Server mstr_collab

To log in navigate to:

/opt/mstr/MicroStrategy/<MSTR_INSTALL>/Repository/bin

and run:

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

Copyright © 2021 All Rights Reserved 55

In st allat io n an d Co n figu r at io n Gu id e

Installation Scenarios

The tables below explain how the installation and configuration of

MicroStrategy Repository is handled based on the installation type and the
components selected.

Fr esh In st al l at i o n

Components
Result
Installed

Platform
Platform Analytics is installed and configured with Repository, mstr &
Analytics alone
mstr_pa user credentials are populated in the Default_Accounts.txt file
is installed

Collaboration Collaboration Server is installed and configured with Repository, mstr &
Server alone is mstr_collab user credentials are populated in the Default_Accounts.txt
installed file

Platform
Analytics and
Repository is installed and configured with the both products and
Collaboration
Default_Accounts.txt file is generated with all three user credentials
Server are
installed

Collaboration
Server is Repository is installed in both nodes, mstr & mstr_collab user
installed in one credentials are populated in the Default_Accounts.txt file on the
node and Collaboration Server, installation node, mstr & mstr_pa user
Platform credentials are populated in the Default_Accounts.txt file on the
Analytics on Platform Analytics installation node
other

Copyright © 2021 All Rights Reserved 56

In st allat io n an d Co n figu r at io n Gu id e

M o d i f y Cu r r en t In st al l at i o n

Currently
Installed Modification Result
Components

Add Platform
Repository is installed and configured with the both
Analytics and
products and Default_Accounts.txt file is generated
Collaboration
with all three user credentials.
Neither Platform Server
Analytics or
Platform Analytics is installed and configured with
Collaboration Add Platform
Repository and mstr, mstr_pa user credentials are
Server are Analytics
populated in the Default_Accounts.txt file.
installed
Add Collaboration Server is installed and configured with
Collaboration Repository and mstr, mstr_collab user credentials
Server are populated in the Default_Accounts.txt file.

Collaboration Server is uninstalled and all

Collaboration data is deleted from Repository and
Remove
Collaboration user credentials are deleted from
Collaboration
Default_Accounts.txt file (Users are warned to take
Server
the backup of Collaboration Server data before
performing the install operation).

Platform Platform Analytics is uninstalled and all Platform

Analytics and Analytics data is deleted from Repository and
Remove
Collaboration Platform Analytics user credentials are deleted from
Platform
Server are both Default_Accounts.txt file (Users are warned to take
Analytics
installed the backup of Platform Analytics data before
performing the install operation).

Remove Platform Analytics and Collaboration Server are

Platform uninstalled along with Repository and directories are
Analytics & deleted (Users are warned to take the backup of
Collaboration Platform Analytics and Collaboration Server data
Server before performing the install operation).

Only Platform Add Collaboration Server is installed and configured with

Analytics was Collaboration existing Repository and collaboration user

Copyright © 2021 All Rights Reserved 57

In st allat io n an d Co n figu r at io n Gu id e

Currently
Installed Modification Result
Components

credentials are appended in Default_Accounts.txt

installed Server
file.

Only Platform Analytics is installed and configured with

Collaboration Add Platform existing Repository and Platform Analytics user
Server was Analytics credentials are appended in Default_Accounts.txt
installed file.

Up gr ad e 10.4.x In st al l at i o n t o 2021 w i t h M i cr o St r at egy Rep o si t o r y

Current Installation Upgrade Installation Result

l Platform
Analytics is
installed and
configured with
Repository.
l mstr & mstr_pa
user credentials
Adding Platform Analytics are populated
in the Default_
Neither Platform Analytics or Accounts.txt
Collaboration Server are Installed file on the
Platform
Analytics
installation
node.

l Collaboration
Server is
Adding Collaboration Server installed and
configured with
Repository.

Copyright © 2021 All Rights Reserved 58

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

l mstr & mstr_

collab user
credentials are
populated in the
Default_
Accounts.txt file
on the
Collaboration
Server
installation
node.

l Platform
Analytics and
Collaboration
Server are
installed and
configured with
Adding Platform Analytics &
Repository.
Collaboration Server
l Default_
Accounts.txt
file is
generated with
all three user
credentials.

Up gr ad e 2019 In st al l at i o n t o 2021 w i t h M i cr o St r at egy Rep o si t o r y

Current Installation Upgrade Installation Result

l Platform
Neither Platform Analytics or Analytics is
Collaboration Server are Adding Platform Analytics installed and
Installed configured with
Repository.

Copyright © 2021 All Rights Reserved 59

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

l mstr & mstr_pa

user credentials
are populated in
the Default_
Accounts.txt file
on the Platform
Analytics
installation node.

l Collaboration
Server is
installed and
configured with
Repository.
l mstr & mstr_
collab user
Adding Collaboration Server credentials are
populated in the
Default_
Accounts.txt file
on the
Collaboration
Server
installation node.

l Platform
Analytics and
Collaboration
Server are
installed and
Adding Platform Analytics & configured with
Collaboration Server Repository.
l Default_
Accounts.txt file
is generated with
all three user
credentials.

Copyright © 2021 All Rights Reserved 60

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

l Platform
Analytics is
upgraded with
existing MySQL
DB configuration.

Note: Post
installation, the
Platform
Analytics
Consumer will be
down. Upgrade
the MySQL WH
manually
No Changes following the
documentation.

l PostgreSQL
Platform Analytics Installed Repository files
are laid.
l Platform
Analytics
Warehouse is
upgraded and
mstr & mstr_pa
user credentials
are populated in
the Default_
Accounts.txt file.

l Platform
Analytics is
upgraded with
existing MySQL
Adding Collaboration Server
DB configuration.

Note: Post
installation, the

Copyright © 2021 All Rights Reserved 61

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

Platform
Analytics
Consumer will be
down. Upgrade
the MySQL WH
manually
following the
documentation.

l PostgreSQL
Repository files
are laid. Platform
Analytics
Warehouse and
Collaboration
database will be
created.
l mstr, mstr_pa &
mstr_collab user
credentials are
populated in the
Default_
Accounts.txt file.

l Platform
Analytics will be
uninstalled.
Removing Platform Analytics
l No Repository
files are
installed.

l Collaboration
Server is
Collaboration Server Installed upgraded,
Adding Platform Analytics
Platform
Analytics is
installed and

Copyright © 2021 All Rights Reserved 62

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

both are
configured with
Repository.
l mstr, mstr_pa &
mstr_collab user
credentials are
populated in the
Default_
Accounts.txt file.

l MongoDB will be
backed-up and
restored after
upgrade install
with services
down.

Note: User can

manually start
the service and
migrate the data.

l Collaboration
Remove Collaboration Server Server will be
uninstalled.

l Collaboration
Server is
upgraded and
configured with
Repository.
No Changes l mstr & mstr_
collab user
credentials are
populated in the
Default_
Accounts.txt file.

Copyright © 2021 All Rights Reserved 63

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

l MongoDB will be
backed-up and
restored after
upgrade install
with services
down

Note: User can

manually start
the service and
migrate the data.

l Platform
Analytics is
upgraded with
existing MySQL
DB configuration.

Note: Post
installation, the
Platform
Analytics
Consumer will be
down. Upgrade
Platform Analytics or the MySQL WH
No Changes
Collaboration Server Installed manually
following the
documentation.

l PostgreSQL
Repository files
are laid, Platform
Analytics
Warehouse is
created.
l Collaboration
Server is
upgraded and

Copyright © 2021 All Rights Reserved 64

In st allat io n an d Co n figu r at io n Gu id e

Current Installation Upgrade Installation Result

configured with
Repository.
l mstr, mstr_pa &
mstr_collab user
credentials are
populated in the
Default_
Accounts.txt file.

l MongoDB will be
backed-up and
restored after
upgrade install
with services
down.

Note: User can

manually start
the service and
migrate the data
following
documentation.

Up gr ad e 2020 In st al l at i o n t o 2021 w i t h M i cr o St r at egy Rep o si t o r y

l Platform
Analytics is
installed and
configured with
Neither Platform Analytics or Repository.
Collaboration Server are Adding Platform Analytics l mstr & mstr_pa
Installed user credentials
are populated
in the Default_
Accounts.txt
file on the

Copyright © 2021 All Rights Reserved 65

In st allat io n an d Co n figu r at io n Gu id e

Platform
Analytics
installation
node.

l Collaboration
Server is
installed and
configured with
Repository.
l mstr & mstr_
collab user
credentials are
Adding Collaboration Server
populated in the
Default_
Accounts.txt file
on the
Collaboration
Server
installation
node.

l Platform
Analytics and
Collaboration
Server are
installed and
configured with
Adding Platform Analytics &
Repository.
Collaboration Server
l Default_
Accounts.txt
file is
generated with
all three user
credentials.

l Platform
Platform Analytics Installed Analytics is
No Changes
upgraded with
existing DB

Copyright © 2021 All Rights Reserved 66

In st allat io n an d Co n figu r at io n Gu id e

configuration

l Platform
Analytics is
upgraded with
existing DB
configuration

l Platform
Analytics
Warehouse and
Adding Collaboration Server Collaboration
database will
be created.

l mstr_collab
user credentials
are populated
in the Default_
Accounts.txt
file.

l Platform
Removing Platform Analytics Analytics will be
uninstalled.

l Collaboration
Server is
upgraded,
Platform
Analytics is
installed and
both are
Collaboration Server Installed
Adding Platform Analytics configured with
Repository.

l mstr_pa user
credentials are
populated in the
Default_
Accounts.txt
file.

Copyright © 2021 All Rights Reserved 67

In st allat io n an d Co n figu r at io n Gu id e

l Collaboration
Remove Collaboration Server Server will be
uninstalled.

l Collaboration
Server is
No Changes upgraded and
configured with
Repository.

l Platform
Analytics and
Platform Analytics or Collaboration is
No Changes
Collaboration Server Installed upgraded with
existing DB
configuration.

Up gr ad e Cu r r en t In st al l at i o n

The following scenarios apply to upgrades from MicroStrategy versions

10.4.8, 2019, and 2020 to MicroStrategy 2020.

Current Upgraded
Result
Installation Installation

l Platform Analytics is installed and configured with

Repository.
Adding Platform
Neither
l mstr & mstr_pa user credentials are populated in
Analytics
Platform the Default_Accounts.txt file on the Platform

Analytics or Analytics installation node.

Collaboration l Collaboration Server is installed and configured

Server Installed with Repository.
Adding
Collaboration l mstr & mstr_collab user credentials are populated
Server in the Default_Accounts.txt file on the Collaboration
Server installation node.

Copyright © 2021 All Rights Reserved 68

In st allat io n an d Co n figu r at io n Gu id e

Current Upgraded
Result
Installation Installation

Adding Platform l Platform Analytics and Collaboration Server are

Analytics & installed and configured with Repository.
Collaboration l Default_Accounts.txt file is generated with all three
Server user credentials.

l Platform Analytics is upgraded with existing MySQL

DB configuration (Post install the Platform
Analytics Consumer will be down - user is
recommended to upgrade the MySQL WH manually
No Changes following the documentation).
l PostgreSQL Repository files are laid.
l Platform Analytics Warehouse is upgraded and
mstr & mstr_pa user credentials are populated in
the Default_Accounts.txt file.

l Platform Analytics is upgraded with existing

Platform
MySQL DB configuration (Post install the Platform
Analytics
Analytics Consumer will be down - user is
Installed
recommended to upgrade the MySQL WH manually
Adding following the documentation).
Collaboration
l PostgreSQL Repository files are laid.
Server
l Platform Analytics Warehouse is created
Collaboration database will be created.
l mstr, mstr_pa & mstr_collab user credentials are
populated in the Default_Accounts.txt file.

Remove
l Platform Analytics will be uninstalled.
Platform
l No Repository files are installed.
Analytics

l Collaboration Server is upgraded, Platform

Collaboration Analytics is installed and both are configured with
Adding Platform
Server Installed Repository.
Analytics
l mstr, mstr_pa & mstr_collab user credentials are
populated in the Default_Accounts.txt file

Copyright © 2021 All Rights Reserved 69

In st allat io n an d Co n figu r at io n Gu id e

Current Upgraded
Result
Installation Installation

l MongoDB will be backed-up and restored after

upgrade install with services down (User can
manually start the service and migrate the data
following documentation).

Remove
l Collaboration Server will be uninstalled.
Collaboration
l No Repository files are installed.
Server

l Collaboration Server is upgraded and configured

with Repository.
l mstr & mstr_collab user credentials are populated
in the Default_Accounts.txt file.
No Changes
l MongoDB will be backed-up and restored after
upgrade install with services down (User can
manually start the service and migrate the data
following documentation).

l Platform Analytics is upgraded with existing MySQL

DB configuration (Post install the Platform
Analytics Consumer will be down - user is
recommended to upgrade the MySQL WH manually
following the documentation).

Platform l PostgreSQL Repository files are laid, Platform

Analytics or Analytics Warehouse is created.
Collaboration No Changes l Collaboration Server is upgraded and configured
Server Installed with Repository.
l mstr, mstr_pa & mstr_collab user credentials are
populated in the Default_Accounts.txt file.
l MongoDB will be backed-up and restored after
upgrade install with services down (User can
manually start the service and migrate the data
following documentation).

Copyright © 2021 All Rights Reserved 70

In st allat io n an d Co n figu r at io n Gu id e

Remote Repository for Windows and Linux

MicroStrategy recommends you leverage the embedded repository.
However, if you prefer to use a previously installed MicroStrategy repository
or your own PostgreSQL database, you have the option to utilize a remote
repository. To help reduce deployment complexity, MicroStrategy includes a
remote repository that can support the following products:

l Platform Analytics
l Collaboration Server
l MicroStrategy Storage Service (currently a preview feature)

This remote repository allows users to centralize all their information in one
database server without having multiple instances running. Users can
leverage their own PostgreSQL database or an existing MicroStrategy
repository during installation.

For a Fresh Install

By default, MicroStrategy Repository is checked as a component when

installing Platform Analytics and/or Collaboration server. To use an existing
MicroStrategy repository or your own PostgreSQL database:

1. Deselect MicroStrategy Repository as a component you want to

install, to prevent another instance being installed by MicroStrategy.
Click Next.
2. To use a remote repository, provide the connectivity information to be
used. Click Next.
3. If you are connecting to your own PostgreSQL database, the connection
and permissions to create the database are validated by the installer.

4. If you prefer to use an existing MicroStrategy repository for Platform

Analytics and/or Collaboration server, a pop-up message appears.
Click Use Existing.

Copyright © 2021 All Rights Reserved 71

In st allat io n an d Co n figu r at io n Gu id e

If there is a connection issue, the installer prompts you to provide the

correct host, port, username, and password.

For an Upgrade Install

By default, MicroStrategy Repository is checked as a component when

upgrading Platform Analytics and/or Collaboration server.

Up gr ad i n g f r o m M i cr o St r at egy 10 t o M i cr o St r at egy 2019

To use an existing MicroStrategy repository or your own PostgreSQL

database:

1. Ensure MicroStrategy Repository is unselected and click Next.

2. To use a remote repository, provide the connectivity information to be

used and click Next.

If you have a MongoDB Repository and want to keep the existing data,
you must migrate the data to the PostgreSQL database. Use the
Database Administration Tool to create any necessary backup before
proceeding. See Repository Administration to learn more about the
Database Administration Tool.

3. Once the backup is complete, provide the connectivity information to be

used and click Next.

Up gr ad i n g f r o m M i cr o St r at egy 2020

To use an existing MicroStrategy repository or your own PostgreSQL

database, Collaboration server and/or Platform Analytics must be
uninstalled before you install MicroStrategy 2021.

Repository Services

Copyright © 2021 All Rights Reserved 72

In st allat io n an d Co n figu r at io n Gu id e

File Name Location Info

C:\Program Files (x86)\Common This file accepts

MicroStrategy
Files\MicroStrategy\<MSTR_ start/stop/restart/status
Repository
INSTALL>\Repository\pgsql\bin parameters.

mstr-root@<TIMESTAMP>-
repository-administration is
stored into the initd_scripts
directory when you decide
not to setup the
C:\Program Files (x86)\Common MicroStrategy processes as
MicroStrategy
Files\MicroStrategy\<MSTR_ services, they can use this
Repository
INSTALL>\Repository\repository- script to do it later.
administration
administration
Some people also find it
practical to have all the
startup scripts on the same
directory and with the
timestamp-less name.

File Name Location Info

This file accepts

star/stop/restart/status
/opt/mstr/MicroStrategy/<MS parameters.
mstr_pg_ctl TR_ It is a wrapper pointing to
INSTALL>/Repository/bin <MSTR_
INSTALL>/Repository/postgres1
1/bin/pg_ctl

mstr- The PostgreSQL service called

root@<TIMESTA /etc/init.d when booting up or when issuing
MP>-repository- start/stop/status/restart

Copyright © 2021 All Rights Reserved 73

In st allat io n an d Co n figu r at io n Gu id e

File Name Location Info

commands using the "service"

command.

This file will be created only if you

have selected to run the
MicroStrategy processes as
services during the installation.
server
Setup will set the service to start
automatically upon system
startup. In case of a Platform
Analytics upgrade (and
collaboration is not installed), this
service is set to manual.

mstr-root@<TIMESTAMP>-
repository-server is stored into
initd_scripts directory when user
decides not to setup the
MicroStrategy processes as
respository- services, they can use this script
/opt/mstr/MicroStrategy/insta
server to do it later.
ll/initd_scripts
Some people also find it practical
to have all the startup scripts on
the same directory and with the
timestamp-less name.

mstr-root@<TIMESTAMP>-
repository-administration is
stored into the initd_scripts
directory when you decide not to
repository- setup the MicroStrategy
/opt/mstr/MicroStrategy/instal
administration processes as services, they can
l/initd_scripts
use this script to do it later.

Some people also find it practical

to have all the startup scripts on

Copyright © 2021 All Rights Reserved 74

In st allat io n an d Co n figu r at io n Gu id e

File Name Location Info

the same directory and with the

timestamp-less name.

Repository Administration

The following database administration tasks are performed by the

Database Administration Tool:

l Backup at a specified frequency or on-demand

l Restore a particular database from previously taken backup files
l Restore all databases from previously taken backup files

Configuration File

DBAdminConfig.yaml is a configuration file is used to set up the

database connection, the backup location, and database administration
tasks frequency.

The default location of DBAdminConfig.yaml is:

C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\repository-
administration\conf

Sample file:

---
pgHost: localhost
pgDbNames:
- platform_analytics_wh
- mstr_collab
pgUser: mstr
pgPasswd: sest+9y+e6OdXIXTHjgPoC7osqE0rGMzgjR1zA==,kc7GbAQ8pv5yt32L

Copyright © 2021 All Rights Reserved 75

In st allat io n an d Co n figu r at io n Gu id e

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 Adm inistration Tool

To launch the Database Administration Tool:

1. Open the command prompt and navigate to the repository-

administration bin folder:

C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\repository-
administration\bin

2. Run the file mstr-repo-ondemand-dba-operations.bat.

This will open the DBAOperations utility:

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

Enter choice
1) Backup

Copyright © 2021 All Rights Reserved 76

In st allat io n an d Co n figu r at io n Gu id e

2) Restore
3) Vacuum
0) Exit

The utility exits after every operation.

To Backu p

Selecting the Backup option (1) will list all the databases from the
DBAdminConfig.yaml file along with the options to backup all
databases and exit the utility.

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 will be backed up in the default backup directory, inside their

individual folders:

l ..\Repository\pgsql\PGDATA\platform_analytics_wh
l ..\Repository\pgsql\PGDATA\mstr_collab

The utility will compute the following:

l Database size
l Estimated backup size
l Available 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

Copyright © 2021 All Rights Reserved 77

In st allat io n an d Co n figu r at io n Gu id e

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

If the backup was already done on the given day’s timestamp, the utility
will ask the user whether he wants to overwrite the existing backup.

(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
(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
(platform_analytics_wh) Backup File Size: 1.5 MiB
*** Finished backup operation on database: platform_analytics_wh ***

To Rest o r e

Ensure that all applications connected to the database you want to restore
are stopped. For example, if you want to restore platform_analytics_
wh, you must stop the Platform Analytics Consumer before selecting and
performing the steps in Restore.

Selecting the Restore option (2) on the main menu will show a warning
that the operation will overwrite the existing data. However, the utility
will 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)

Copyright © 2021 All Rights Reserved 78

In st allat io n an d Co n figu r at io n Gu id e

*** 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, will move the utility forward and list all the databases that
can be restored as well as an option to restore everything. If Restore all
is selected, it will restore all the databases with the latest backup file.

*** 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)
y
Select the database you want to restore.
1) platform_analytics_wh
2) mstr_collab
3) Restore all databases.
0) Exit

Selecting a given database will move the utility forward and display the
restore options. The first option will backup the selected database with
its latest backup file. The second option allows for selection of a custom
backup.

If Restore from Latest Backup is selected, the utility will find the latest
backup file in the default directory, print the name of the file, restore the
database, and create a pre-restore backup in the directory to ensure
data 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

Copyright © 2021 All Rights Reserved 79

In st allat io n an d Co n figu r at io n Gu id e

Starting restore process

*** Restoring database : platform_analytics_wh

If Restore from Custom Backup is selected, the utility will print the path
to the default backup location and ask the user if they want to search for
backups in that path. The user can then select that path or enter a
custom path. After the file path is entered, the user needs to enter the
restore file name. The utility will search for the file and begin restoring if
the file is found.

Select restore file

1) Restore from Latest Backup
2) Restore from Custom Backup
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.
*** Restoring database : platform_analytics_wh

To Vacu u m

Whenever rows in a PostgreSQL table are updated or deleted, dead rows

are left behind. Vacuum gets rid of them so that space can be reused. If
a table doesn’t get vacuumed, it will get bloated, which wastes disk
space and slows down sequential table scans.

If the Vacuum option (3) is selected, the utility computes bloat for all
databases and generates a report to the user.

Copyright © 2021 All Rights Reserved 80

In st allat io n an d Co n figu r at io n Gu id e

****** 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

Copyright © 2021 All Rights Reserved 81

In st allat io n an d Co n figu r at io n Gu id e

lu_db_version | 1.0
| 0
lu_object_type | 1.0
| 0
lu_product | 1.0
| 0
** Bloat report for database: mstr_collab **
Table Name | Bloat Percent
| Wasted KBs
Select the database you want to vacuum.
1) platform_analytics_wh
2) mstr_collab
3) vacuum all databases
4) Full vacuum all databases.
0) Exit

You can choose to vacuum an individual database, vacuum all

databases, or full vacuum all databases.

When performing vacuum, the dead space is reclaimed and made

available for reuse by the same object, table, etc.

Full vacuum all databases writes the entire content of the table
into a new disk file and releases the wasted space back to the OS. This
causes a table-level lock on the table and slows speeds. Full vacuum
all databases should be avoided on a high load system. You must
stop the Platform Analytics Consumer before performing full vacuum all
databases.

*** 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

Copyright © 2021 All Rights Reserved 82

In st allat io n an d Co n figu r at io n Gu id e

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 2021 also includes a tool to monitor MicroStrategy

Repository. For configuration settings, please refer to the Configuration
File section above.

Tr i gger st at i st i cs co l l ect i o n

Capacity planning statistics collection is turned on by default after

installation. The service is controlled with a batch file which accepts
start | stop | restart | status as parameters.

1. From the command prompt, go to:

C:\Program Files (x86)\Common

Files\MicroStrategy\Repository\repository-
administration\bin

2. Call the following batch file with the applicable parameter:

Copyright © 2021 All Rights Reserved 83

In st allat io n an d Co n figu r at io n Gu id e

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

restart | status

To change the time of statistics collection, see KB483944.

M o n i t o r i n g Dat ab ase St at u s

The Platform Analytics project includes the Database Capacity Planning

dossier to monitor the status of MicroStratey Repository.

l Overview page:

The overview will give some basic info about the database, including
database names, IP, and database versions as well as the trend of
database size growth.

l Transactions page:

Transactions will give the daily trend if the database commits,

rollbacks, disk reads, cache hits.

Copyright © 2021 All Rights Reserved 84

In st allat io n an d Co n figu r at io n Gu id e

l Table Overview page:

For the table-level information, table overview will show stats about
each table in the selected database. Right-click on a listed schema or
table, and click Go To Page: Table Trend to get the detailed data of
this table or schema.

Copyright © 2021 All Rights Reserved 85

In st allat io n an d Co n figu r at io n Gu id e

l Table Trend page:

Copyright © 2021 All Rights Reserved 86

In st allat io n an d Co n figu r at io n Gu id e

The following database administration tasks are performed by the

Database Administration Tool:

l Backup at a specified frequency or on-demand

l Restore a particular database from previously taken backup files
l Restore all databases from previously taken backup files

DBAdminConfig.yaml is a configuration file is used to set up the

database connection, the backup location, and database administration
tasks frequency.

The default location of DBAdminConfig.yaml is:

/opt/MicroStrategy/Repository/repository-
administration/conf

Sample file:

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

Copyright © 2021 All Rights Reserved 87

In st allat io n an d Co n figu r at io n Gu id e

The following files should be accessible:

l pg_dump
l pg_restore

To change the time of statistics collection, see KB483944.

Database Adm inistration Tool

To launch the Database Administration Tool:

1. Open a terminal window and navigate to the repository-

administration/bin folder:

/opt/MicroStrategy/Repository/repository-
administration/bin

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

This will open the DBAOperations utility:

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

Enter choice
1) Backup
2) Restore
3) Vacuum
0) Exit

The utility exits after every operation.

To Backu p

Selecting the Backup option (1) will list all the databases from the
DBAdminConfig.yaml file along with the option to backup all
databases and exit the utility.

User selected: 1 (Backup)

Select the database you want to backup.
1) platform_analytics_wh

Copyright © 2021 All Rights Reserved 88

In st allat io n an d Co n figu r at io n Gu id e

2) mstr_collab
3) Backup all databases.
0) Exit

Databases will be backed up in the default backup directory, inside their

individual folders:

l /opt/MicroStrategy/Repository/repository-
administration/backups/platform_analytics_wh
l /opt/MicroStrategy/Repository/repository-
administration/backups/mstr_collab

The utility will compute the following:

l Database size
l Estimated backup size
l Available 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: backupplatform_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, it will ask
if you want to overwrite the existing backup.

(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
(platform_analytics_wh) Backup already done today. Date : 20190930
Overwrite File ? (y/n)
y

Copyright © 2021 All Rights Reserved 89

In st allat io n an d Co n figu r at io n Gu id e

(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
(platform_analytics_wh) Backup File Size: 1.5 MiB
*** Finished backup operation on database: platform_analytics_wh ***

To Rest o r e

Ensure that all applications connected to the database you want to restore
are stopped. For example, if you want to restore platform_analytics_
wh, you must stop the Platform Analytics Consumer before selecting and
performing the steps in Restore.

Selecting the Restore option (2) on the main menu will show a warning
that the operation will overwrite the existing data. However, the utility
will take a backup just before restoring to ensure no data is lost.

User selected: 2 (restore)

Select the database you want to restore.
1) platform_analytics_wh
2) mstr_collab
3) Restoreall databases.
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 will move the utility forward and list all the databases that
can be restored along with the option to restore everything. Selecting
restore all will restore all the databases with the latest backup file.

Copyright © 2021 All Rights Reserved 90

In st allat io n an d Co n figu r at io n Gu id e

*** 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)
y
Select the database you want to restore.
1) platform_analytics_wh
2) mstr_collab
3) Restore all databases.
0) Exit

Selecting a given database will move the utility forward and display the
restore options. The first option lets you backup the selected database
with its latest backup file. The second option allows you to select a
custom backup.

If Restore from Latest Backup is selected the utility will find the latest
backup file in the default directory, print the name of the file, restore the
database, and create a pre-restore backup in the directory to ensure
data 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 /opt/MicroStrategy/Repository/repository-
administration/backups/platform_analytics_wh
Starting restore process
*** Restoring database : platform_analytics_wh

If Restore from Custom Backup is selected, the utility will print the path
to the default backup location and ask if you want to search for backups
in that path. You can then select that path or enter a custom path. After
the file path is entered, enter the restore file name. The utility will search
for the file and begin restoring if the file is found.

Copyright © 2021 All Rights Reserved 91

In st allat io n an d Co n figu r at io n Gu id e

Select restore file

1) Restore from Latest Backup
2) Restore from Custom Backup
0) Exit
2
Restoring custom backup
Default backup path : /opt/MicroStrategy/Repository/repository-
administration/backups/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.
*** Restoring database : platform_analytics_wh

To Vacu u m

Whenever rows in a PostgreSQL table are updated or deleted, dead rows

are left behind. Vacuum gets rid of them so that the space can be
reused. If a table doesn’t get vacuumed, it will get bloated, which wastes
disk space and slows down sequential table scans.

If the Vacuum option (3) is selected, the utility computes bloat for all
databases 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 **
Table Name | Bloat Percent

Copyright © 2021 All Rights Reserved 92

In st allat io n an d Co n figu r at io n Gu id e

| 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 **
Table Name | Bloat Percent
| Wasted KBs
Select the database you want to vacuum.
1) platform_analytics_wh

Copyright © 2021 All Rights Reserved 93

In st allat io n an d Co n figu r at io n Gu id e

2) mstr_collab
3) vacuum all databases.
4) Full vacuum all databases.
0) Exit

You can choose to vacuum an individual database, vacuum all

databases, or full vacuum all databases.

When performing vacuum, the dead space is reclaimed and made

available for reuse by the same object, table, etc.

Full vacuum all databases writes the entire content of the table
into a new disk file and releases the wasted space back to the OS. This
causes a table-level lock on the table and slows speeds. Full vacuum
all databases should be avoided on a high load system. You must
stop the Platform Analytics Consumer before performing full vacuum all
databases.

*** 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

Copyright © 2021 All Rights Reserved 94

In st allat io n an d Co n figu r at io n Gu id e

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 Com m ands

l \q: Quit/Exit
l \c __database__: Connect to a database
l \d __table__: Show table definition including triggers
l \d+ __table__: More detailed table definition including description and
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 all schemas (if *.* is omitted will only show
SEARCH_PATH tables)
l \dT+: List all data types.
l \dv: List views.
l \df+ __function__ : Show function SQL code.
l \x: Pretty-format query results 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:

Copyright © 2021 All Rights Reserved 95

In st allat io n an d Co n figu r at io n Gu id e

l \du: List users

l \du __username__: List a username if present.
l create role __test1__: Create a role with an existing username.
l create role __test2__ noinherit login password __
passsword__;: Create a role with username and password.
l set role __test__;: Change role for current session to __test__.
l grant __test2__ to __test1__;: Allow __test1__ to set its role as _
_test2__.

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

l MicroStrategy installation files.

l Before you begin upgrading any MicroStrategy systems, contact your
MicroStrategy account executive to obtain a new license key for the
version of software you are installing.
l License key from MicroStrategy.
l You can access the installation files by asking your system administrator
to share the files on a network location.
l You can reduce the amount of data that has to be downloaded for an
installation by excluding some of the installation files in the
Installations/DataFiles folder. During installation, the
MicroStrategy Installation Wizard then lists which of these files are
required for your MicroStrategy installation. You can use this technique to
provide only the files required to complete a MicroStrategy installation,
which can then be used to reduce the amount of data packaged and
downloaded for other MicroStrategy installations in your organization. For
steps to use this technique to create custom installation packages, see
Creating Custom Installation Packages, page 133.
l Installation location for your MicroStrategy products

Copyright © 2021 All Rights Reserved 96

In st allat io n an d Co n figu r at io n Gu id e

To install MicroStrategy on Windows, you must have the following

permissions and privileges:

l You must log on to your machine using a domain account with Windows
administrative privileges for the domain or target machine.
l The user installing MicroStrategy needs write permissions in the
installation directory to complete the installation; otherwise the installation
fails.

In addition to the information provided above, review the following sections

before the installation:

l Recommended Installation Location and Example Deployments, page 97

l Hardware Requirements and Recommendations, page 100
l Software Requirements and Recommendations, page 108

Recommended Installation Location and Example

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

l Intelligence Server should be installed on its own dedicated server

machine.
l MicroStrategy Web should be installed on its own dedicated Web server
machine.
l The rest of the products can be installed in varying combinations
depending on who intends to use them and on what machines.

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

Copyright © 2021 All Rights Reserved 97

In st allat io n an d Co n figu r at io n Gu id e

The following sections provide basic examples of differently sized

production deployments with MicroStrategy products. The examples are
generalized and do not include all of the MicroStrategy products. You can
use these examples to help plan how to deploy MicroStrategy products.

Small production deployment

Copyright © 2021 All Rights Reserved 98

In st allat io n an d Co n figu r at io n Gu id e

Medium production deployment

Copyright © 2021 All Rights Reserved 99

In st allat io n an d Co n figu r at io n Gu id e

Large production deployment

Hardware Requirements and Recommendations

MicroStrategy acknowledges that variables, such as CPU speed, CPU type,
operating system version, service upgrades, file space, and physical and
swap memory, are factors that play an important role in making your
deployment of MicroStrategy a successful one.

Determining the necessary hardware requirements to support MicroStrategy

is dependent on many factors including the complexity of your
MicroStrategy environment, the deployment strategy of MicroStrategy
features, user community requirements, expected peak usage
requirements, and response time expectations. Factors such as these must
be considered to determine the hardware requirements for your
MicroStrategy production environment.

For details and exact information regarding supported and certified

operating system versions for a MicroStrategy release, see Platform
Certifications

Copyright © 2021 All Rights Reserved 100

In st allat io n an d Co n figu r at io n Gu id e

For Linux systems, several system settings can affect the performance of
MicroStrategy Intelligence Server. These settings do not need to be set
before a MicroStrategy installation. For more information on these settings
and their recommended values, see Recommended System Settings for
Linux, page 130.

System hardware requirements and recommendations for

Windows
The following table lists the recommended and minimum hardware
requirements for MicroStrategy products. The information provided is
intended to give you general guidance on hardware requirements to support
the MicroStrategy product suite. Determining the necessary hardware
requirements to support MicroStrategy is dependent on many factors
including but not limited to the complexity of your MicroStrategy
environment, the deployment strategy of MicroStrategy features, user
community requirements, expected peak usage requirements, and response
time expectations. Factors such as these must be considered to determine
the hardware requirements for your MicroStrategy production environment.

• To ensure the installation process is completed successfully, all

MicroStrategy platform and Update installations require 15 GB of
disk space for the installer itself. This is in addition to any component
or common file storage requirements listed below.

• MicroStrategy installs a set of common files that are shared when

installing multiple MicroStrategy products on the same machine. With
a typical installation setup type, these files are installed on the C:
drive.

In addition to the storage requirements listed for the products in the

table below, you should estimate an additional 2 GB of storage space
for the common files that are shared amongst all products. While this
estimate is conservatively high, planning for this additional space
helps to ensure a successful installation.

Copyright © 2021 All Rights Reserved 101

In st allat io n an d Co n figu r at io n Gu id e

• The storage requirements listed in the table below for Intelligence

Server and Narrowcast Server include additional space than is
required for the initial installation. This additional space is to support
the creation of the various files that these products require
throughout their use in a MicroStrategy environment. Additional
space may be required depending on the use of Intelligence Server
and Narrowcast Server in your MicroStrategy environment.

• Intelligence Server is licensed based on CPU number and clock

speed. Thus, Intelligence Server can only be installed on machines
with a maximum clock speed that equals the licensed clock speed. If
you try to install the product on a machine faster than what is
licensed, installation fails. See the System Administration Help for
more information about licensing.

MicroStrategy Product Memory Storage

MicroStrategy System Manager 2 GB 0.5 GB

MicroStrategy Command Manager 2 GB 0.25 GB

MicroStrategy Enterprise
1 GB 0.25 GB
Manager

MicroStrategy Object Manager 1 GB 0.25 GB

MicroStrategy Developer products 2 GB or higher 0.25 GB

4 GB or higher Three times the

amount of RAM
Using 4 GB of RAM is a minimum
available to
level of support for the
Intelligence
MicroStrategy Product Suite,
Server. For
which does not take into account
MicroStrategy Intelligence Server example, an
the performance of a production
Intelligence
system. Performance testing has
Server that is
shown that 64 GB or more of RAM
provided 4 GB of
should be available to allow
RAM requires 12
MicroStrategy Intelligence Server
GB of hard drive

Copyright © 2021 All Rights Reserved 102

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Product Memory Storage

to fully support and take

advantage of the complete feature
set of the MicroStrategy Product
Suite, while obtaining system-
wide high performance. This level
of system resources allows
MicroStrategy Intelligence Server
to fully use performance- space.
improving technologies such as
MicroStrategy OLAP Services,
and to support optimal
performance for MicroStrategy
Report Services documents and
dossiers and the other features of
the MicroStrategy Product Suite.

MicroStrategy Integrity Manager 2 GB or higher 0.25 GB

MicroStrategy Office 2 GB 0.5 GB

The MicroStrategy Mobile Server hardware

MicroStrategy Mobile Server requirements are the same as those for MicroStrategy
Web Server hardware requirements.

MicroStrategy Narrowcast Server 4 GB 4 GB

The SDK is not included in the MicroStrategy

MicroStrategy SDK installation and can instead be downloaded from the
MicroStrategy support site.

MicroStrategy Analytics Modules Not applicable 0.5 GB

MicroStrategy
Web can be
accessed from a
MicroStrategy Web: Web Client 2 GB or higher third-party web
browser, which
means there are
no additional

Copyright © 2021 All Rights Reserved 103

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Product Memory Storage

storage
requirements.

MicroStrategy Web: Web Server 4 GB or higher 0.5 GB

MicroStrategy Library Web Server 4 GB or higher recommended per

1.5 GB
on Windows CPU core

MicroStrategy Library Web Server 4 GB or higher recommended per

3 GB
on UNIX CPU core

System hardware requirements and recommendations on Linux

The following information is intended to give you general guidance on
hardware requirements to support the MicroStrategy product suite.
Determining the necessary hardware requirements to support MicroStrategy
is dependent on many factors including but not limited to the complexity of
your MicroStrategy environment, the deployment strategy of MicroStrategy
features, user community requirements, expected peak usage requirements,
and response time expectations. Factors such as these must be considered
to determine the hardware requirements for your MicroStrategy production
environment.

• The storage recommendations listed in the table below provide an

estimate for installing and supporting each MicroStrategy product on
a separate machine. For information on the total size of a
MicroStrategy installation when installing all MicroStrategy products
on the same machine, see below.

• A successful configuration of Intelligence Server depends on a valid

combination of an operating system and a CPU architecture. Valid
operating system and CPU architecture combinations for Intelligence
Server are listed in the table below.

Copyright © 2021 All Rights Reserved 104

In st allat io n an d Co n figu r at io n Gu id e

• The storage requirements listed in the table below for Intelligence

Server include additional space than is required for the initial
installation. This additional space is to support the creation of the
various files that these products require throughout their use in a
MicroStrategy environment. Additional space may be required
depending on the use of Intelligence Server in your MicroStrategy
environment.

Storage
MicroStrategy Product Processor Memory
Recommendation

3 GB on other
MicroStrategy System Linux: x86-64
2 GB or higher Linux operating
Manager compatible
systems

3 GB on other
MicroStrategy Command Linux: x86-64
2 GB or higher Linux operating
Manager compatible
systems

16 GB or higher

Using 16 GB of RAM is
a minimum level of
support for the
MicroStrategy Product
Suite, which does not
take into account the
performance of a Three times the
production system. amount of RAM
MicroStrategy Intelligence Linux: x86-64
Performance testing available to
Server compatible
has shown that 64 GB Intelligence
or more of RAM should Server.
be available to allow
MicroStrategy
Intelligence Server to
fully support and take
advantage of the
complete feature set of

Copyright © 2021 All Rights Reserved 105

In st allat io n an d Co n figu r at io n Gu id e

Storage
MicroStrategy Product Processor Memory
Recommendation

the MicroStrategy
Product Suite, while
obtaining system-wide
high performance. This
level of system
resources allows
MicroStrategy
Intelligence Server to
fully use performance-
improving technologies
such as MicroStrategy
OLAP Services, and to
support optimal
performance for
MicroStrategy Report
Services documents
and dossiers and the
other features of the
MicroStrategy Product
Suite.

3 GB on other
MicroStrategy Integrity Linux: x86-64
2 GB or higher Linux operating
Manager compatible
systems

3 GB on other
MicroStrategy Web Linux: x86-64
2 GB or higher Linux operating
Services for Office compatible
systems

The MicroStrategy Mobile Server hardware requirements are

MicroStrategy Mobile
the same as those for MicroStrategy Web Server hardware
Server
requirements.

The SDK is not included in the MicroStrategy installation and

MicroStrategy SDK can instead be downloaded from the MicroStrategy support
site.

Copyright © 2021 All Rights Reserved 106

In st allat io n an d Co n figu r at io n Gu id e

Storage
MicroStrategy Product Processor Memory
Recommendation

3 GB on other
MicroStrategy Web: Web Linux: x86-64
4 GB or higher Linux operating
Server compatible
systems

MicroStrategy
Web can be
accessed from a
third-party web
MicroStrategy Web: Web Linux: x86-64
2 GB or higher browser, which
Client compatible
means there are
no additional
storage
requirements.

Storage requirem ents for all MicroStrategy products on Linux

The storage recommendations listed above provide the storage

recommendations for the MicroStrategy products if they are installed
individually on separate machines.

A conservative estimate of the total file size if you install all MicroStrategy
products on the same machine, which can then share a set of common files,
is 12 GB.

An update installation requires a minimum of 13GB disk space.

Tem porary directory requirem ents for installation

In addition to the space requirements listed above, you also need free space
in the temporary directory. When installing on Linux, the installer requires
100 MB of free space in the temporary directory. The default location of the
temporary directory is /tmp.

If the space in the default temporary directory is inadequate, you can use
the tempdir command line option to change the location of the temporary

Copyright © 2021 All Rights Reserved 107

In st allat io n an d Co n figu r at io n Gu id e

directory. This directory must already exist and it must be specified using its
absolute path, for example:

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

If you change the location of the temporary directory, free space is still
required in the default location of the temporary directory to launch the
MicroStrategy installation routine.

MicroStrategy Mobile hardware requirements for mobile devices

The tables below list the MicroStrategy Mobile client application hardware
requirements for various mobile devices. See Platform Certifications for
supported mobile operating systems.

Flash m em ory

Requirement Minimum Recommended

Flash memory 32 MB 64 MB

Android devices

Refer to the third-party documentation for your Android device vendor to

determine the Graphics Processing Unit (GPU) for your device.

Software Requirements and Recommendations

See the MicroStrategy Readme for the specific software requirements and
recommendations for MicroStrategy products on the Windows, UNIX, and
Linux platforms.

Intelligence Server software requirements on Linux

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

Copyright © 2021 All Rights Reserved 108

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Integrity Manager for Linux platforms has the same

requirements as Intelligence Server. Therefore, you can use the information
in this section for Intelligence Server and Integrity Manager requirements on
Linux platforms.

The following MicroStrategy products require an X-windows-enabled

environment on all Linux platforms:

l GUI-based MicroStrategy Installation Wizard

l Diagnostics and Performance Logging tool
l Service Manager

The following requirements also apply to all Linux platforms:

l A Web browser is required for viewing the MicroStrategy Readmes and

online help.
l Windows Services for UNIX or Samba is required for HTML document
support. Samba 3.0 is required for the support of HTML documents with
alphanumeric names.

The requirements listed below describe general requirements as well as

requirements specific to the UNIX and Linux platforms.

Be aware of the following before reviewing the sections listed above:

l The operating systems listed are deemed supported or certified to reflect

the level of internal testing that each configuration was exposed to for the
current release. MicroStrategy recommends using certified configurations
over the supported configurations.
l MicroStrategy certifies and supports operating systems that are
compatible with a set of CPU chipsets, referred to as CPU architectures,
that are binary-compatible. MicroStrategy tests on at least one of the CPU
chipsets within a set of binary-compatible CPU architectures for purposes
of certifying and supporting operating systems with MicroStrategy
products. A valid CPU architecture is provided in parentheses () to clarify

Copyright © 2021 All Rights Reserved 109

In st allat io n an d Co n figu r at io n Gu id e

the operating system 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 LDAP
authentication with various Intelligence Server machine environments,
see the MicroStrategy Readme.

Configuring shared m em ory resources

To improve the performance, MicroStrategy Intelligence Server can be

configured to use shared memory resources. To support this configuration,
you must ensure that the Intelligence Server host machine uses values
greater than or equal to the resource limits described below.

During installation you have the following options:

l Exit the MicroStrategy setup wizard to do the required system

changes (Recommended): Select this option to cancel the installation
and make the required system resource limit changes to support shared
memory resources. This option is recommended for production
environments. Information on the recommended resource limits is below.
l Allow the setup to reconfigure MicroStrategy to use Pipe as the
Default IPC Mechanism: Select this option to disable the use of shared
memory resources for Intelligence Server, and instead use the pipe
mechanism. Disabling the ability to use shared memory resources can
decrease the performance of your MicroStrategy applications; therefore,
this is not recommended for production environments.
l Keep Shared Memory as the Default IPC Mechanism. (MicroStrategy
may not work properly): Select this option to keep your system resource
limits set at their current values to support shared memory resources.
While this allows you to continue installation with the current system
resource limits, Intelligence Server may not function properly after
installation. If you plan to use shared memory resources for enhanced

Copyright © 2021 All Rights Reserved 110

In st allat io n an d Co n figu r at io n Gu id e

performance of your production environments, you should select the first

option to exit the installation and make the required system changes.

The tables below provide recommended values for various system resource
limits on Linux.

Modifying the system resource limits listed below can affect system-wide
behavior and therefore, steps to modify these values are not given. You
should refer to your Linux documentation and contact your system
administrator to modify these settings.

Semaphores are used to synchronize shared memory communications. The

names of the settings that control semaphores differ between operating
systems as listed in the tables below:

Setting Name on Recommended

Description
Linux Value

Maximum number of semaphores in a semaphore

semmsl 250
set.

semmns Maximum number of semaphores in the system. 1024000

Maximum number of operations in a simple

semopm 250
semaphore call.

semmni Maximum number of semaphore sets. 4096

Linux

For Linux requirements, see the System Requirements in the MicroStrategy

Readme.

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 allows Intelligence Server to
utilize system memory resources. If a lower value is used, Intelligence
Server may not be able to use all available system resources. This can

Copyright © 2021 All Rights Reserved 111

In st allat io n an d Co n figu r at io n Gu id e

cause some Intelligence Server actions to fail due to lack of system

resources, which could be completed if the additional system resources
were made available by increasing the value for this kernel setting.

For information on this setting, including how to modify its value, refer to
your third-party Linux operating system documentation.

Enabling core dum p

A core dump file provides a means to debug and fix the root cause, under
the rare occurrence that Intelligence Server crashes. However, core
dumping may be disabled out-of-the-box by the Linux operating system.
Follow the steps below to enable core dumping.

1. Configure the core file size limit for the current user, by editing the
/etc/security/limits.conf file. Run sudo vi
/etc/security/limits.conf and add the following line before the
# End of file.

* hard core unlimited

You may have an existing entry, other than unlimited. MicroStrategy

recommends to change it to unlimited so your core file is not
truncated.

2. Apply the setting above, by logging out from your current session and
then logging back in. Verify that sudo ulimit -c returns an
unlimited value.

3. MicroStrategy Intelligence Server may run as a daemon process

(service). To set the file size limit for daemons, edit the
/etc/sysconfig/init file and add the following line, if not already
there.

DAEMON_COREFILE_LIMIT='unlimited'

Copyright © 2021 All Rights Reserved 112

In st allat io n an d Co n figu r at io n Gu id e

4. Enable core dumping. Run sudo vi /etc/sysctl.conf and add the

following lines. MicroStrategy recommends using the binary name (%e),
process ID (%p), hostname (%h), and timestamp (%t) for the core file
name, as shown below. To customize your filename, please refer to the
man page of core(5). Also, verify that the /<path_to_the_
location>/core folder exists on your machine. If not, create the
folder. This is where the core file is saved.

MicroStrategy recommends saving the core file to a different location

than where the MicroStrategy Web files are stored. This is for
performance purposes and improved response during failover.

kernel.core_pattern = /<path_to_the_location>/core/core.%e.%p.%h.%t
fs.suid_dumpable = 2

5. Save the file. Then, apply the settings by running sudo sysctl -p
/etc/sysctl.conf.

6. Install MicroStrategy Intelligence Server. If already installed, restart

Intelligence Server.

For detailed steps to verify and troubleshoot the core dumping process and
the alternative, see Core Dump File Problems.

Enabling prioritization of tim e-critical requests

In Linux operating systems, the Intelligence Server requires a nice value

limit of 20. You can confirm your machine's limit by executing a ulimit -e
command. To learn more about the nice limit and how it is used to improve
the Intelligence Server's performance, see this page. The limit allows time-
critical requests, such as interactive dossier manipulations, to be executed
with high operating system-level thread priority for a potential response time
improvement. This is important when the machine is under full load and
Smart Download is enabled. If your machine does not satisfy the required
limit, any of the following messages will be displayed.

Copyright © 2021 All Rights Reserved 113

In st allat io n an d Co n figu r at io n Gu id e

If the installer is run in silent mode, the following entries are added into the
install.log file.

3 Jun 2020, 11:35:27 AM:SEVERE: Failed to set MicroStrategy Intelligence

priority process settings
3 Jun 2020, 11:35:27 AM:SEVERE: Priority process settings for MicroStrategy
Intelligence doesn't meet the requirements
3 Jun 2020, 11:35:27 AM:SEVERE: Root privileges are required to configure
the nice limit to 0 or lower

To properly set up the nice limit, refer to the following steps:

1. Using the superuser privilege (e.g., with sudo command), create a new
configuration file. MicroStrategy recommends to use the name mstr-
priority.conf under the /etc/security/limits.d folder.

2. Add the following entries to the configuration file:

Copyright © 2021 All Rights Reserved 114

In st allat io n an d Co n figu r at io n Gu id e

mstr hard nice 0

mstr soft nice 0

If you are running the Intelligence Server with another user, replace
mstr with the user name of your choice.

3. Save the configuration file.

4. Restart your existing session to apply the new limits. You can simply
disconnect from and reconnect to the new session when using SSH.
When using VNC, you can restart the service, such as using a
systemctl restart vncserver@:1.service command, and then
reconnect to the session. In both cases, make sure mstr user is used
to reconnect.
5. Verify the setting by executing ulimit -e and confirm that the
returned value is 20, or higher. If you experience issues, see this page.
6. If the Intelligence Server is running, restart it.

7. Check the DSSErrors.log to verify it does not contain the following

entry regarding the nice limit:

... [Kernel][Error] ... The maximum scheduling priority ("nice")

returned by "ulimit - e" has a value of %1. It does not satisfy the
job prioritization feature's requirement that expects a value of 20 or
higher. Please refer to the man page of "ulimit".

MicroStrategy Web JSP software requirements and

recommendations
To confirm the latest requirement information, see the MicroStrategy
Readme. For specific patches, filesets, technology level, and other
requirements for UNIX and Linux operating systems, see Intelligence Server
software requirements on Linux, page 108.

Copyright © 2021 All Rights Reserved 115

In st allat io n an d Co n figu r at io n Gu id e

Web server software

For information on the exact version numbers, see the MicroStrategy

Readme.

MicroStrategy Web Services J2EE software requirements and

recommendations
To confirm the latest requirement information, see the MicroStrategy
Readme.

MicroStrategy SDK software requirements and recommendations

for JSP environments
The table below lists the JDK, JRE, and JVM requirements for the
MicroStrategy SDK customizations for JSP environments. For complete
MicroStrategy SDK software requirements, including .NET environment
requirements, see the MicroStrategy Readme.

MicroStrategy System Manager software requirements on

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

MicroStrategy Command Manager software requirements on

UNIX/Linux
For Command Manager operating system requirements on Windows
platforms, see the MicroStrategy Readme.

MicroStrategy Mobile software requirements for mobile devices

The tables below list the MicroStrategy Mobile client application software
requirements for iPhone, iPod Touch, and iPad devices. To verify updated
requirement information, see the MicroStrategy Readme.

Copyright © 2021 All Rights Reserved 116

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Mobile Server software requirements

The sections below list the MicroStrategy Mobile Server software
requirements.

Mobile Server deploym ent requirem ents

l Mobile Server ASP.NET can be deployed using the same requirements
listed for MicroStrategy Web (see the MicroStrategy Readme).
l Mobile Server JSP can be deployed using the same requirements listed for
MicroStrategy Web (see MicroStrategy Web JSP software requirements
and recommendations, page 115).

Web browsers for Mobile Server

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

Supporting IIS 10.0, version 1607-1909 as a web server for

MicroStrategy Web or Mobile Server
If you plan to use IIS 10.0, version 1607-1909 as the web server for
MicroStrategy Web or Mobile Server, you must ensure that some IIS options
are enabled. The procedure below describes how to enable the options that
are required to support IIS 10.0, version 1607-1909 as a web server for
MicroStrategy Web or Mobile Server.

To support IIS 10.0, version 1607-1909 as a web server for

MicroStrategy Web or Mobile Server

The third-party products discussed below are manufactured by vendors

independent of MicroStrategy, and the steps to configure these products is
subject to change. Refer to the appropriate Microsoft documentation for
steps to configure IIS 10.0, version 1607-1909.

Copyright © 2021 All Rights Reserved 117

In st allat io n an d Co n figu r at io n Gu id e

1. On a Windows machine, open the Control Panel.

2. Double-click Programs and Features.
3. Click Turn Windows features on or off.
4. On the Add Roles and Features wizard, check if the Web Server (IIS)
has all features installed, If not, you will need to add them.
5. Expand Internet Information Services.

6. Expand Management Tools and select:

l IIS Management Console

l IIS Management Scripts and Tools
l IIS Management Service

7. Expand Application Development and select:

l .NET Extensibility
l ASP
l ASP.NET
l ISAPI Extensions
l ISAPI Filters

8. Expand Common Http Features and select:

l Default Document
l Static Content

9. Expand Security, and select:

l Request Filtering
l Windows Authentication
10. Click OK.

Platform Analytics Prerequisites

Before installing Platform Analytics on a Windows or Linux machine, ensure
that all of the following prerequisites are met.

Copyright © 2021 All Rights Reserved 118

In st allat io n an d Co n figu r at io n Gu id e

l The following ports must be open and available in the machines where you
will install the Telemetry Server(s) and Platform Analytics:
l 2181
l 2888 and 3888 (only if you plan to cluster three or more Telemetry
Servers)
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 default Administrator user.
l For an estimation of resource requirements for stable and performant
operation of the Telemetry Store (previously called Platform Analytics
Consumer) architecture under a consistent transactional load, see
KB482872: Capacity Planning for Platform Analytics.

Required Ports
Depending on the MicroStrategy components to be installed, ensure that the
following ports are open for communication.

Dependent MicroStrategy Product Installed Component Required Port

Intelligence Server Intelligence Server 34952

Intelligence Server Modeling Service 9500

Topology - Server RPC 8300

Intelligence Server   Topology - Serf LAN 8301

Topology - Serf WAN 8302

REST Server REST Server 34962

Collaboration Server Collaboration Server 3000

MicroStrategy Library Apache Tomcat 8080

Copyright © 2021 All Rights Reserved 119

In st allat io n an d Co n figu r at io n Gu id e

Dependent MicroStrategy Product Installed Component Required Port

MicroStrategy Web

MicroStrategy Mobile

Platform Analytics Apache Kafka 9092

Platform Analytics Apache Zookeeper 2181

Platform Analytics Redis 6379

Collaboration Notifications
MicroStrategy Repository 5432
Platform Analytics

MicroStrategy Library

MicroStrategy Web MicroStrategy Export 20100

MicroStrategy Mobile

Installation Considerations
The following section contains guidelines and considerations for installation.

System Sizing Guidelines

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

This section describes only the most basic guidelines. For detailed
information refer to the System Administration Help.

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

Copyright © 2021 All Rights Reserved 120

In st allat io n an d Co n figu r at io n Gu id e

l Total users: Users that are registered in the system. For example, if a
corporate website is available to be viewed by 950 individuals, the site has
950 total users.
l Active users: Users that are logged into the system. If a site is available to
be viewed by 950 total users and 30 of them are logged in to the site, there
are 30 active users.
l Concurrent users: Users that have jobs being processed by a server
(MicroStrategy Web, Intelligence Server, and so on) at the same time. For
example, a site is available to 950 total users, and 30 people are logged
in. Of 30 active users, 10 have jobs being processed by the server
simultaneously; hence there are 10 concurrent users.

Of these measures, the number of concurrent users is important to consider.

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

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

Since analytically complex reports create a heavier load on the Intelligence

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

The database server processes the SQL that Intelligence Server generates,
so reports with extremely complex SQL can place additional stress on the

Copyright © 2021 All Rights Reserved 121

In st allat io n an d Co n figu r at io n Gu id e

database server. You should take this into account when sizing your
database server machine.

Ad hoc reports versus caches

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

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

Therefore, the more complex the ad hoc reporting is in your system, the
greater the overall load on the Intelligence Server. Be sure to take this into
account when sizing your Intelligence Server machine.

The process for element browsing is similar to ad hoc reporting. Element

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

Report Services document

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

Copyright © 2021 All Rights Reserved 122

In st allat io n an d Co n figu r at io n Gu id e

When creating a document, refer to the following guidelines to avoid an

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

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.
Consolidate the data to fit into fewer grids in the output document, where
possible.
l Use of complex elements, such as consolidations, custom groups, and
smart metrics can increase the Intelligence Server usage, especially if
arithmetic operators are used in element definitions.
l Use Custom formatting only when required.

OLAP Services
OLAP Services store reports as Intelligent Cubes in the physical memory of
the Intelligence Server. When these Intelligent Cubes are cached in
memory, report manipulations, such as adding derived metrics and derived
elements, formatting, and drilling within the Intelligent Cube, take
considerably less time. This is the case because the new SQL is not run
against the database.

OLAP Services provide enhanced report manipulation functionality at the

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

l Intelligence Server resources

l Expected response time
l User concurrency

You must monitor Intelligence Server CPU utilization and memory usage
closely as OLAP Services might have an impact on the performance of the
platform, particularly the memory and report response time. For information
on OLAP Services, see the In-memory Analytics Help. Additional

Copyright © 2021 All Rights Reserved 123

In st allat io n an d Co n figu r at io n Gu id e

performance tuning best practices for OLAP Services are provided in the
System Administration Help.

Additional considerations
Numerous factors can affect system performance, most of them related to
system specifics, which makes them difficult to predict. Listed below are
items you should consider when determining the requirements for your
system:

l Developer versus MicroStrategy Web usage—MicroStrategy products are

designed with the assumption that the majority of users access the system
through MicroStrategy Web while a smaller percentage use the Developer
products.
l Statistics logging—Statistics logging is very useful for analyzing and
further refining the system configuration based on actual usage. However,
logging all statistics all the time can create a noticeable increase in
system response time. For this reason, you might choose to log only a
subset of the statistics generated or only log statistics periodically.
l Backup frequency—Caches can be stored in memory and on disk. When
you enable backup, you allow the Intelligence Server to write all cache
files to disk. If the backup frequency is set to the default of zero, backup
files are written to disk as soon as they are created. However, writing all
cache files to disk all the time can cause a noticeable reduction in system
performance.

Set the backup frequency to a value that minimizes disk writes and
optimizes memory usage for your system.

l Ratio of MicroStrategy Web servers to Intelligence Servers—In a typical

system you should have a 1:1 ratio of Intelligence Servers to
MicroStrategy Web servers. This ensures that resources on both sides are
optimized. However, you might find it useful to add Intelligence Servers or
MicroStrategy Web servers depending on your particular requirements.

Copyright © 2021 All Rights Reserved 124

In st allat io n an d Co n figu r at io n Gu id e

l Report Styles—MicroStrategy Web provides a set of different XSL report

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

MicroStrategy Professional Services for high performance

MicroStrategy Professional Services has identified five primary levers
customers can use to get dramatically faster performance:

l Employ in-memory Business Intelligence

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, will conduct a

thorough examination of your Business Intelligence implementation,
providing you with actionable recommendations on these five key areas to
improve overall performance. The MicroStrategy Performance Analysis
service delivers:

l Performance optimization roadmap: A customized report with prioritized

recommendations to achieve performance goals.
l System configuration: Optimum configuration setting recommendations
to achieve efficient use of resources across different MicroStrategy
products.
l Performance monitoring plan: A set of performance related metrics to
proactively monitor and identify performance opportunities.

To learn how MicroStrategy Professional Services can help you assess and
prioritize your performance opportunities with a Performance Analysis, see
MicroStrategy Services.

Copyright © 2021 All Rights Reserved 125

In st allat io n an d Co n figu r at io n Gu id e

Common questions about sizing

The sections below provide brief explanations to common sizing questions.
For detailed information on tuning your MicroStrategy environment, see the
Tuning your System for Best Performance chapter in the System
Administration Help. The sections below also provide other additional
resources.

Why should I increase the processor speed of Intelligence Server?

Increasing the processor speed of Intelligence Server enhances

performance and reduces execution time for all analytical tasks and for
requests from the Extensible Markup Language (XML) and Component
Object Model (COM) application programming interfaces (APIs). If you see
that the machine or machines are running consistently at a high capacity, for
example, greater than 80%, it may be a sign that a faster processor would
improve the system's capacity.

For more detailed information on tuning your processors for your

MicroStrategy environment, see the section Managing system resources in
the System Administration Help.

Why should I add m ore processors to Intelligence Server?

Adding more processors to the Intelligence Server allows for a better load
distribution among the processors. This provides an overall performance
gain. If you notice that the processor is running consistently at a high
capacity, for example, greater than 80%, consider increasing the number of
processors.

For more detailed information on tuning your processors for your

MicroStrategy environment, see the section Managing system resources in
the System Administration Help.

Copyright © 2021 All Rights Reserved 126

In st allat io n an d Co n figu r at io n Gu id e

Why should I increase m em ory on the m achine that hosts Intelligence

Server?

If the physical disk is utilized too much on a machine hosting Intelligence

Server, it can indicate that there is a bottleneck in the system's
performance. To monitor this on a Windows machine, use the Windows
Performance Monitor for the object PhysicalDisk and the counter % Disk
Time. If you see that the counter is greater than 80% on average, it may
indicate that there is not enough memory on the machine.

For more detailed information on tuning your machine's memory for your
MicroStrategy environment, see the section Managing system resources in
the System Administration Help.

What would m ore network bandwidth do for m e?

You can tell whether your network is negatively impacting your system's
performance by monitoring how much of your network's capacity is being
used. To monitor this on a Windows machine, use the Windows Performance
Monitor for the object Network Interface, and the watch the counter Total
bytes/sec as a percent of your network's bandwidth. If it is consistently
greater than 60% (for example), it may indicate that the network is
negatively affecting the system's performance.

For very large result sets, increasing network bandwidth reduces

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

For more detailed information on tuning your network for your MicroStrategy
environment, see the section How the network can affect performance in the
System Administration Help.

How m any CPUs can a user fully utilize?

One user can fully utilize up to one CPU, regardless of the number of CPUs
available in the server. The load is split across multiple CPUs in multi-

Copyright © 2021 All Rights Reserved 127

In st allat io n an d Co n figu r at io n Gu id e

processor servers.

For more detailed information on how licensing can affect the utilization of
CPUs, see the System Administration Help.

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

The advantage of using hyper-threading with a dual processor is that it

decreases the overall CPU usage. The use of hyper-threading is
recommended if you have 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 it increases the

Intelligence Server execution time slightly. 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 Intelligence
Server?

Intelligent Cubes must be stored in Intelligence Server memory for reports to

access their data. While this can improve performance of these reports,
loading too much data onto Intelligence Server memory can have a negative
impact on Intelligence Server's ability to process jobs. For this reason, it is
important to govern how much Intelligent Cube data can be stored on the
Intelligence Server.

For information on governing Intelligent Cube memory usage, loading, and

storage, see the System Administration Help.

International Support
The following table lists the language selection possibilities for different
installation cases:

Copyright © 2021 All Rights Reserved 128

In st allat io n an d Co n figu r at io n Gu id e

Installation Result

Fresh installation on a system The MicroStrategy Installation Wizard prompts you to

in which MicroStrategy select the language from the drop-down list.
application has never been The user language in the product interface is the
installed before language that you select during installation.

All subsequent executions of the installation routine are

Repair or maintenance displayed in the language that you selected the first time
installation on a system on you installed the product on the system.
which MicroStrategy application The user language in the product interface is also the
has been installed before language that you selected the first time you installed the
product on the system.

If you uninstall all the products and install either the

same version or a higher version again, the
Completely uninstalling all the MicroStrategy Installation Wizard prompts you to select
MicroStrategy products and the language from the drop-down list.
installing the same version or a
newer version Note: Even if you select a language from the language
prompt in the installation routine, it has no effect on the
default language of the product interfaces.

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

MicroStrategy Web and Intelligence Server Compatibility

You must ensure the versions of MicroStrategy Web and Intelligence Server
are compatible. For example, MicroStrategy Web 2021 can only connect to
Intelligence Server 2021 or later. For a complete list of compatible
MicroStrategy Web and Intelligence Server versions, refer to the
MicroStrategy Readme.

Refer to the MicroStrategy Readme for the complete MicroStrategy platform

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

Copyright © 2021 All Rights Reserved 129

In st allat io n an d Co n figu r at io n Gu id e

Certified ODBC Drivers for MicroStrategy Intelligence Server

MicroStrategy certifies ODBC drivers for Windows and Linux for Intelligence
Server and different DBMS types. MicroStrategy-branded ODBC drivers are
installed with the MicroStrategy products.

For a complete list of certified and supported configurations with exact

version numbers, refer to the certified and supported configurations listed in
the Readme.

Recommended System Settings for Linux

Linux systems allow processes and applications to run in a virtual
environment. This means that each process, depending on its owner and the
settings for certain environment variables, are run using a distinct set of
properties that affect how much memory the process can use, how many
CPU seconds it can use, what thread model it can use, how many files it can
open, and so on.

MicroStrategy Intelligence Server installs on Linux systems with the required

environment variables set to ensure that the server's jobs are processed
correctly. However, as mentioned above, some settings are related to the
user who starts the process (also known as the owner of the process) and
other settings can only be set by the system administrator. Some of these
settings may also have limits enforced for reasons unrelated to supporting
MicroStrategy.

The table below lists MicroStrategy's recommendations for system settings

that can affect the behavior of Intelligence Server.

Modifying the system settings listed below can affect system-wide behavior
and therefore, steps to modify these values are not given. You should refer
to your Linux documentation and contact your system administrator to
modify these settings.

Copyright © 2021 All Rights Reserved 130

In st allat io n an d Co n figu r at io n Gu id e

Setting Name

ulimit name (limit Description Recommended Value

name)

Maximum
CPU
cputime ( time ) Unlimited
seconds per
process

Unlimited, or as large as the file system allows. Your

system administrator may enforce limits on the
Maximum
maximum size of files for reasons unrelated to
filesize ( file ) size for a
MicroStrategy. This value must be at least as large as
single file
the maximum size for core dump files
( coredumpsize ).

Unlimited, or as large as the system virtual memory

Maximum allows. Your system's virtual memory constraints
datasize ( data ) heap size affect the data size you can set for a process's heap
per process size. The value should be the same as the maximum
size for core dump files ( coredumpsize ).

Maximum
stacksize
stack size 8 MB
( stack )
per process

Maximum Set this value to the same value as the maximum

coredumpsize size for a heap size per process ( datasize ). If core dump files
( coredump ) single core are created that are larger than this value, the files
dump file are corrupted and unusable.

Maximum
size of
memoryuse physical Unlimited, or as large as the physical memory of your
( memory ) memory system allows
allotted per
process

vmemoryuse Maximum Unlimited, or as large as your system virtual memory

( vmemory ) size of allows

Copyright © 2021 All Rights Reserved 131

In st allat io n an d Co n figu r at io n Gu id e

Setting Name

ulimit name (limit Description Recommended Value

name)

virtual
memory
allowed per
process

Maximum
number of
8192
descriptors file
If you are using memory mapped files, set this value
( nofiles ) descriptors
to at least 65535.
(open files)
per process

8194

Maximum
This setting is a general guideline that has been
processes ( per number of
observed to work well on multiple installs.
user ) processes
However, depending on the specific
per user
environment, this setting may need to be
refined.

Methods of Installation
The methods of MicroStrategy installation are:

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

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

Enter. You then press 0 and Enter to continue.

Copyright © 2021 All Rights Reserved 132

In st allat io n an d Co n figu r at io n Gu id e

Defaults appear next to each prompt and are enclosed in square brackets,
for example, [1]. Click Enter to use the default, or type a different response
to the prompt to override the default.

In addition, on the command line wizard pages, the following options are
available:

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

l Press 2 and then click Enter to return to the previous page.
l Press 3 and then click Enter to cancel the installation and close the
MicroStrategy Installation Wizard.
l On the last page, which is MicroStrategy Installation Wizard Complete,
press 3 and then click Enter to complete the setup and close the wizard.

For information on command line installation, refer to Chapter 3, Installing

MicroStrategy on Linux.

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

For information on silent installation, refer to Silent Installation, page 563 in

Chapter 8, Automated Installation on Windows and Silent Installation, page
576 in Chapter 9, Automated Installation on Linux.

Creating Custom Installation Packages

You can reduce the amount of data that has to be downloaded for an
installation by providing only the files required to complete a MicroStrategy
installation. This technique can then be used to reduce the amount of data
packaged and downloaded for other MicroStrategy installations within your
organization.

Copyright © 2021 All Rights Reserved 133

In st allat io n an d Co n figu r at io n Gu id e

The steps below show you how to create these custom installation
packages.

Create a Custom MicroStrategy Installation Package

1. Retrieve the MicroStrategy installation files from the installation disk or

the MicroStrategy download site. Save these files to a folder. Contact
your MicroStrategy sales representative to determine the location and
login credentials for the MicroStrategy download site.
2. Within the location where you saved the MicroStrategy installation files,
browse to the DataFiles folder.
3. You can determine the required installation files in the following ways:

l For Windows installations, you can use the MicroStrategy Installation

Wizard to determine the required files, as described in Determine the
required installation files for Windows installation, page 138.

MicroStrategy Components That Require The

Installation File
Installation File

mstr1~28.mcf,
mstr90.mcf,
mstr126~127.mcf, Common Files
mstr131~133.mcf,
mstr135.mcf

mstr28~36.mcf,
MicroStrategy Developer
mstr66~72.mcf

mstr37~41.mcf MicroStrategy Intelligence Server

mstr42~49.mcf MicroStrategy Web ASP

mstr50.mcf MicroStrategy Web JSP

mstr51~56.mcf MicroStrategy Mobile Web ASP

Copyright © 2021 All Rights Reserved 134

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The

Installation File
Installation File

mstr57.mcf MicroStrategy WWE (Obsolete)

mstr58.mcf MicroStrategy GIS Connectors

mstr59.mcf MicroStrategy Portlets

mstr60~62.mcf MicroStrategy Web Services ASP

mstr63.mcf MicroStrategy Web Services JSP

mstr75~76.mcf MicroStrategy Object Manager

mstr77~80.mcf MicroStrategy Command Manager

mstr83~85.mcf MicroStrategy Enterprise Manager

mstr86~89.mcf,
MicroStrategy Integrity Manager
mstr91.mcf

mstr92.mcf MicroStrategy Application Manager

mstr93~101.mcf MicroStrategy Narrowcast Server

mstr102~110.mcf MicroStrategy Analytics Modules

mstr111.mcf MicroStrategy Health Center (Obsolete)

mstr112~114.mcf MicroStrategy MDX Cube Provider

mstr121.mcf MicroStrategy Identity Server

mstr122.mcf Tomcat

mstr123.mcf MicroStrategy Identity Manager

mstr125.mcf MicroStrategy Communicator

mstr128.mcf MicroStrategy Library Web & Mobile

mstr129.mcf MicroStrategy Collaboration

Copyright © 2021 All Rights Reserved 135

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The

Installation File
Installation File

mstr134.mcf MicroStrategy AppSchema Service

mstr136.mcf MicroStrategy Services Registration

mstr137.mcf MicroStrategy Platform Analytics

mstr138.mcf MicroStrategy Community Data Connectors

mstr139.mcf MicroStrategy Certificate Store

mstr140.mcf MicroStrategy Export

mstr142.mcf MicroStrategy Modeling Service

mstr145.mcf MicroStrategy Cloud Object Connector

l For Linux installations, the table below lists which installation files
are required for each MicroStrategy component. Once you determine
the required installation files, you can include them in your custom
installation as described in Specify the location of the installation
files, page 138 below.

MicroStrategy Components That Require The

Installation File
Installation File

mstr1.tzp All MicroStrategy components and products

MicroStrategy Intelligence Server Universal and all of its

mstr3.tzp
components

MicroStrategy Web Universal, including Web Analyst, Web

mstr4.tzp
Reporter, and Web Professional

mstr5.tzp MicroStrategy Web Services for Office

Copyright © 2021 All Rights Reserved 136

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The

Installation File
Installation File

mstr6.tzp MicroStrategy Command Manager

mstr7.tzp MicroStrategy Integrity Manager

mstr8.tzp MicroStrategy System Manager

mstr10.tzp MicroStrategy Mobile Server

MicroStrategy Portlets, which is a component of

mstr11.tzp
MicroStrategy Web

MicroStrategy GIS Connectors, which is a component of

mstr12.tzp
MicroStrategy Web Universal

mstr13.tzp ReleaseNotes

mstr14.tzp MicroStrategy Enterprise Manager

mstr20.tzp MicroStrategy Telemetry Server

mstr21.tzp MicroStrategy Library Web & Mobile

mstr22.tzp MicroStrategy Collaboration Server

Node.js which is installed with Intelligence Server and

mstr25.tzp
Collaboration Server

mstr26.tzp Application Schema Server (Early Adopter)

Redis which is installed with MicroStrategy Platform Analytics

mstr27.tzp
(Early Adopter)

mstr28.tzp MicroStrategy Platform Analytics (Early Adopter)

mstr29.tzp Service Registration and Common Files

mstr30.tzp Community Connectors

mstr31.tzp Certificate Manager

Copyright © 2021 All Rights Reserved 137

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The

Installation File
Installation File

mstr32.tzp MicroStrategy Export

mstr35.tzp MicroStrategy Modeling Service

mstr36.tzp MicroStrategy Repository

mstr37.tzp CloudConnector

Determ ine the required installation files for Windows installation

1. Move all of the compressed .mcf files within this folder to a different
folder location.
2. Use the MicroStrategy Installation Wizard to begin a MicroStrategy
installation. For steps to locate and use the MicroStrategy Installation
Wizard, see Chapter 2, Installing MicroStrategy on Windows.
3. Complete the steps up to and including the step to select the
MicroStrategy components to be installed.
4. After selecting the MicroStrategy components to be installed and
clicking Next, a message is displayed that lists the required installation
files. Store all of these files in a location that can be accessed by the
machine that will use the custom installation package.
5. Click Cancel.

Specify the location of the installation files

When performing the installation, you can specify the location of these files
as follows:

l For Windows installation, you can specify the location of these files using
a response.ini file, as described in Installation Files.

Copyright © 2021 All Rights Reserved 138

In st allat io n an d Co n figu r at io n Gu id e

l For Linux installation, you can specify the location of these files using an
options.txt file, as described in Providing installation files for smaller
installations.

Related Topics

Installation Files, page 534

Install on Demand Options, page 617

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

Types of Licenses
Refer to your MicroStrategy contract and any accompanying contract
documentation for descriptions of the different MicroStrategy license types.

If you receive access to MicroStrategy Identity functionality as part of

MicroStrategy analytics software products, either by purchasing licenses to
such software products or receiving such software products as part of a
maintenance upgrade, your use of this product is restricted to use solely for
the purpose of authentication in conjunction with MicroStrategy analytics
software products.

Installation and Configuration Checklists

This guide provides information on how to install and configure
MicroStrategy products on Windows and Linux. To help you navigate
through this guide, the following sections in this chapter list the chapters

Copyright © 2021 All Rights Reserved 139

In st allat io n an d Co n figu r at io n Gu id e

that you should refer to depending on the platform on which you are
installing MicroStrategy products. Each list also provides a brief overview of
each chapter. It is recommended that you read this section before
performing an installation. You can use the tables as checklists of
installation and configuration tasks to be completed.

The appendixes in this guide are not listed in the checklists. The checklists
only cover the main steps to install and configure MicroStrategy products.
The appendixes in this guide contain important configuration details that are
useful throughout the life cycle of your MicroStrategy installation.

Installing and Configuring MicroStrategy on Windows

If you are installing MicroStrategy on Windows, you should refer to the
following sections sequentially.

l Chapter 1, Planning Your Installation: Review this chapter for important

installation prerequisites and considerations.

l Chapter 2, Installing MicroStrategy on Windows: This chapter describes

the procedures for installing the MicroStrategy products necessary to run
your business intelligence application in a Windows environment.

Or

l Chapter 8, Automated Installation on Windows: As an alternative to the

regular installation, you can perform a fully automated and unattended
installation including customization routines available with the product.
This chapter describes different types of unattended and automated
installations and provides steps to perform these installations on
Windows.

Additionally, Chapter 10, Deploying OEM Applications explains the

common workflow for deploying the MicroStrategy platform as an Original
Equipment Manufacturer (OEM) application.

l Chapter 4, Activating Your Installation: After installing MicroStrategy

products, you have 30 days to activate your software installation. If you

Copyright © 2021 All Rights Reserved 140

In st allat io n an d Co n figu r at io n Gu id e

have not activated your software after 30 days, some MicroStrategy

features may become unavailable until you complete the software
activation.
l Chapter 5, Configuring and Connecting Intelligence Server: After installing
and activating MicroStrategy products, you must use the MicroStrategy
Configuration Wizard to configure the MicroStrategy metadata repository,
statistics tables, history list tables, Intelligence Server, and project
sources. This chapter describes the steps used to configure an installed
MicroStrategy suite of products using the MicroStrategy Configuration
Wizard.
l Chapter 6, Deploying MicroStrategy Web and Mobile Server: You can
deploy your project to your user community using MicroStrategy Web. This
chapter provides information on how to deploy and configure
MicroStrategy Web on Windows and Linux platforms with various Web and
application servers.
l Chapter 12, Adding or Removing MicroStrategy Components: This chapter
describes the steps to add and remove MicroStrategy components on
Windows, as well as other operating systems. For Windows platforms,
refer to the following sections:

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

l Re-installing MicroStrategy components on Windows, page 672.

l Uninstalling MicroStrategy Components on Windows, page 674.

Installing and Configuring MicroStrategy on Linux

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

l Chapter 1, Planning Your Installation: Review this chapter for important

installation prerequisites and considerations.

l Chapter 3, Installing MicroStrategy on Linux: This chapter describes the

procedures for installing the MicroStrategy products necessary to run your

Copyright © 2021 All Rights Reserved 141

In st allat io n an d Co n figu r at io n Gu id e

business intelligence application on a Linux environment.

Or

l Chapter 9, Automated Installation on Linux: As an alternative, you can

perform a fully automated and unattended installation without using the
graphical user interface. This chapter describes different types of
unattended and automated installations and steps to perform these
installations on Linux.

Additionally, Chapter 10, Deploying OEM Applications explains the

common workflow for deploying the MicroStrategy platform as an Original
Equipment Manufacturer (OEM) application.

l Chapter 4, Activating Your Installation: After installing MicroStrategy

products, you have 30 days to activate your software installation. If you
have not activated your software after these 30 days have passed, some
MicroStrategy features may become unavailable until you complete the
software activation.

l Chapter 5, Configuring and Connecting Intelligence Server: After installing

and activating MicroStrategy products, you must use the MicroStrategy
Configuration Wizard to configure the MicroStrategy metadata repository,
statistics tables, history list tables, Intelligence Server, and project
sources. This chapter addresses the processes necessary to configure an
installed MicroStrategy suite of products using the Configuration Wizard. If
no project sources are defined, then the Configuration Wizard opens.

Or

l Chapter 11, Configuring MicroStrategy Using Command Line Tools:

MicroStrategy tools are provided in command line mode on Linux so that
you can perform various configuration tasks through the operating system
console. This enables you to perform your required configurations even if
you do not have access to the MicroStrategy interface.

Copyright © 2021 All Rights Reserved 142

In st allat io n an d Co n figu r at io n Gu id e

l Chapter 6, Deploying MicroStrategy Web and Mobile Server: You can

deploy your project to your user community using MicroStrategy Web. This
chapter provides information on how to deploy and configure
MicroStrategy Web and Web Universal on Windows and Linux platforms
with various Web and application servers.
l Chapter 7, Setting Up Documents and HTML Documents: This chapter
explains the setup required for the Intelligence Server to create and
execute HTML documents and documents. It also describes the steps to
create this setup, which are only necessary on a Linux environment.
l Chapter 12, Adding or Removing MicroStrategy Components: This chapter
describes the steps to add and remove MicroStrategy components on all
supported operating systems. For Linux platforms, refer to the following
section:
l Uninstalling MicroStrategy components on Linux

Copyright © 2021 All Rights Reserved 143

In st allat io n an d Co n figu r at io n Gu id e

I N STALLIN G
M ICRO STRATEGY ON
W IN D OWS

Copyright © 2021 All Rights Reserved 144

In st allat io n an d Co n figu r at io n Gu id e

This section describes the procedures for installing the MicroStrategy

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

Before installing MicroStrategy products, see Chapter 1, Planning Your

Installation for important pre-installation information.

Some MicroStrategy products are available in two versions, as described

below.

l Windows only: The Windows only versions, labeled as MicroStrategy

Intelligence Server, MicroStrategy Web (ASP.NET), and so on, are
compatible only with a Windows platform. With these versions,
MicroStrategy Web can be deployed quickly and easily using
MicroStrategy's Internet Information Services (IIS) Web Server. The
drawback is that IIS is the only Web server that can be used to deploy the
Windows only version of MicroStrategy Web.

l Universal (platform independent): The universal versions, labeled as

MicroStrategy Intelligence Server, MicroStrategy Web (JSP), and so on,
are compatible with Windows as well as Linux platforms. Installing the
universal versions on Windows lets you deploy MicroStrategy Web with
different application and Web server combinations. For example, instead
of 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, you
may have installed most of these products already. However, additional
considerations are important when you are setting up a production
business intelligence system as opposed to running the evaluation
software. You should read this chapter carefully, even if you already have
a working system from your Evaluation Edition.

This section has the following information:

Installation Procedure in Windows 146

Configuring your MicroStrategy Installation 177

Copyright © 2021 All Rights Reserved 145

In st allat io n an d Co n figu r at io n Gu id e

R and R Package Installer for Windows 177

Additionally, Chapter 10, Deploying OEM Applications explains the common

workflow for deploying the MicroStrategy platform as an Original Equipment
Manufacturer (OEM) application.

Installation Procedure in Windows

The MicroStrategy Installation Wizard guides you through installing one or
more MicroStrategy products in a Windows environment. The following
sections can assist you in installing MicroStrategy products:

l Installing with the MicroStrategy Installation Wizard for Windows, page

147
l Installation Verification, page 169

There are installation alternatives and procedures to support your

MicroStrategy installation documented in this guide, including the following:

l Prerequisites, see Installation Prerequisites, page 96 in Chapter 1,

Planning Your Installation.
l Advanced installation functionality, such as installing in an SMS
environment or using installation response files, see Chapter 8,
Automated Installation on Windows.
l Installing and deploying MicroStrategy Web with other Web and
application servers, see Chapter 6, Deploying MicroStrategy Web and
Mobile Server.
l Deploying MicroStrategy Web Services ASP.NET and J2EE, see Enabling
Single Sign-On with SAML Authentication in System Administration Help.

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

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

Copyright © 2021 All Rights Reserved 146

In st allat io n an d Co n figu r at io n Gu id e

the installation process.

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

Installing with the MicroStrategy Installation Wizard for

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

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

To access the MicroStrategy Installation Wizard

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

MicroStrategy products.
2. Exit all Windows applications before beginning the installation process.

3. Download the files from the MicroStrategy download site. Locate and
run the Setup.exe file. Be aware of the following:

l Contact your MicroStrategy sales representative to determine the

location and login credentials for the MicroStrategy download site.
l You need to extract the downloaded files to locate the Setup.exe
file. When extracting the files, ensure that the extraction software
maintains the folder structure of the compressed files. Most
extraction software maintains the folder structure by default, but if
you use WinRAR, ensure that you select the Extract full paths option.
l To review an alternative, guided introduction to installing
MicroStrategy software, you can locate and run the
MICROSTRATEGY.exe file. For information on this installation
alternative, see Installing with a Guided MicroStrategy Introduction,
page 170.

Copyright © 2021 All Rights Reserved 147

In st allat io n an d Co n figu r at io n Gu id e

l You can reduce the amount of data that has to be downloaded for the
installation by excluding all of the .zip files, located in the
Installations/DataFiles folder, from the download. You can
use this technique to download only the files required to complete
your MicroStrategy installation, which can then also be used to
reduce the amount of data packaged and downloaded for other
MicroStrategy installations. For steps to create these custom
installation packages, see Creating Custom Installation Packages,
page 133. Details on using a response.ini file to provide the
location of the installation files are provided in Chapter 8, Automated
Installation on Windows and the parameters used to specify the
location of the required installation files are described in Installation
Files, page 534.
4. If this is the first time you have installed MicroStrategy, you are
prompted to choose the language for the wizard. Select the appropriate
language from the drop-down list and click OK.

The MicroStrategy Installation Wizard opens and guides you through the
rest of the installation process. The sections below describe the actions you
must take for each page in the wizard. After you enter all required
information on an installation page, click Next to proceed to the next page of
the installation routine.

If any services are running for previously installed MicroStrategy products,

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

Welcome
If you opened the MicroStrategy Installation Wizard through the Microsoft
Control Panel using the Add/Remove Programs option, the wizard opens the
Welcome page in maintenance mode. For more information on modifying,
repairing, or removing all or part of your MicroStrategy installation, see
Chapter 12, Adding or Removing MicroStrategy Components.

Copyright © 2021 All Rights Reserved 148

In st allat io n an d Co n figu r at io n Gu id e

License Agreement
Read the license agreement, and accept or decline the agreement by
clicking the appropriate button. If you decline, you cannot install
MicroStrategy products.

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

Customer Information
Enter the following customer information:

l User
l Company
l License Key

To request a license key, go to the license key generator in the

MicroStrategy Download Site, contact your MicroStrategy Representative or
contact MicroStrategy Technical Support.

Install Options
Select one of the following install options:

l To install the entire platform on a single node environment, click Express.

After installing the complete platform, you will have MicroStrategy
Analytics, Mobility, and Security installed on your Windows server, as well
as the required third-party software libraries.

For steps to use the Express installation, see Performing a MicroStrategy

Express installation.

l To install on an environment with multiple servers, or to select which

MicroStrategy products to install, click Custom, and continue with the
Installation Wizard.

Copyright © 2021 All Rights Reserved 149

In st allat io n an d Co n figu r at io n Gu id e

Choose Destination Location

Browse to the locations where the MicroStrategy products and MicroStrategy
common files are to be installed:

l MicroStrategy Destination Folder: Browse to and select the location

where MicroStrategy products are installed. This is where executable files
and other support files are installed for your licensed MicroStrategy
products.

While this setting determines the default root directory for the
MicroStrategy products you install, you can change the destination of an
individual product later as part of selecting which MicroStrategy products
to install.

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

l MicroStrategy Common Files Destination Folder: Browse to and select

the location where MicroStrategy common files are installed. These files
are required to support a MicroStrategy installation.

Select Components
Select the check box of a MicroStrategy product to include that product in
the installation. Alternatively, you can clear a check box to uninstall or
exclude a MicroStrategy product from the installation.

The installation pages you see after this step depend on the products you
choose to install. These instructions describe all possible pages.

If you are installing MicroStrategy Communicator, components of

MicroStrategy Intelligent Enterprise are also installed.

If you previously installed Community Connectors in 11.0 and are installing

a newer version of MicroStrategy, your whitelist.txt file will be overwritten.

Copyright © 2021 All Rights Reserved 150

In st allat io n an d Co n figu r at io n Gu id e

To use your 11.0 whitelist.txt file in a newer version of MicroStrategy,

backup the whitelist.txt file located in
<installPath>\Tomcat\CommunityConnectors\WEB-INF before
performing the upgrade install. After the installation, replace the new
whitelist.txt with the backed up whitelist.txt file from 11.0.

Many of the platform components have subcomponents. If you expand the

different MicroStrategy products, you can select the appropriate check
boxes to specify the subcomponents to install. For information on
MicroStrategy components and subcomponents, see MicroStrategy Products
and Components, page 10 in Chapter 1, Planning Your Installation.

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

Destination Folder

You can select MicroStrategy products and their subcomponents to define

their installation locations. When you select a MicroStrategy product or
subcomponent, the Destination Folder area near the bottom of the interface
displays the current installation folder for the product. Click Browse to
select a different installation folder.

If you select a MicroStrategy product or subcomponent and the Browse

button is not accessible, this means that the installation location cannot be
changed. For example, if you select MicroStrategy Mobile you cannot define
an installation location. However, if you expand this product, you can define
the installation location for its subcomponents

Missing Requirem ents

If there are system requirements that are not met to install the MicroStrategy
products you've selected, a 'Missing Requirements' list will appear. Review
the list of requirements to determine if you can proceed with the installation.

Copyright © 2021 All Rights Reserved 151

In st allat io n an d Co n figu r at io n Gu id e

If you are missing installation requirements, the uninstalled dependency will

be marked as 'Missing' and the Next button will be disabled. Without exiting
the installer, go back to change the components selected or install the
missing components. Click the Recheck button to determine if all the
installation requirements have been met and click Next to proceed.

MicroStrategy Setup and Choose Data Files Location

You see the MicroStrategy Setup dialog box and the Choose data files
location page only if some of the files, required to install the MicroStrategy
components you have selected for installation, are not available. If you are
using this technique to reduce the amount of data that has to be downloaded
for the installation, it is recommended that you do the following:

l Review the files listed in the MicroStrategy Setup dialog box, and make a
note of all the required files. These files need to be provided as part of the
installation for the MicroStrategy components you selected using the
Select Features page of the installation (see Select Components, page
150).

l Provide the location of the installation files using a response.ini file.

This lets you access the installation files stored on a folder or stored at a
URL and accessed using HTTP or HTTPS. Details on using a
response.ini file as part of an installation are provided in Chapter 8,
Automated Installation on Windows and the parameters used to specify the
location of the required installation files are described in Installation Files,
page 534.

If the files required for the installation are stored in a folder, you can
instead click Change on this Choose data files location page to navigate
to and select the folder that stores the installation files. If all the required
installation files are provided in the folder you select, you can click Next
to continue the MicroStrategy installation.

Copyright © 2021 All Rights Reserved 152

In st allat io n an d Co n figu r at io n Gu id e

Missing Requirements
If there are system requirements that are not met to install the MicroStrategy
products you selected, a Missing Requirements list appears. Review the list
of requirements to determine if you can proceed with the installation.

If you are missing installation requirements, the uninstalled dependency is

marked as Missing and the Next button is disabled. Without closing the
installer, go back to change the selected components or install the missing
components. Click the Recheck button to determine if all the installation
requirements have been met and click Next to proceed.

Topology Configuration
Topology allows administrators to monitor MicroStrategy Services and
manage them in MicroStrategy Workstation. The following functionality is
supported:

l Service Health Monitor

The administrator can monitor MicroStrategy services through Workstation

and visualize if they are running or stopped.

l Service Start/Stop

The administrator can start or stop MicroStrategy services through

Workstation. This functionality is currently limited to SSH authentication
with username and password.

See the topic, How to View Environment Topology and Monitor Services in
the Workstation Help for more information about using topology within
Workstation.

The two following types of lightweight agents are used to monitor services in
Workstation:

Copyright © 2021 All Rights Reserved 153

In st allat io n an d Co n figu r at io n Gu id e

l Monitoring Agents

The monitoring agents come with the installation of most MicroStrategy

services. Use them to monitor services and view their health status.

l Communication Agents:

Some monitoring agents also act as communication agents. In addition to

monitoring services, communication agents help other monitoring agents
locate each other and gather monitoring information. The administrator
must pick at least one agent to act as a communication agent, so all other
agents can locate each other through this agent.

On environments where three or more machines host MicroStrategy

Services, it is recommended that you choose at least three communication
agents to provide redundancy and improved reliability, in case one
communication agent becomes unavailable. The machines chosen to act
as communication agents must be machines that host MicroStrategy
Services, such as Intelligence Server or MicroStrategy Library. If you
decide to use only one communication agent, it is recommended that you
choose the machine that houses MicroStrategy Library (if deployed
through the MicroStrategy installation), since Library communicates
directly with Workstation.

If your Library deployment is done through a WAR file or if you do not use
a machine that houses MicroStrategy Library to host the communication
agent, then use a machine that houses Intelligence Server.

MicroStrategy uses Consul technology for Services Registration. A

monitoring agent corresponds to a Consul agent in client mode. A
communication agent corresponds to a Consul agent in server mode.

Copyright © 2021 All Rights Reserved 154

In st allat io n an d Co n figu r at io n Gu id e

Copyright © 2021 All Rights Reserved 155

In st allat io n an d Co n figu r at io n Gu id e

1. On the Topology Configuration dialog of the Installation wizard, select

whether your environment has Single or Multiple machines.

2. If your environment contains multiple machines, determine which

machines in your environment you want to act as communication
agents. Among all the machines in your environment that will host
MicroStrategy Services, select at least one of them (three are
recommended for multiple machine environments) to act as a
communication agent. Enter each machine in the text field, separated
by semicolons. You must input the exact same list on all machines,
using the Topology Configuration dialog of the Installation wizard,
including the monitoring and communication agent machines.

The MicroStrategy Services are as follows:

l MicroStrategy Intelligence Server

l MicroStrategy Web Universal
l MicroStrategy Library
l MicroStrategy Mobile
l MicroStrategy Messaging Services
l MicroStrategy Platform Analytics
l MicroStrategy Certificate Store

Copyright © 2021 All Rights Reserved 156

In st allat io n an d Co n figu r at io n Gu id e

An odd number of communication agents is required due to the

leadership selection algorithm.

Examples:

servername1.domain.com;servername2.domain.com;server
name3.domain.com;
servername1.domain.com;

Example: Your environment contains the following two machines and

you select one machine to host the communication agent:

l Machine 1 hosts MicroStrategy Library and the communication agent

l Machine 2 hosts the Intelligence Server

When performing the installation, enter the full domain name,

machine1.domain.com, on both machines.

Example: Your environment contains the following three machines and

you want all machines to host a communication agent:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1
l Machine 3 hosts Intelligence Server 2

When performing the installation, enter

machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all three machines.

Example: Your environment contains the following five machines and

you select three machines to host the communication agents:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1 and a communication agent
l Machine 3 hosts Intelligence Server 2 and a communication agent

Copyright © 2021 All Rights Reserved 157

In st allat io n an d Co n figu r at io n Gu id e

l Machine 4 hosts Intelligence Server 3 and a communication agent

l Machine 5 hosts Intelligence Server or other services

Enter
machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all machines.

Some important information to keep in mind:

l In MicroStrategy 2019, OpenSSH is no longer installed on Windows

machines. You must install Open SSH to start and stop services using
topology. Upgrading your system from 11.0 to 2019 removes Open SSH.

If consul is already installed on a machine, prior to installing MicroStrategy

products, the service registration auto configuration and execution is
affected. We do not recommend a separate consul installation on the same
machine.

l If you select Multiple machine environment, you must enter an odd

number of machines.
l If your environment includes more than one machine and machines with
dynamic IP addresses as communication agents, use FQDN for the
communication agent machine list during the installation.
l If your environment includes more than one machine and machines with
more than one IP address as communication agents, it is recommended
that you use FQDN for the communication agent machine list during the
installation. If IP address list is used, make sure the machine with multiple
IP addresses can be pinged with an IP address included in the list.

Topology supports installation on machines with public IP addresses. To

avoid unexpected joins to topology nodes, possibly exposing service
information, you must configure your firewall correctly. Your firewall
should allows ports for Server RPC (default 8300), and Serf LAN (default
8301), and Serf WAN (default 8302) only for the nodes within the
Workstation topology node cluster. See Enabling Topology
Communication Through a Firewall for more information.

Copyright © 2021 All Rights Reserved 158

In st allat io n an d Co n figu r at io n Gu id e

After installing the topology feature, see Installing and Configuring Topology
for additional instructions on configuring this feature to work in your
environment.

MicroStrategy Identity Configuration

You see this page if you have selected to install MicroStrategy Identity. If
you do not have all the information and want to configure this product later,
click Skip to proceed with the installation.

l SSL Certificate Authority Certificate: The file that contains the trusted
Root CA, Intermediate Root CA bundle (.pem). It must be the complete
certificate chain for your SSL Server Certificate that you obtained from
your IT Administrator.
l SSL Server Certificate: The server certificate (.crt) file for your Windows
server.
l SSL Server Certificate Key: The key for your SSL server certificate
(.key) file.
l SSL Certificate Authority Key File Password: If your CA-signed
certificate has a password, create a text file containing this password and
enter the text file location.

To ensure that the SSL certificates are valid for your installation, you can
run the following checks:
1 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

2 No error is produced when the command openssl.exe verify -

partial_chain -CAfile sample.pem sample.crt is executed.

Copyright © 2021 All Rights Reserved 159

In st allat io n an d Co n figu r at io n Gu id e

l SMTP Server: Your company's SMTP server, followed by the port number
in the next box.
l SMTP Authentication: If your server is password protected, then enter
the username and password for the server.
l Email Sender Address: The email address that is authorized to send
emails from your SMTP server, and will be used to send badge invitations
for your MicroStrategy Identity network.
l Host Name: Enter the Fully Qualified Domain Name you are using, for
example, yourFQDN.com.

Telemetry Server Cluster Configuration

If Intelligence Server or Platform Analytics are chosen for installation, the
option to configure a Messaging Services cluster is presented.

If no cluster needs to be configured, click Next.

To configure a cluster:

1. Select the I need to create a Messaging Services cluster for

Platform Analytics check box.
2. Local Node: Provide the address for the local node.
3. Remote Nodes: Provide a comma separated list of hostnames for
remote nodes in the cluster. The node id is determined by alphabetical
order in node list.

For detailed configuration information see, MicroStrategy Telemetry Server

Server Activation
If you have installed one or more MicroStrategy server products, you can
request an Activation Code to activate your MicroStrategy server products
upon completion of the installation process. The next few pages of the
installation process guide you in providing the information you must submit

Copyright © 2021 All Rights Reserved 160

In st allat io n an d Co n figu r at io n Gu id e

to MicroStrategy to request an Activation Code. MicroStrategy server

products include:

l MicroStrategy Intelligence Server

l MicroStrategy Web
l MicroStrategy Mobile Server

This page includes a welcome statement for the software activation process.
Read the welcome statement and click Next to proceed.

Server Information
Specify information about your MicroStrategy server installation. Enter the
following characteristics:

l Name: Distinguishes the name of this MicroStrategy server product

installation from any other MicroStrategy server product installations in
your company.
l Location: Physical location of the machine on which MicroStrategy server
products are installed.
l Use: Description of how the server is used.

Click Privacy Statement to view the MicroStrategy Privacy Statement.

Installer Information
Specify contact information of the person installing the software. After your
installation is complete an email containing the Activation Code is sent to
the email address you confirm in this software activation step. Enter the
following installer information:

l Specify whether you are an employee of the licensed company or installing

on behalf of the licensed company.
l Enter the necessary data into all text fields. Make sure the email address
you enter is correct. This email address is the recipient of the Activation
Code.

Copyright © 2021 All Rights Reserved 161

In st allat io n an d Co n figu r at io n Gu id e

l Select the check box at the bottom of the page to receive notifications
about product updates, events, and special offers from MicroStrategy.
l Click Privacy Statement to view the MicroStrategy Privacy Statement.

Contact Information
You see this page if you indicated that you are not an employee of the
company licensed to use this software, and are installing the software on
behalf of that company.

Specify contact information for the employee license to use the software.
Enter the necessary data into all text fields. Make sure the email address
you enter is correct. After your installation is complete an email containing
the Activation Code is sent to the email address you confirm in this software
activation step.

l Select the check box at the bottom of the page to receive notifications
about product updates, events, and special offers from MicroStrategy.
l Click Privacy Statement to view the MicroStrategy Privacy Statement.

Request Activation Code

This page includes options to request an Activation Code now or at a later
time. This page provides the following options:

l Select Yes, I want to request an Activation Code and click Next to

request an Activation Code. The Activation Code is sent to the email
addresses supplied in the Installer Information and Contact Information
pages.
l Select No, I will request the Activation Code at a later time and click
Next to request an Activation Code at a later time.

If you choose to request an Activation Code at a later time, a message is

displayed that instructs you how to request an Activation Code after the
installation procedure is completed. For more instructions on requesting

Copyright © 2021 All Rights Reserved 162

In st allat io n an d Co n figu r at io n Gu id e

an Activation Code at a later time, see Requesting an Activation Code,

page 357 in Chapter 4, Activating Your Installation.

You have a grace period of 30 calendar days to activate your installation. If

you do not complete the activation before the grace period expires, your
MicroStrategy product stops functioning until you activate it. If you wait to
activate your installation, you receive periodic reminders.

Once you request an Activation Code, an email is sent to the email

addresses you specify in the Installer Information and Contact Information
pages of the software activation procedure. The email provides instructions
on how to use the requested Activation Code to activate your software. To
activate your installation, you can also use the steps given in Activating
Your Installation Using License Manager, page 359 in Chapter 4, Activating
Your Installation.

CPU License Information

MicroStrategy Web (ASP.NET) Setting

You see this page only if you choose to install MicroStrategy Web
(ASP.NET) and only if you do not have a previous version of MicroStrategy
Web installed.

Specify the Internet Information Services (IIS) virtual directory to be created

for MicroStrategy Web pages. The default is MicroStrategy. In IIS, a
virtual directory is the home location for a set of Web pages that the Web
server 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 previous version is using. Therefore, you are not prompted to
specify the name of the virtual directory.

Copyright © 2021 All Rights Reserved 163

In st allat io n an d Co n figu r at io n Gu id e

• The name provided for a virtual directory must be unique. You cannot
use the same name as the default for other MicroStrategy products.

• MicroStrategy automatically configures the MicroStrategy Web

virtual directory to run with the version of .NET Framework that it
requires.

MicroStrategy Web (ASP.NET) CPU Affinity Setting

You see this page only if you choose to install MicroStrategy Web
(ASP.NET) and if the MicroStrategy Web installation detects that the license
key entered is a CPU-based license. This page is not displayed on single-
processor machines.

Specify the number of CPUs that MicroStrategy Web is licensed to use on

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

To allow the setting to take effect, the installation stops IIS. After IIS has
been restarted, the MicroStrategy Web application uses the specified
number of CPUs.

For more information on the MicroStrategy Web CPU affinity feature, refer to
the System Administration Help.

MicroStrategy Mobile Server (ASP.NET) Setting

You see this page only if you choose to install MicroStrategy Mobile Server
(ASP.NET) and only if you do not have a previous version of MicroStrategy
Mobile Server installed.

Specify the Internet Information Services (IIS) virtual directory to be created

for MicroStrategy Mobile Server. The default is MicroStrategyMobile.
The virtual directory is part of the URL used to access the interactive

Copyright © 2021 All Rights Reserved 164

In st allat io n an d Co n figu r at io n Gu id e

reporting and analysis applications deployed on this machine via Mobile

Server.

Mobile Server can be deployed using the same techniques used to deploy
MicroStrategy Web, as described in Deploying MicroStrategy Web and
Mobile Server, page 468. For additional configurations required to deploy
Mobile Server, see the MicroStrategy Mobile Administration Help.

• If you have a previous version of MicroStrategy Mobile Server

installed on the machine, the new version you install uses the same
virtual directory the previous version is using. Therefore, you are not
prompted to specify the name of the virtual directory.

• The name provided for a virtual directory must be unique. You cannot
use the same name as the default for other MicroStrategy products.

• MicroStrategy automatically configures the MicroStrategy Mobile

Server virtual directory to run with the version of .NET Framework
that it requires.

MicroStrategy Subscription Portal Setting

You see this page only if you choose to install MicroStrategy Subscription
Portal, which is a component of Narrowcast Server, and only if you do not
have a previous version of Subscription Portal installed.

Specify the name of the IIS virtual directory to be created for MicroStrategy
Subscription Portal pages. The default is NarrowcastServer. In IIS, a
virtual directory is the home location for a set of Web pages that the Web
server hosts.

Subscription Portal offers you the ability to subscribe to and view

Narrowcast Server services, service descriptions, and their most recent
modification dates on the Web. For complete information about Subscription
Portal and other components of Narrowcast Server, refer to the
MicroStrategy Narrowcast Server documentation.

Copyright © 2021 All Rights Reserved 165

In st allat io n an d Co n figu r at io n Gu id e

The name provided for a virtual directory must be unique. You cannot use
the same name as the default for other MicroStrategy products.

MicroStrategy MDX Cube Provider Setting

You see this page only if you choose to install the MicroStrategy MDX Cube
Provider and if you do not have a previous version installed.

Specify the virtual directory to be created for the MicroStrategy MDX Cube
Provider. The default is MicroStrategyMDX. This virtual directory is used
as part of the URL to connect to TM1 data sources or Microsoft Analysis
Services data sources for integration with MicroStrategy. For information on
connecting to these MDX cube data sources, see the MDX Cube Reporting
Help.

MicroStrategy Intelligence Server Setting

You see this page if you choose to install MicroStrategy Intelligence Server,
and if you do not have a previous version of Intelligence Server installed.

Select the check box to use the local system account as the Intelligence
Server service account. If you clear the check box to set a different
Intelligence Server service account, enter the following information:

l Login: A Windows login of the form Domain\User with full administrative

privileges under which to run the Intelligence Server service.

The user account used to run Intelligence Server must have full
administrator privileges for the local machine. If the administrator default
privileges have been modified for the user account, connection errors can
occur. For example, if the user account is denied access to the DSN
accessed by Intelligence Server, Intelligence Server connection fails.

l Password: A valid password for the Windows login entered in the Login
box

Copyright © 2021 All Rights Reserved 166

In st allat io n an d Co n figu r at io n Gu id e

l Confirmation: Retype the password to confirm it is correct

If the password you supply changes, you must reconfigure the Windows
service to use the new password. Otherwise, Intelligence Server
connections fail when the connection attempts to authenticate the login
and password.

MicroStrategy Narrowcast Server Setting

You see this page if you choose to install MicroStrategy Narrowcast Server,
and if you do not have a previous version of Narrowcast Server installed.

Select the check box to bypass the creation of a Narrowcast Server service
account.

It is recommended you create the Narrowcast Server service account. Clear

the check box, and enter the following information:

l Login: A Windows login of the form Domain\User with administrative

privileges under which to run the Narrowcast Server service
l Password: A valid password for the Windows login entered in the Login
box
l Confirmation: Retype the password to confirm that it is correct

If you change the password for this account, you must reconfigure the
Narrowcast Server Windows services to use the new password.

Review Installation Settings

This screen provides a summary of the MicroStrategy products and services
you have selected to install along with the destination folder where they will
be saved. If you wish to automatically restart your computer when the
installation is complete, select the check box below the list of products and
services as shown below. Restarting your computer after installation will
ensure that the system configuration is completed properly.

Copyright © 2021 All Rights Reserved 167

In st allat io n an d Co n figu r at io n Gu id e

If you do not choose to restart automatically, you can restart manually when
the Installation Wizard is complete.

MicroStrategy Installation Wizard Complete

Select Yes I want to restart my computer now as pictured below.
Restarting now will ensure the installation process is completed
successfully.

Click Finish.

If you encounter errors while installing MicroStrategy, refer to Appendix B,

Troubleshooting.

Default Passwords for Configuration

During the configuration process, the MicroStrategy Installer randomly
generates a password for the MicroStrategy Web Administration page,
MicroStrategy Mobile Administration page, MicroStrategy Repository,
MicroStrategy Repository accounts, and Tomcat

Copyright © 2021 All Rights Reserved 168

In st allat io n an d Co n figu r at io n Gu id e

l Username: mstr
l Password: The password can be found in the following file on the server
where MicroStrategy Secure Enterprise was installed:

C:\Program Files (x86)\Common

Files\MicroStrategy\Default_Accounts.txt

Note the username and password, and store them securely. These
credentials will be used to configure the DSN to the Platform Anlaytics
project.

It is recommended to delete the Default_Accounts.txt file after the

password is stored securely. This password cannot be recovered if it is lost.

Installation Verification
During the installation routine, the MicroStrategy Installation Wizard gathers
and records information about your system and your installation selections.
You can verify installation setup information through the installation log file
(install.log), located by default in:

l 32-bit Windows environments: C:\Program Files\Common

Files\MicroStrategy.
l 64-bit Windows environments: C:\Program Files (x86)\Common
Files\MicroStrategy.

The installation log file includes the following information:

l Installation date
l Target directories
l Program folder name
l Operating system identification
l Hardware specifications
l Selected installation options
l Registry paths
l List of registered files

Copyright © 2021 All Rights Reserved 169

In st allat io n an d Co n figu r at io n Gu id e

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

The MSTRDebugInstall.log file will be created in the same location as

the Install.log file in the MicroStrategy Log Directory.

Installing with a Guided MicroStrategy Introduction

The installation procedure provided in this chapter assumes that you use the
Setup.exe file to install MicroStrategy software. As an alternative, a guided
introduction to MicroStrategy software and the installation process is also
provided. This introduction is provided as an Adobe Flash visualization.

To use this Flash visualization, you must locate and run the file
MICROSTRATEGY.exe, which is available in the MicroStrategy install media
or the files downloaded from the MicroStrategy download site. You can then
use the Flash visualization to review documentation on MicroStrategy
software, as well as begin the installation process.

If you provide the MicroStrategy installation files on a network location, you

must map a network drive for users to access the MICROSTRATEGY.exe
file. If users run this file without locating it through the use of a mapped
network drive, the links to open various product manuals will not function
properly.

To continue with the installation procedure, see Welcome, page 148.

Performing a MicroStrategy Express installation

The Express option installs your MicroStrategy Secure Enterprise Platform
with all the features of Analytics and Mobility. This guide describes the
Express Install option, which installs the entire platform on a single
machine.

The MicroStrategy Express option installation is specifically designed for

deployments of up to 15-20 concurrent users with the recommended
hardware specifications. This makes it an ideal solution for a development

Copyright © 2021 All Rights Reserved 170

In st allat io n an d Co n figu r at io n Gu id e

environment, or for evaluating the MicroStrategy Secure Enterprise Platform

capabilities.

You need to provide some information for the Analytics and MicroStrategy
Identity configuration.

After installing the complete Platform, you will have MicroStrategy Analytics
and Mobility installed on your Windows server, as well as the required Third-
party software libraries. For a complete list of all MicroStrategy components,
see What you are installing.

Prerequisites
l System requirements:

l You have a 64-bit Windows Server: 2016 or 2019.

l Windows 10 (64-bit) are supported for demo purposes.

l .Net Framework 4.x.
l All components are installed on the local C:\ drive, which requires 35
GB of disk space.
l To successfully complete the installation process, your server must
not have any MicroStrategy components installed.
l 16 GB of RAM
l Multi-core 64bit processor

l MicroStrategy Secure Enterprise software requirements:

l Download and extract the MicroStrategy installation package from the

MicroStrategy download site. In the extracted files, locate
MicroStrategy.exe or Setup.exe.
l Your MicroStrategy software license key is for 64-bit servers. To request
a license key, go to Generate Keys section of the MicroStrategy
download site, contact your MicroStrategy representative, or contact
MicroStrategy Technical Support at [email protected].

Copyright © 2021 All Rights Reserved 171

In st allat io n an d Co n figu r at io n Gu id e

l After installation, a MicroStrategy Landing page containing links to the

main MicroStrategy Platform services is displayed. The page requires
JavaScript to be enabled to execute inside a web browser. Contact your
IT administrator for assistance.
l If Microsoft Internet Information Server (IIS) is present on the machine,
the Express installation includes Subscription Portal and the MDX Cube
Provider. If IIS is not present, these two components are not installed.

l Connectivity requirements:

l Your Windows computer must be accessible through a Fully Qualified

Domain Name.

l The MicroStrategy services listed in Ports and connectivity information

must be able to communicate.

l The following Windows firewall inbound rules must added:

Name Program

C:\Program Files (x86)\Common

Apache Tomcat 9.0.x Files\MicroStrategy\Tomcat\apache-
tomcat-8.0.39\bin\tomcat8.exe

C:\Program Files
MicroStrategy Intelligence Server
(x86)\MicroStrategy\Intelligence
x64
Server\MSTRSvr2_64.exe

C:\Program Files
MicroStrategy Open Refine
(x86)\MicroStrategy\Intelligence
Server x64
Server\MJRefSvr_64.exe

Copyright © 2021 All Rights Reserved 172

In st allat io n an d Co n figu r at io n Gu id e

To start the Express installation

1. Log in to the Windows server as a user with administrator privileges.

2. In the installation folder, locate and run MicroStrategy.exe.
Alternatively, you can locate and run Setup.exe. Accept the license
agreement and continue.

3. On the Customer Information page, complete the following fields:

l First Name: The first name of the administrator.

l Last Name: The last name of the administrator.
l Email address: The email address of the administrator.
l License Key: The license key for your installation. This key is
required to install the MicroStrategy Platform on a 64-bit Windows
server. If you do not have this license key, contact to your
MicroStrategy Representative or [email protected].
4. Click Next.
5. On the Install Options page, select Express, and click Next.
6. Click Next.
7. Check the box marked Automatically restart my computer when the
installation completes if you wish to enable an automatic system
reboot.
8. Click Install. Installation takes approximately 20 minutes with the
recommended hardware.
9. If you did not choose to restart automatically, restart your machine now
by clicking Finish. The MicroStrategy software is not configured until
after a restart.

10. After your machine has restarted, log in with your administrative
account. Platform configuration automatically begins. This can take up
to 30 minutes with the recommended hardware. A progress bar displays
while the post-configuration steps are processed.

Copyright © 2021 All Rights Reserved 173

In st allat io n an d Co n figu r at io n Gu id e

11. When the installation is complete, your default browser automatically

opens the MicroStrategy Secure Enterprise launch page. If the launch
page does not display, use the shortcut on the desktop.

After the MicroStrategy installation is complete, you have 30 days to

activate your installation. Before you activate your installation you must
request an Activation Code from MicroStrategy. You can complete this
request when you install MicroStrategy with the MicroStrategy Installation
Wizard or after the installation using MicroStrategy License Manager. For
steps, see Activating Your Installation.

To log in to MicroStrategy Tutorial

1. You can log into Tutorial by using the MicroStrategy Administrator

credentials, as described below:

l Type Administrator for the username and keep the password empty.
l Click to log in.

2. After logging in, you can explore the capabilities of MicroStrategy by

following the guided tutorials or exploring on your own and creating
your own dossiers.

To log in to the MicroStrategy Web Adm inistration and MicroStrategy

Mobile Adm inistration pages

During the configuration process, the MicroStrategy Installer randomly

generates a password for the MicroStrategy Web Administration page,
MicroStrategy Mobile Administration page, MicroStrategy Repository,
MicroStrategy Repository accounts, and Tomcat

l Username: mstr
l Password: The password can be found in the following file on the server
where MicroStrategy Secure Enterprise was installed:

Copyright © 2021 All Rights Reserved 174

In st allat io n an d Co n figu r at io n Gu id e

C:\Program Files (x86)\Common

Files\MicroStrategy\Default_Accounts.txt

Note the username and password, and store them securely. These
credentials will be used to configure the DSN to the Platform Anlaytics
project.

It is recommended to delete the Default_Accounts.txt file after the

password is stored securely. This password cannot be recovered if it is lost.

Supporting Information

What you are installing

MicroStrategy Analytics and Mobility

l MicroStrategy Intelligence Server

l MicroStrategy Web Server
l MicroStrategy Mobile Server
l MicroStrategy Collaboration Server
l MicroStrategy Narrowcast Server
l MicroStrategy Developer
l MicroStrategy Library
l MicroStrategy Telemetry Server
l MicroStrategy Platform Analytics
l MicroStrategy Repository
l MicroStrategy Community Connectors
l MicroStrategy Administration Tools
l MicroStrategy Tutorial
l MicroStrategy Cloud Community Connectors

Copyright © 2021 All Rights Reserved 175

In st allat io n an d Co n figu r at io n Gu id e

Third-party software libraries

The MicroStrategy installation installs third-party software libraries to

provide a streamlined user experience. For a list of the libraries and
versions, see the "System Requirements" in the Readme.

Ports and connectivity inform ation

The MicroStrategy Express installation configures the following services on

the specified ports. It also sets inbound Windows firewall rules to permit
traffic on the specific ports. During an uninstall, the ports are closed on the
Windows firewall.

l Tomcat: 8080
l MicroStrategy Repository: 5432
l Identity Manager: 443
l MicroStrategy Identity Server 1-way: 1443
l MicroStrategy Identity Server 2-way: 2443
l Identity Gateway: 9501
l Intelligence Server: 34952
l REST Server: 34962
l Collaboration Server: 3000
l Export Engine Micro-Service: 20100
l Apache ZooKeeper: 2181
l Apache Kafka: 9092
l Redis: 6379

Windows Install Wizard - Missing Requirements

If there are system requirements that are not met to install the MicroStrategy
products you selected, a Missing Requirements list appears. Review the list
of requirements to determine if you can proceed with the installation.

Copyright © 2021 All Rights Reserved 176

In st allat io n an d Co n figu r at io n Gu id e

If you are missing installation requirements, the uninstalled dependency is

marked as Missing and the Next button is disabled. Without exiting the
installer, go back to change the selected components or install the missing
components. Click the Recheck button to determine if all the installation
requirements have been met and click Next to proceed.

Configuring your MicroStrategy Installation

After completing the MicroStrategy Installation Wizard steps to install
MicroStrategy products, you can set up and configure your installation. To
help guide the rest of your installation and configuration steps, refer to the
section Installing and Configuring MicroStrategy on Windows, page 140 in
Chapter 1, Planning Your Installation, for an installation and configuration
checklist.

• The next section in the installation and configuration checklist and in

this guide covers software activation steps with MicroStrategy.
These steps should be done before or soon after the Configuration
Wizard tasks mentioned below. For more information, refer to
Chapter 4, Activating Your Installation.

• After restarting your machine to complete an initial MicroStrategy

installation, the MicroStrategy Configuration Wizard opens. The
Configuration Wizard allows you to configure your MicroStrategy
production environment. For more information, refer to Chapter 5,
Configuring and Connecting Intelligence Server.

R and R Package Installer for Windows

The MicroStrategy R and R Package installer is a standalone component to
simplify the installation and configuration of R and the packages needed to
use R in conjunction with MicroStrategy 2020 and later. You can download
the R and R Package installer from the MicroStrategy download site.

Copyright © 2021 All Rights Reserved 177

In st allat io n an d Co n figu r at io n Gu id e

l Install R and R Package in GUI Mode

l Install R and R Package in Silent Mode
l Uninstall R and R Package
l R Packages Included in the Installation

Install R and R Package in GUI Mode

1. After completing installation of the MicroStrategy platform, download
the standalone R and R Package installer from the MicroStrategy
download site.
2. Unzip the installer download and double-click
RandRPackageInstaller.exe to begin.

3. The R and R Package installer launches in GUI mode. Click Next.

4. Accept the license agreement and click Next.

Copyright © 2021 All Rights Reserved 178

In st allat io n an d Co n figu r at io n Gu id e

5. Select the download location and click Install.

6. Click Finish.

Copyright © 2021 All Rights Reserved 179

In st allat io n an d Co n figu r at io n Gu id e

7. If necessary, troubleshoot any issues using the log at

<installPath>\Common Files\MicroStrategy\R\R-
3.6.3\RandRPackageInstall.log.

Install R and R Package in Silent Mode

1. After completing installation of the MicroStrategy platform, download
the standalone R and R Package installer from the MicroStrategy
download site.
2. Unzip the installer download.

3. Configure the response.ini file in your MicroStrategy platform

installation to launch the installer in silent mode.

[Installer]
HideAllDialogs=TRUE

[InitialPaths]
DownloadLocation=<downloadPath>

[OpenSourceSoftwareDialog]
AgreeToDownloadOpenSourceSoftware=TRUE

[Welcome]
RemoveAll=FALSE

4. Launch a Windows command prompt in administrator mode and use the

following command:

RandRPackageInstaller.exe --
ResponseFile=”<pathToResponseFile>\response.ini” -s -
f1C:\setup.iss -f2C:\setup.log

5. If necessary, troubleshoot any issues using the MicroStrategy

installation log at <installPath>\Common
Files\MicroStrategy\R\R-3.6.3\RandRPackageInstall.log
or the R and R Package installation log at <installPath>\Common
Files\MicroStrategy\R\R-3.6.3\install_rpkg.log.

Copyright © 2021 All Rights Reserved 180

In st allat io n an d Co n figu r at io n Gu id e

Uninstall R and R Package

1. Launch the R and R Package installer.
2. Select Remove and click Next.

3. Click Finish.

R Packages Included in the Installation

Expand to see the R packages included in the installation.
abind filehash latticeExtra praise SnowballC
acepack foreach lattice proto sourcetools
ada forecast lazyeval proxy sparklyr
amap foreign lmtest psych SparseM
arules Formula longmemo purrr spatial
assertthat fracdiff lubridate quadprog sp
backports fts magrittr quanteda stringi
base64en
gapminder manipulate quantreg stringr
c
BH gbm mapproj R6 strucchang

Copyright © 2021 All Rights Reserved 181

In st allat io n an d Co n figu r at io n Gu id e

e
randomForestSR
bit64 gdtools maps survival
C
bitops geosphere maptools randomForest svglite
bit ggmap markdown rappdirs testthat
ggplot2movie
boot MASS rbenchmark TH.data
s
broom ggplot2 MatrixModels RColorBrewer tibble
caTools glmnet Matrix RcppArmadillo tidyr
ca gridExtra memoise RcppParallel timeDate
checkmat
gtable mgcv Rcpp timeSeries
e
chron gutenbergr microbenchmark RCurl tis
class hexbin mime readr tm
cluster highlight miniCRAN reshape2 tokenizers
topicmodel
coda highr miniUI rex
s
codetools Hmisc mlbench RgoogleMaps triebeard
colorspac
hms mnormt rjson tseries
e
config htmlTable modeltools rmarkdown twitteR
covr htmltools mondate RMySQL urca
crayon htmlwidgets multcomp ROAuth urltools
curl httpuv munsell RODBC vcd
DAAG httr mvtnorm rpart viridis
data.table hunspell neighbr RPostgreSQL withr
date inline nlme rprojroot wordcloud
DBI iterators NLP RSQLite xgboost
dichromat itertools nnet rticles xml2
digest janeaustenr nycflights13 RUnit XML

Copyright © 2021 All Rights Reserved 182

In st allat io n an d Co n figu r at io n Gu id e

doParallel jpeg openssl rvest xtable

dplyr jsonlite pkgKitten sandwich xts
e1071 kernlab plogr scales yaml
evaluate KernSmooth plyr selectr zoo
pmmlTransformatio
expm knitr shinyjs
ns
expsmoot
labeling pmml shiny
h
fastmatch Lahman png slam

Copyright © 2021 All Rights Reserved 183

In st allat io n an d Co n figu r at io n Gu id e

I N STALLIN G
M ICRO STRATEGY ON
L IN UX

Copyright © 2021 All Rights Reserved 184

In st allat io n an d Co n figu r at io n Gu id e

This section describes the procedure for installing MicroStrategy on Linux

platforms and covers the following:

Before installing MicroStrategy products, see Chapter 1, Planning Your

Installation for important pre-installation information.

Additionally, Chapter 10, Deploying OEM Applications explains the common

workflow for deploying the MicroStrategy platform as an Original Equipment
Manufacturer (OEM) application.

For supporting installation information, see Installing MicroStrategy on

Windows.

Installation Procedures on Linux

The MicroStrategy products that you can install on Linux environments are:

l MicroStrategy Intelligence Server

l MicroStrategy Web
l MicroStrategy Portlets
l MicroStrategy GIS Connectors
l MicroStrategy Web Services for Office
l MicroStrategy Mobile
l MicroStrategy Command Manager
l MicroStrategy Integrity Manager
l MicroStrategy Telemetry Server
l MicroStrategy System Manager
l MicroStrategy Communicator
l MicroStrategy Library
l MicroStrategy Platform Analytics

The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) are

not included in the MicroStrategy installation. You can download the

Copyright © 2021 All Rights Reserved 185

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy SDK from the MicroStrategy support site . You can also
access the MicroStrategy Developer Library from the MicroStrategy support
site.

For more information about these products, see MicroStrategy Products and
Components, page 10.

The following processes will be registered as OS services automatically

following restart after installation is complete:

l Intelligence Server
l Enterprise Manager Service
l Data Wrangling process
l Hadoop Gateway Manager
l Kafka
l Zookeeper
l Intelligence Server Log consumer
l Export Engine

It is recommended that you install MicroStrategy products as the root user.

Different methods of installation

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

Using command line mode

In command line mode, you type the appropriate information at the prompt
and press Enter. Instructions are included for each page of the
MicroStrategy Installation Wizard.

Copyright © 2021 All Rights Reserved 186

In st allat io n an d Co n figu r at io n Gu id e

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

followed by pressing Enter. You then press 0 and Enter to continue.

Defaults appear next to each prompt and are enclosed in square brackets,
for example, [1]. click Enter to use the default, or type a different response
to the prompt to override the default.

In addition, on the command line wizard pages, the following options are
available:

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

l Press 2 and then click Enter to return to the previous page.
l Press 3 and then click Enter to cancel the installation and close the
MicroStrategy Installation Wizard.
l On the last page, which is MicroStrategy Installation Wizard Complete,
press 3 and then click Enter.

Using silent mode

You can perform a fully automated and unattended installation within the
MicroStrategy platform when you do not have access to a Linux graphical
user interface. This also lets you perform an installation on other machines.

For information on how to perform a silent installation on a Linux

environment, see Chapter 9, Automated Installation on Linux.

Inst alling wit h t he M icr oSt r at egy Inst allat ion Wizar d for
Linux
To i n st al l M i cr o St r at egy p r o d u ct s, yo u m u st l o g o n t o yo u r m ach i n e
u si n g a val i d Li n u x acco u n t . Fo r ease o f m an agem en t an d m ai n t en an ce,
i t i s r eco m m en d ed t h at yo u cr eat e a d ed i cat ed u ser acco u n t .

Yo u n eed r o o t access p er m i ssi o n s f o r i n st al l at i o n i f yo u h ave p u r ch ased

t h e CPU-b ased M i cr o St r at egy l i cen se.

Copyright © 2021 All Rights Reserved 187

In st allat io n an d Co n figu r at io n Gu id e

If yo u w an t t o en ab l e ad d i t i o n al er r o r an d t r o u b l esh o o t i n g i ssu e l o ggi n g

f o r t h e M i cr o St r at egy i n st al l at i o n r o u t i n e, co n t act M i cr o St r at egy Tech n i cal
Su p p o r t .

To exi t t h e i n st al l at i o n p r o cess at an y t i m e, cl i ck Ca n ce l .

To access the MicroStrategy Installation Wizard

1. N avi gat e t o t h e M i cr o St r at egy In st al l at i o n f o l d er an d t h en

QueryReportingAnalysis_Linux

Yo u can access t h e i n st al l at i o n f i l es b y aski n g yo u r syst em

ad m i n i st r at o r t o sh ar e t h e f i l es o n a n et w o r k l o cat i o n . Th er e ar e
d i f f er en t i n st al l at i o n f i l es f o r i n st al l i n g M i cr o St r at egy p r o d u ct s o n
d i f f er en t p l at f o r m s; Wi n d o w s an d Li n u x.

Yo u can r ed u ce t h e am o u n t o f d at a t h at h as t o b e d o w n l o ad ed f o r
t h e i n st al l at i o n b y excl u d i n g al l o f t h e .t zp f i l es l o cat ed i n t h e
DataFiles f o l d er . Yo u can u se t h i s t ech n i q u e t o d o w n l o ad o n l y
t h e f i l es r eq u i r ed t o co m p l et e yo u r M i cr o St r at egy i n st al l at i o n ,
w h i ch can t h en al so b e u sed t o r ed u ce t h e am o u n t o f d at a
p ackaged an d d o w n l o ad ed f o r o t h er M i cr o St r at egy i n st al l at i o n s.
Fo r st ep s t o cr eat e t h ese cu st o m i n st al l at i o n p ackages, see
Cr eat i ng Cust om Inst al l at i on Packages, page 133. Det ai l s o n u si n g a
options.txt f i l e t o p r o vi d e t h e l o cat i o n o f t h e i n st al l at i o n f i l es
ar e p r o vi d ed i n Chapt er 9, Aut om at ed Inst al l at i on on Li nux an d t h e
p ar am et er s u sed t o sp eci f y t h e l o cat i o n o f t h e r eq u i r ed i n st al l at i o n
f i l es ar e d escr i b ed i n Inst al l on Dem and Opt i ons, page 617.

2. Typ e o n e o f t h e f o l l o w i n g co m m an d s, d ep en d i n g o n t h e i n st al l at i o n
m o d e yo u ch o se:

l To r u n t h e w i zar d i n GUI m o d e: ./setup.sh

l To r u n t h e w i zar d i n co m m an d l i n e m o d e: ./setup.sh -console

Copyright © 2021 All Rights Reserved 188

In st allat io n an d Co n figu r at io n Gu id e

l To r u n t h e w i zar d i n si l en t m o d e: ./setup.sh -silent -

options options.txt

Fo r i n f o r m at i o n o n p er f o r m i n g a si l en t i n st al l at i o n w i t h an
options.txt f i l e, see Com pl et i ng a Si l ent Inst al l at i on, page 577.

3. Th e M i cr o St r at egy In st al l at i o n Wi zar d o p en s an d l ead s yo u t h r o u gh

t h e i n st al l at i o n p r o cess. Th e f o l l o w i n g sect i o n s d escr i b e t h e act i o n s
yo u n eed t o t ake f o r each p age i n t h e w i zar d .

To co m p l et e t h e i n st al l at i o n , yo u m u st h ave w r i t e p er m i ssi o n s i n
t h e i n st al l at i o n d i r ect o r y; o t h er w i se t h e i n st al l at i o n f ai l s.

Af t er yo u en t er al l r eq u i r ed i n f o r m at i o n o n an i n st al l at i o n p age,
cl i ck N e xt , o r p r ess 1 an d t h en cl i ck En t e r , t o p r o ceed t o t h e n ext
p age o f t h e i n st al l at i o n r o u t i n e.

To q u i t t h e i n st al l at i o n at an y t i m e d u r i n g t h e set u p , cl i ck Ca n ce l ,
o r p r ess 3 an d t h en cl i ck En t e r .

Th e f o l l o w i n g d i al o gs ap p ear i n t h e In st al l w i zar d :

l Lan gu age Set u p

l M i cr o St r at egy In st al l at i o n Sel ect i o n
l Li cen se Agr eem en t
l Cu st o m er In f o r m at i o n
l Ch o o se Dest i n at i o n Lo cat i o n
l Sel ect Co m p o n en t s
l M i ssi n g In st al l at i o n Fi l es
l M i ssi n g Req u i r em en t s
l Syst em Req u i r em en t s
l Op en So u r ce So f t w ar e Agr eem en t
l M i cr o St r at egy Li b r ar y Web an d M o b i l e
l M i cr o St r at egy Pl at f o r m An al yt i cs

Copyright © 2021 All Rights Reserved 189

In st allat io n an d Co n figu r at io n Gu id e

l M i cr o St r at egy Tel em et r y Ser ver Cl u st er Co n f i gu r at i o n

l To p o l o gy Co n f i gu r at i o n
l Regi st er as a Ser vi ce
l CPU Li cen se In f o r m at i o n
l So f t w ar e Act i vat i o n
l St ar t In st al l er Op er at i o n
l M i cr o St r at egy In st al l Wi zar d Co m p l et e

Linux Install Wizard - Language Setup

Specify the language to be used for the MicroStrategy installation.

Linux Install Wizard - MicroStrategy Installation Selection

This dialog appears if there are installations of MicroStrategy software on
the current machine. The steps provided here assume that you are either
installing for the first time or creating a new installation.

You can support multiple installations of MicroStrategy on Linux machines.

Additionally, you can also modify, repair, and upgrade existing
MicroStrategy installations. This dialog provides the following installation
options to support these scenarios:

l Create a new installation: Select this option to create a new installation

of MicroStrategy on the machine. If an installation of MicroStrategy is
already present on the machine, you can select this option to install a
completely separate copy of MicroStrategy on the machine.

l Use an existing installation: If an installation of MicroStrategy is already

present on the machine, it can be updated or you can select this option to
perform various installation configurations.

l Modify: Select this option to add new program components or to remove

currently installed components. If you want to remove all MicroStrategy
components, use the Uninstall option described below. The remaining

Copyright © 2021 All Rights Reserved 190

In st allat io n an d Co n figu r at io n Gu id e

dialogs are the same as for a first-time installation, although some

dialogs may be skipped if they are not required as part of the installation
modification.
l Repair: Select this option to re-install program components if you have
problems with previously installed components. Your program
components are returned to their original installation state. As part of a
repair installation, you can also designate this machine as a Health
Agent.
l Uninstall: Select this option to uninstall all MicroStrategy components.
l Upgrade: Select this option to upgrade all MicroStrategy components to
the version you are installing. This option is only available if the version
you are installing is a more recent version of MicroStrategy than the
current installation. Only the MicroStrategy components currently
installed are upgraded, you cannot install or uninstall MicroStrategy
components as part of an upgrade. For best practices and steps to
upgrade your MicroStrategy installation, see the Upgrade Help.
l Remove Update: Select this option to uninstall a MicroStrategy Update
installation.

Linux Install Wizard - License Agreement

Read the license agreement and select to accept or decline the agreement.
If you choose to decline, you cannot install MicroStrategy products.

Linux Install Wizard - Customer Information

Enter the following customer information:

l User
l Company
l License Key

Copyright © 2021 All Rights Reserved 191

In st allat io n an d Co n figu r at io n Gu id e

To request a license key, go to the license key generator in the

MicroStrategy Download Site, contact your MicroStrategy Representative or
contact MicroStrategy Technical Support.

Linux Install Wizard - Choose Destination Location

Specify the locations where the MicroStrategy products and MicroStrategy
common files are to be installed:

l MicroStrategy Home Directory: Specify the location where the

MicroStrategy configuration files and application launchers are to be
installed, according to the following guidelines:

l The default location is /var/opt/MicroStrategy, or

$HOME/MicroStrategy if you do not have write access to
/var/opt/MicroStrategy.
l Do not install the MicroStrategy configuration files directly to your Linux
Home Directory ($HOME). To ensure that the required permissions can
be defined for the MicroStrategy configuration files, you must install
these files within a separate directory. For example, the default path of
$HOME/MicroStrategy uses the MicroStrategy directory within
$HOME to ensure permissions on these files are defined correctly.
l The path specified for the home directory is referred to as HOME_PATH in
this guide.
l Do not change the names of folders within the HOME_PATH after
installing Intelligence Server.
l When including paths during a MicroStrategy installation, include
absolute paths rather than relative paths.

l MicroStrategy Install Directory: Specify the location where the

MicroStrategy products are to be installed, according to the following
guidelines:

l The default location is /opt/MicroStrategy, or

$HOME/MicroStrategy/install if you do not have write access to

Copyright © 2021 All Rights Reserved 192

In st allat io n an d Co n figu r at io n Gu id e

/opt/MicroStrategy.
l The path specified for the install directory is referred to as INSTALL_
PATH in this guide.
l Do not change the names of folders within the INSTALL_PATH after
installing Intelligence Server.
l When including paths during a MicroStrategy installation, include
absolute paths rather than relative paths.

l MicroStrategy Log Directory: Specify the location where the

MicroStrategy application logs are to be created, according to the
following guidelines:

l The default location is /var/log/MicroStrategy, or

$HOME/MicroStrategy/log if you do not have write access to
/var/log/MicroStrategy.
l The path specified for the log directory is referred to as LOG_PATH in
this guide.
l When including paths during a MicroStrategy installation, include
absolute paths rather than relative paths.

l The MSTRDebugInstall.log file will be located in the MicroStrategy

Log Directory for troubleshooting.

Linux Install Wizard - Select Components

Select a MicroStrategy product to include it in the installation. Alternatively,
you can clear a checkbox to uninstall or exclude a MicroStrategy product
from the installation.

The installation dialogs you see after this step depend on the products you
choose to install. These instructions describe all possible dialogs.

If you are installing MicroStrategy Communicator, components of

MicroStrategy Intelligent Enterprise are also installed.

Copyright © 2021 All Rights Reserved 193

In st allat io n an d Co n figu r at io n Gu id e

Many of the platform components have subcomponents. If you expand the

different MicroStrategy products, you can select the appropriate checkboxes
to specify the subcomponents to install. For information on MicroStrategy
components and subcomponents, see MicroStrategy Products and
Components, page 10 in Chapter 1, Planning Your Installation.

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

Dest i n at i o n Fo l d er

You can select MicroStrategy products and their subcomponents to define

their installation locations. When you select a MicroStrategy product or
subcomponent, the Destination Folder area near the bottom of the interface
displays the current installation folder for the product. Click Browse to
select a different installation folder.

If you select a MicroStrategy product or subcomponent and the Browse

button is not accessible, this means that the installation location cannot be
changed. For example, if you select MicroStrategy Mobile you cannot define
an installation location. However, if you expand this product, you can define
the installation location for its subcomponents.

Linux Install Wizard - Create Custom Installation Packages

You see the Missing Installation Files message only if some of the files,
required to install the MicroStrategy components you have selected for
installation, are not available. If you are downloading only a subset of the
installation files to reduce the amount of data that must be downloaded for
the installation, it is recommended that you do the following:

l Determine the files required for the MicroStrategy components you are
installing. A list of installation file requirements is provided in the table
below:

Copyright © 2021 All Rights Reserved 194

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The Installation

Installation File
File

mstr1.tzp All MicroStrategy components and products

MicroStrategy Intelligence Server Universal and all of its

mstr3.tzp
components

MicroStrategy Web Universal, including Web Analyst, Web

mstr4.tzp
Reporter, and Web Professional

mstr5.tzp MicroStrategy Web Services for Office

mstr6.tzp MicroStrategy Command Manager

mstr7.tzp MicroStrategy Integrity Manager

mstr8.tzp MicroStrategy System Manager

mstr10.tzp MicroStrategy Mobile Server

MicroStrategy Portlets, which is a component of MicroStrategy

mstr11.tzp
Web

MicroStrategy GIS Connectors, which is a component of

mstr12.tzp
MicroStrategy Web Universal

mstr13.tzp ReleaseNotes

mstr14.tzp MicroStrategy Enterprise Manager

mstr20.tzp MicroStrategy Messaging Services

mstr21.tzp MicroStrategy Library Web & Mobile

mstr22.tzp MicroStrategy Collaboration Server

Node.js which is installed with Intelligence Server and

mstr25.tzp
Collaboration Server

mstr26.tzp Application Schema Server (Early Adopter)

mstr27.tzp Redis which is installed with MicroStrategy Platform Analytics

Copyright © 2021 All Rights Reserved 195

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Components That Require The Installation

Installation File
File

(Early Adopter)

mstr28.tzp MicroStrategy Platform Analytics (Early Adopter)

mstr29.tzp Service Registration and Common Files

mstr30.tzp Community Connectors

mstr31.tzp Certificate Manager

mstr32.tzp MicroStrategy Export

mstr35.tzp MicroStrategy Modeling Service

mstr36.tzp MicroStrategy Repository

mstr37.tzp CloudConnector

l Provide the location of the installation files using an options.txt file.

This lets you access the installation files stored on a folder or stored at a
URL and accessed using HTTP or HTTPS. Details on using an
options.txt file as part of an installation are provided in Chapter 9,
Automated Installation on Linux and the parameters used to specify the
location of the required installation files are described in Install on
Demand Options, page 617.

If the files required for the installation are stored in a folder, you can instead
click Browse to navigate to and select the folder that stores the installation
files. If all the required installation files are provided in the folder you select,
you can click Enter to continue the MicroStrategy installation.

Linux Install Wizard - Missing Requirements

If there are system requirements that are not met to install the MicroStrategy
products you selected, a 'Missing Requirements' list appears. Review the list
of requirements to determine if you can proceed with the installation.

Copyright © 2021 All Rights Reserved 196

In st allat io n an d Co n figu r at io n Gu id e

If you are missing installation requirements, the uninstalled dependency is

marked as 'Missing' and the Next button is disabled. Without exiting the
installer, go back to change the selected components or install the missing
components. Click the Recheck button to determine if all the installation
requirements have been met and click Next to proceed.

Starting in MicroStrategy 2021 Update 4, the installer allows system

administrators to enable core file generation. In the event of a crash, core
files are automatically generated for easier troubleshooting. See KB13610 to
learn more about configuring the correct system settings to ensure core files
for the MicroStrategy Intelligence server are created by the
Linux operating system.

If you are installing MicroStrategy Intelligence Server on Linux, you may see
a warning about the value for the Linux kernel setting vm.max_map_count.
For information about this setting and the recommendation for its value, see
Software Requirements and Recommendations.

Linux Install Wizard - System Requirements

This dialog appears if the machine you are installing Intelligence Server on
does not use the recommended system resource limits to support the use of
shared memory resources. It is recommended that you exit the installation
and configure these system settings to support shared memory resources.
For information on this requirement and the options available to complete
the installation, see Configuring shared memory resources, page 110.

Linux Install Wizard - MicroStrategy Library Web and Mobile

Provide the installation directory for Apache Tomcat to deploy MicroStrategy
Library Web and Mobile.

Copyright © 2021 All Rights Reserved 197

In st allat io n an d Co n figu r at io n Gu id e

Linux Install Wizard - MicroStrategy Telemetry Server

Configuration
If Intelligence Server or Platform Analytics are chosen for installation, the
option to configure a MicroStrategy Telemetry cluster is presented.

If no cluster needs to be configured, click Next.

To configure a cluster:

1. Select the Create a cluster of three or more Telemetry Servers

check box.
2. Local Node: Provide the fully qualified domain name for the local
Telemetry Server.
3. Remote Nodes: Provide a semicolon separated list of the fully qualified
domain names for the remote Telemetry Servers in the cluster. The
node ID is determined by alphabetical order in node list.

See, MicroStrategy Telemetry Serverfor detailed configuration information.

Linux Install Wizard - Topology Configuration

Topology allows administrators to monitor MicroStrategy Services and
manage them in MicroStrategy Workstation. The following functionality is
supported:

l Service Health Monitor

The administrator can monitor MicroStrategy services through Workstation

and visualize if they are running or stopped.

l Service Start/Stop

The administrator can start or stop MicroStrategy services through

Workstation. This functionality is currently limited to SSH authentication
with username and password.

Copyright © 2021 All Rights Reserved 198

In st allat io n an d Co n figu r at io n Gu id e

See the topic, How to View Environment Topology and Monitor Services in
the Workstation Help for more information about using topology within
Workstation.

The two following types of lightweight agents are used to monitor services in
Workstation:

l Monitoring Agents

The monitoring agents come with the installation of most MicroStrategy

services. Use them to monitor services and view their health status.

l Communication Agents:

Some monitoring agents also act as communication agents. In addition to

monitoring services, communication agents help other monitoring agents
locate each other and gather monitoring information. The administrator
must pick at least one agent to act as a communication agent, so all other
agents can locate each other through this agent.

On environments where three or more machines host MicroStrategy

Services, it is recommended that you choose at least three communication
agents to provide redundancy and improved reliability, in case one
communication agent becomes unavailable. The machines chosen to act
as communication agents must be machines that host MicroStrategy
Services, such as Intelligence Server or MicroStrategy Library. If you
decide to use only one communication agent, it is recommended that you
choose the machine that houses MicroStrategy Library (if deployed
through the MicroStrategy installation), since Library communicates
directly with Workstation.

If your Library deployment is done through a WAR file or if you do not use
a machine that houses MicroStrategy Library to host the communication
agent, then use a machine that houses Intelligence Server.

Copyright © 2021 All Rights Reserved 199

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy uses Consul technology for Services Registration. A

monitoring agent corresponds to a Consul agent in client mode. A
communication agent corresponds to a Consul agent in server mode.

Copyright © 2021 All Rights Reserved 200

In st allat io n an d Co n figu r at io n Gu id e

1. On the Topology Configuration dialog of the Installation wizard, select

whether your environment has Single or Multiple machines.

2. If your environment contains multiple machines, determine which

machines in your environment you want to act as communication
agents. Among all the machines in your environment that will host
MicroStrategy Services, select at least one of them (three are
recommended for multiple machine environments) to act as a
communication agent. Enter each machine in the text field, separated
by semicolons. You must input the exact same list on all machines,
using the Topology Configuration dialog of the Installation wizard,
including the monitoring and communication agent machines.

The MicroStrategy Services are as follows:

l MicroStrategy Intelligence Server

l MicroStrategy Web Universal
l MicroStrategy Library
l MicroStrategy Mobile
l MicroStrategy Messaging Services
l MicroStrategy Platform Analytics
l MicroStrategy Certificate Store

Copyright © 2021 All Rights Reserved 201

In st allat io n an d Co n figu r at io n Gu id e

An odd number of communication agents is required due to the

leadership selection algorithm.

Examples:

servername1.domain.com;servername2.domain.com;server
name3.domain.com;
servername1.domain.com;

Example: Your environment contains the following two machines and

you select one machine to host the communication agent:

l Machine 1 hosts MicroStrategy Library and the communication agent

l Machine 2 hosts the Intelligence Server

When performing the installation, enter the full domain name,

machine1.domain.com, on both machines.

Example: Your environment contains the following three machines and

you want all machines to host a communication agent:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1
l Machine 3 hosts Intelligence Server 2

When performing the installation, enter

machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all three machines.

Example: Your environment contains the following five machines and

you select three machines to host the communication agents:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1 and a communication agent
l Machine 3 hosts Intelligence Server 2 and a communication agent

Copyright © 2021 All Rights Reserved 202

In st allat io n an d Co n figu r at io n Gu id e

l Machine 4 hosts Intelligence Server 3 and a communication agent

l Machine 5 hosts Intelligence Server or other services

Enter
machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all machines.

Some important information to keep in mind:

l In MicroStrategy 2019, OpenSSH is no longer installed on Windows

machines. You must install Open SSH to start and stop services using
topology. Upgrading your system from 11.0 to 2019 removes Open SSH.

If consul is already installed on a machine, prior to installing MicroStrategy

products, the service registration auto configuration and execution is
affected. We do not recommend a separate consul installation on the same
machine.

l If you select Multiple machine environment, you must enter an odd

number of machines.
l If your environment includes more than one machine and machines with
dynamic IP addresses as communication agents, use FQDN for the
communication agent machine list during the installation.
l If your environment includes more than one machine and machines with
more than one IP address as communication agents, it is recommended
that you use FQDN for the communication agent machine list during the
installation. If IP address list is used, make sure the machine with multiple
IP addresses can be pinged with an IP address included in the list.

Topology supports installation on machines with public IP addresses. To

avoid unexpected joins to topology nodes, possibly exposing service
information, you must configure your firewall correctly. Your firewall
should allows ports for Server RPC (default 8300), and Serf LAN (default
8301), and Serf WAN (default 8302) only for the nodes within the
Workstation topology node cluster. See Enabling Topology
Communication Through a Firewall for more information.

Copyright © 2021 All Rights Reserved 203

In st allat io n an d Co n figu r at io n Gu id e

After installing the topology feature, see Installing and Configuring Topology
for additional instructions on configuring this feature to work in your
environment.

Linux Install Wizard - Register as a Service

To enable MicroStrategy processes to start automatically after system start
up, 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, the
installer will create and use the mstr user and mstrgroup

Linux Install Wizard - CPU License Information

This dialog appears if the Intelligence Server license has a CPU number
limitation. Specify the number of CPUs that Intelligence Server is licensed to
use.

Copyright © 2021 All Rights Reserved 204

In st allat io n an d Co n figu r at io n Gu id e

Linux Install Wizard - Software Activation

If you have installed one or more MicroStrategy server products, you can
request an activation code for your MicroStrategy server products upon
completion of the installation process. The next few dialogs of the
installation process assist you in providing the information needed to
request an activation code. MicroStrategy server products include:

l MicroStrategy Intelligence Server

l MicroStrategy Web
l MicroStrategy Mobile Server

This dialog includes a welcome statement for the software activation

process. Read the welcome statement and click Next to proceed.

Ser ver In f o r m at i o n

Specify information about your MicroStrategy server installation. Enter the

following characteristics:

l Name: Distinguishes the name of this MicroStrategy server product

installation from any other MicroStrategy server product installations in
your company.
l Location: Physical location of the machine on which MicroStrategy server
products are installed.
l Use: Description of how the server is used.

l Click Privacy Statement to view the MicroStrategy Privacy Statement.

In st al l er In f o r m at i o n

Specify contact information of the person installing the software. After your
installation is complete an email containing the Activation Code is sent to
the email address you confirm in this software activation step. Enter the
following installer information:

Copyright © 2021 All Rights Reserved 205

In st allat io n an d Co n figu r at io n Gu id e

l Specify whether you are an employee of the licensed company or installing

on behalf of the licensed company.
l Enter the necessary data into all text fields. Make sure the email address
you enter is correct. This email address is the recipient of the Activation
Code.
l Select the check box at the bottom of the page to receive notifications
about product updates, events, and special offers from MicroStrategy.
l Click Privacy Statement to view the MicroStrategy Privacy Statement.

Co n t act In f o r m at i o n

You see this page if you indicated that you are not an employee of the
company licensed to use this software, and are installing the software on
behalf of that company.

Specify contact information for the employee license to use the software.
Enter the necessary data into all text fields. Make sure the email address
you enter is correct. After your installation is complete an email containing
the Activation Code is sent to the email address you confirm in this software
activation step.

Select the check box at the bottom of the page to receive notifications about
product updates, events, and special offers from MicroStrategy.

Click Privacy Statement to view the MicroStrategy Privacy Statement.

Req u est Act i vat i o n Co d e

This page includes options to request an Activation Code now or at a later

time. This page provides the following options:

l Select Yes, I want to request an Activation Code and click Next to

request an Activation Code. The Activation Code is sent to the email
addresses supplied in the Installer Information and Contact Information
pages.

Copyright © 2021 All Rights Reserved 206

In st allat io n an d Co n figu r at io n Gu id e

l Select No, I will request the Activation Code at a later time and click
Next to request an Activation Code at a later time.

If you choose to request an Activation Code at a later time, a message is

displayed that instructs you how to request an Activation Code after the
installation procedure is completed. For more instructions on requesting
an Activation Code at a later time, see Requesting an Activation Code,
page 357 in Chapter 4, Activating Your Installation.

You have a grace period of 30 calendar days to activate your installation. If

you do not complete the activation before the grace period expires, your
MicroStrategy product stops functioning until you activate it. If you wait to
activate your installation, you receive periodic reminders.

Once you request an Activation Code, an email is sent to the email

addresses you specify in the Installer Information and Contact Information
pages of the software activation procedure. The email provides instructions
on how to use the requested Activation Code to activate your software. To
activate your installation, you can also use the steps given in Activating
Your Installation Using License Manager, page 359 in Chapter 4, Activating
Your Installation.

Linux Install Wizard - Start Installer Operation

This dialog provides a description of what configurations are to be
completed. If you chose to install, repair, update or carry out a platform
upgrade of MicroStrategy components, the locations in which the products
will be installed (target directories), the location of the installation log file,
and license details will be provided. If you chose to uninstall MicroStrategy
components, this includes a listing of the components to be uninstalled.

When you proceed from this step, the installation process begins, which can
take several minutes depending on your computer’s hardware configuration.

Copyright © 2021 All Rights Reserved 207

In st allat io n an d Co n figu r at io n Gu id e

Linux Install Wizard - MicroStrategy Install Wizard Complete

When the MicroStrategy installation has completed, you can select the
following:

l Run MicroStrategy Identity Configuration, which is available if the

MicroStrategy Identity Manager has been installed.
l View the Readme for the latest updates.
l Run the MicroStrategy Configuration Wizard, which allows you to
configure your MicroStrategy production environment. For more
information, see Chapter 5, Configuring and Connecting Intelligence
Server.

Click Finish to complete the installation.

Default Passwords for Configuration

During the configuration process, the MicroStrategy Installer randomly

generates a password for the MicroStrategy Web Administration page,
MicroStrategy Mobile Administration page, MicroStrategy Repository,
Tomcat (if installed), and MySQL (if installed). The username and password
for all three are the same.

l Username: mstr

l Password: The password can be found in the following file on the server
where MicroStrategy Secure Enterprise was installed:

/<install_path>/Repository/Default_Accounts.txt

Note the username and password, and store them securely. These
credentials will be used to configure the DSN to the Platform Anlaytics
project.

It is recommended to delete the Default_Accounts.txt file after the

password is stored securely. This password cannot be recovered if it is lost.

Copyright © 2021 All Rights Reserved 208

In st allat io n an d Co n figu r at io n Gu id e

Warning Message for the Intelligence Server's Governing Mechanism

When the installation is complete, the following message may be displayed.

This occurs when the installer is executed by a non-root user. In this case,
the installer lacks the permission to raise a user-level limit, or the nice
value limit, that is required for prioritizing time-sensitive and interactive
requests arriving at the Intelligence Server. This prioritization is part of the
Intelligence Server's automatic governing mechanisms that help maintain
response time performance under heavy loads. To learn more about the
required nice limit for prioritization and how to manually apply the limit, see
this page.

When the installation is complete, any of the following messages may be

displayed.

A similar message is displayed to the standard output when the installer is

run from command line. On the other hand, if the installer is run in silent
mode, the following entries are added into the install.log file.

Copyright © 2021 All Rights Reserved 209

In st allat io n an d Co n figu r at io n Gu id e

3 Jun 2020, 11:35:27 AM:SEVERE: Failed to set MicroStrategy Intelligence

priority process settings
3 Jun 2020, 11:35:27 AM:SEVERE: Priority process settings for MicroStrategy
Intelligence doesn't meet the requirements
3 Jun 2020, 11:35:27 AM:SEVERE: Root privileges are required to configure
the nice limit to 0 or lower

Unique Post-Installation Configurations

MicroStrategy supports many different Linux environments with various
system configurations. There are a few cases in which you must perform
some manual configurations to support the use of MicroStrategy on your
system.

Create Links for Intelligence Server Startup in SUSE Linux

If you are installing Intelligence Server on a SUSE Linux environment, you
must manually create links for some system files. If you do not create these
links, Intelligence Server cannot start correctly.

You need root permissions to access the files and create the necessary
links described in this section.

1. In a console window, browse to the system folder usr/lib64.

2. In a console window, create the link of libssl.so.4 to

libssl.so.0.9.7 with the following command:

ln libssl.so.0.9.7 libssl.so.4

3. In a console window, create the link of libcrypto.so.4 to

libcrypto.so.0.9.7 with the following command:

ln libcrypto.so.0.9.7 libcrypto.so.4

Copyright © 2021 All Rights Reserved 210

In st allat io n an d Co n figu r at io n Gu id e

Starting and Stopping Intelligence Server Kafka service

For Linux users, the Kafka Consumer will be installed and automatically
running after installation or upgrade. You will find KafkaConsumner.sh,
LogConsumer.properties, and KafkaConsumer.jar under <install_
path>/IntelligenceServer/KafkaConsumer. You can use the
following commands to control the Kafka Consumer logging activity:

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 will not be started when OS is
restarted. To start this service manually, run the pdfexporter.sh script
found under the path
install/IntelligenceServer/PDFExportService. Commands for
this script include:

l <path_to>/pdfexporter.sh start to start the PDF Exporter Service.

l <path_to>/pdfexporter.sh stop to stop the PDF Exporter Service.
l <path_to>/pdfexporter.sh restart to restart the PDF Exporter
Service.
l <path_to>/pdfexporter.sh status to check the status the PDF
Exporter Service.

For other configuration settings, see Export Engine Configuration.

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

Copyright © 2021 All Rights Reserved 211

In st allat io n an d Co n figu r at io n Gu id e

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

is the directory you specified as the install directory in the MicroStrategy
Installation Wizard.

The log file includes information about the following:

l Installation date
l Target directory
l Operating system identification
l Selected installation options
l Selected licensing details

This log file can be helpful if you encounter errors during the installation
process. The log file records the reasons for errors occurring.

Directory Structure
The following table lists the directories in which MicroStrategy files are
installed:

PATH/Directory Contents

HOME_PATH Configuration files that can be modified after installation.

Scripts to set up the proper environment for the

MicroStrategy applications. If additional products are
HOME_PATH / env
installed on the same machine at a later time, backups of
the original scripts are saved here.

HOME_PATH / bin Scripts to launch the MicroStrategy applications.

Files that are not supposed to change after the

INSTALL_PATH
installation is complete.

MicroStrategy Command Manager files. This is the

INSTALL_
default directory for Command Manager but another
PATH / CommandManager
location can be selected during installation.

INSTALL_PATH / Help Documentation and Help for MicroStrategy products.

Copyright © 2021 All Rights Reserved 212

In st allat io n an d Co n figu r at io n Gu id e

PATH/Directory Contents

MicroStrategy Portlet files. This is the default directory

INSTALL_
for the Portlets but another location can be selected
PATH / GISConnectors
during installation.

INSTALL_
PATH Intelligence Server-specific binary files.
/ IntelligenceServer/bin

MicroStrategy Mobile and Mobile Server JSP files. This

INSTALL_PATH / Mobile is the default directory for Mobile but another location
can be selected during installation.

INSTALL_ Support files (fonts) for the PDF generation feature of

PATH / PDFGeneratorFiles Intelligence Server.

INSTALL_ MicroStrategy Readme for this release of MicroStrategy

PATH / ReleaseNotes products.

MicroStrategy Portlet files. This is the default directory

INSTALL_PATH / Portlets for the Portlets but another location can be selected
during installation.

MicroStrategy System Manager files. This is the default

INSTALL_
directory for System Manager but another location can
PATH / SystemManager
be selected during installation.

INSTALL_
MicroStrategy Web Services deployment path.
PATH / WebServicesJ2EE

INSTALL_
MicroStrategy Web deployment path.
PATH / WebUniversal

The Java Runtime Environment (JRE) to be used by the

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

INSTALL_PATH / _uninst Launch files for uninstalling MicroStrategy.

INSTALL_PATH / bin 64-bit binary files.

INSTALL_PATH / bin32 32-bit binary files.

Copyright © 2021 All Rights Reserved 213

In st allat io n an d Co n figu r at io n Gu id e

PATH/Directory Contents

INSTALL_PATH / help Online help files.

INSTALL_PATH / jar Java libraries.

INSTALL_PATH / lib 64-bit binary libraries.

INSTALL_PATH / lib32 32-bit binary libraries.

INSTALL_PATH / locale ODBC support messages.

MicroStrategy application log files, which includes

LOG_PATH
Intelligence Server log files.

Configuring your MicroStrategy Installation

After completing the steps to install MicroStrategy products, you can set up
and configure your installation. To help guide the rest of your installation
and configuration steps, refer to the section Installing and Configuring
MicroStrategy on Linux, page 141 in Chapter 1, Planning Your Installation,
for an installation and configuration checklist.

R and R Package Installer for Linux

The MicroStrategy R and R Package installer is a standalone component to
simplify the installation and configuration of R and the packages needed to
use R in conjunction with MicroStrategy 2020 and later. You can download
the R and R Package installer from the MicroStrategy download site.

l Prerequisites for Installing R and R Package in CentOS

l Prerequisites for Installing R and R Package in RHEL
l Prerequisites for Installing R and R Package in SUSE
l Install R and R Package in GUI Mode
l Install R and R Package in Silent Mode

Copyright © 2021 All Rights Reserved 214

In st allat io n an d Co n figu r at io n Gu id e

l Uninstall R and R Package

l R Packages Included in the Installation

Prerequisites for Installing R and R Package in CentOS

The following prerequisites must be met to install R and R Package in
CentOS:

1. Run the installer as the root user.

2. Enable public internet access.
3. Use a gcc.c++ version of 4.6 or later and a gcc-gfortran version earlier
than 5.

Prerequisites for Installing R and R Package in RHEL

The following prerequisites must be met to install R and R Package in RHEL:

1. Run the installer as the root user.

2. Enable public internet access.

3. Register and enable the RHSM repository.

Register the machine with your Redhat user account that is subscribed
to the RHSM service.

subscription-manager register --auto-attach.

Enable the optional repository.

subscription-manager repos -enable rhel-7-server-

optional-rpms

4. Use a gcc.c++ version of 4.6 or later and a gcc-gfortran version earlier

than 5.

Prerequisites for Installing R and R Package in SUSE

The following prerequisites must be met to install R and R Package in SUSE:

Copyright © 2021 All Rights Reserved 215

In st allat io n an d Co n figu r at io n Gu id e

1. Run the installer as the root user.

2. Enable public internet access.

3. Register and enable the SLES repository.

Register the machine with your SUSE user account.

SUSEConnect -r <YourActivationCode> -e
<YourEmailAddress>

Check the list of available SUSE extensions.

SUSEConnect -r <YourActivationCode> -p sle-sdk/15/x86_

64.

4. Use a gcc.c++ version of 4.6 or later and a gcc-gfortran version earlier

than 5.

Install R and R Package in GUI Mode

1. After completing installation of the MicroStrategy platform, download
the standalone R and R Package installer from the (missing or bad
snippet).

2. Navigate to the downloaded zip file.

cd Downloads/

3. Extract the contents of the file.

unzip <file-name> <destination>

4. Extract the installation file.

tar -xvf rpackage-linux-XXXX.tar.gz

All files are extracted to the RandRPackageInstaller directory.

5. Launch the R and R Package installer setup.

./randrpackageinstaller.sh

Copyright © 2021 All Rights Reserved 216

In st allat io n an d Co n figu r at io n Gu id e

6. The R and R Package installer launches in GUI mode. Click Next.

7. Accept the license agreement and click Next.

Copyright © 2021 All Rights Reserved 217

In st allat io n an d Co n figu r at io n Gu id e

8. Click Install.

9. Click Finish.

Copyright © 2021 All Rights Reserved 218

In st allat io n an d Co n figu r at io n Gu id e

10. If necessary, troubleshoot any issues using the log at <user

directory>/randrpackageinstaller.log.

Install R and R Package in Silent Mode

1. After completing installation of the MicroStrategy platform, download
the standalone R and R Package installer from the (missing or bad
snippet).

2. Navigate to the downloaded zip file.

cd Downloads/

3. Extract the contents of the file.

unzip <file-name> <destination>

4. Extract the installation file.

tar -xvf rpackage-linux-XXXX.tar.gz

All files are extracted to the RandRPackageInstaller directory.

5. Update the options.txt file in the RandRPackageInstaller

directory.

Copyright © 2021 All Rights Reserved 219

In st allat io n an d Co n figu r at io n Gu id e

6. Launch the R and R Package installer in silent mode.

./randrpackageinstaller.sh -silent -options <path_to_

options.txt_file>

7. If necessary, troubleshoot any issues using the log at <user

directory>/randrpackageinstaller.log.

Uninstall R and R Package

R and R Package is installed with packages as well as dependencies. When
you uninstall R and R Package, you should only remove R and R Package
components and avoid uninstalling R and R Package dependencies since
they may be shared by other applications.

Use the following list of required components to uninstall R and R Package

binaries.

Package
Command Reference
Manager

R for Linux
YUM (Red yum remove R-core R-core-devel R-java R-
Redhat
Hat) java-devel libRmath libRmath-devel
Readme

Zypper zypper remove R-core R-core-devel R-core- R for Linux

(SUSE) libs R-core-doc SUSE Readme

R Packages Included in the Installation

Expand to see the R packages included in the installation.
abind fastmatch Lahman praise slam
acepack filehash lattice proto SnowballC
ada foreach latticeExtra proxy sourcetools

Copyright © 2021 All Rights Reserved 220

In st allat io n an d Co n figu r at io n Gu id e

amap forecast lazyeval psych sp

arules foreign lmtest purrr sparklyr
assertthat Formula longmemo quadprog SparseM
backports fracdiff lubridate quanteda spatial
base64en
fts magrittr quantreg stringi
c
BH gapminder manipulate R6 stringr
strucchang
bit gbm mapproj randomForest
e
randomForestSR
bit64 gdtools maps survival
C
bitops geosphere maptools rappdirs svglite
boot ggmap markdown rbenchmark testthat
broom ggplot2 MASS RColorBrewer TH.data
ggplot2movie
ca Matrix Rcpp tibble
s
caTools glmnet MatrixModels RcppArmadillo tidyr
checkmat
gridExtra memoise RcppParallel tidytext
e
chron gtable mgcv RCurl timeDate
class gutenbergr microbenchmark readr timeSeries
cluster hexbin mime reshape2 tis
coda highlight miniUI rex tm
codetools highr mlbench RgoogleMaps tokenizers
colorspac topicmodel
Hmisc mnormt rjson
e s
config hms modeltools rmarkdown triebeard
covr htmlTable mondate RMySQL tseries
crayon htmltools multcomp ROAuth twitteR
curl htmlwidgets munsell RODBC urca

Copyright © 2021 All Rights Reserved 221

In st allat io n an d Co n figu r at io n Gu id e

DAAG httpuv mvtnorm rpart urltools

data.table httr neighbr Rpoppler vcd
date hunspell nlme RPostgreSQL viridis
DBI inline NLP rprojroot viridisLite
dichromat iterators nnet RSQLite withr
digest itertools nycflights13 rticles wordcloud
doParallel janeaustenr openssl RUnit xgboost
dplyr jpeg pkgKitten rvest XML
dtplyr jsonlite plogr sandwich xml2
e1071 kernlab plyr scales xtable
evaluate KernSmooth pmml selectr xts
pmmlTransformatio
expm knitr shiny yaml
ns
expsmoot
labeling png shinyjs zoo
h

In st al l i n g an d Co n f i gu r i n g
M i cr o St r at egy Li b r ar y
The MicroStrategy Library installation includes the MicroStrategy REST
Server as well as the MicroStrategy Collaboration Server, which enable the
following functionalities:

l Browse shared content: Users have access to their own library where
shared dossiers and documents are available to be consumed.
l Search for dossiers: Users can easily search for dossiers with matching
criteria such as dossier name, chapter/page name, etc.
l Manipulate the data view with visualizations and filters: Users can
consume the data in a dossier with visualization and filter manipulations.

Copyright © 2021 All Rights Reserved 222

In st allat io n an d Co n figu r at io n Gu id e

Every action is recorded in the metadata so that a user can resume from
the last stopping point for the next login.
l Share dossier to other users: Users can share their dossier view to
other users. All of the manipulations will be carried over so that they
consume the data based on same context.
l Interact with other users via comments and notifications
(Collaboration Server): User can leave commentary, tag other users, and
embed filters to collaborate with other users within any dossier.

The Collaboration Server also supports the following advanced

functionalities:

l Realtime monitoring of connected users: Every user that connects to

the Library Web or Mobile application is tracked by this service.
l Realtime monitoring of user comments: Users can create comments
associated with each individual page. Users will receive new comments as
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 filter
settings with a comment for another user to apply.
l User mention and notification: Users can send notification to another
user via user mention. In addition to "in-app" notification, users can also
be notified by APNS (device notification) and email notification.

MicroStrategy Library Architecture

The following terminology will help you to understand what is behind the
Collaboration Server.

l Web Socket is a protocol providing full-duplex communication channels

over a single TCP connection. Web Socket is supported with all major
browsers and can be used in mobile applications. For Web Socket to work
in an application, an application server (web server) needs to support it as
well.

Copyright © 2021 All Rights Reserved 223

In st allat io n an d Co n figu r at io n Gu id e

If the Library cannot establish a Web Socket connection due to a blocked

protocol in an environment that contains load balancers, it attempts an
HTTP connection and uses a technique called "long polling" to simulate a
real time message exchange.

l Node.js is an open-source, cross-platform runtime environment for

developing server-side Web applications. Node.js is the runtime
environment for hosting the MicroStrategy Collaboration Server.
l PostgreSQL is an open-source relational database management system
used to store collaboration data for the MicroStrategy Library application.

The following diagram shows the Library architecture, including the

Collaboration Server.

Messages flow in both directions of a Web Socket connection. The

MicroStrategy Collaboration Server manages which messages go to which
clients based on a publish-subscribe model. A client application may publish
a comment to a topic, and all clients subscribed to the topic will be notified.

Copyright © 2021 All Rights Reserved 224

In st allat io n an d Co n figu r at io n Gu id e

Library Administration Control Panel

You can access the Library Admin control panel by navigating to
<FQDN>:<port>/MicroStrategyLibrary/admin. The control panel
allows you to examine and configure settings for Library server and
Collaboration server. Additionally you can view the settings related to
communication with the Intelligence server and configurations in
MicroStrategy Library such as the Intelligence server cluster it is connected
to.

Copyright © 2021 All Rights Reserved 225

In st allat io n an d Co n figu r at io n Gu id e

Overview Tab
The Library Admin Overview tab provides the ability to examine the machine
name, port, state, and Intelligence and Collaboration servers. The top right
corner of each component displays its current status. Click Edit to change
settings for Intelligence and Collaboration servers. You can also choose to
expose or hide the Collaboration service feature to users.

Configure Collaboration Server

To add a Collaboration server, only the machine name (hostname) and port
are required.

The Collaboration server uses 3000 as the default port. If the administrator
uses 0 as the port number when configuring the Collaboration server, it will
be replaced with 3000.

Copyright © 2021 All Rights Reserved 226

In st allat io n an d Co n figu r at io n Gu id e

Configure Intelligence Server

To add an Intelligence server, the administrator needs to specify the
machine name (hostname), port, and TLS status.

The Intelligence server uses 34952 as the default port. If the administrator
uses 0 as the port number, the Library server tries to connect to an
Intelligence server under port 34952.

Ensure the input is the DNS of an Intelligence Server and not other
intermediate components. Load balancers are not supported between the
MicroStrategy Library and Intelligence Server layers, as load balancing is
handled within these layers by MicroStrategy Library.

Error / Warning Messages / Troubleshooting

Existing configuration issues appear with an error or warning icon on the
Overview page:

l Error icons in red: The system is not running as expected. Click to view a
more detailed message.
l Warning icons in yellow: There are some minor issues that should be
addressed.

When you click an error or warning icon, a pop up window displays a

detailed error message. It provides actions and links regarding why the
issue occurred and how to resolve it.

Copyright © 2021 All Rights Reserved 227

In st allat io n an d Co n figu r at io n Gu id e

Timeout Settings
If you receive a Timeout Error in the Library Admin control panel, modify the
timeout settings in the Library server configuration file
configOverride.properties to a larger value. For example:

http.connectTimeout=5000
http.requestTimeout=10000

Library Server Tab

The Library Server tab allows an administrator to view their deployment's
Library URL, Web Server URL, configure authentication modes, security
settings, extend user sessions, access the Mobile configuration link, and
configure connectivity settings to the Modeling service.

Copyright © 2021 All Rights Reserved 228

In st allat io n an d Co n figu r at io n Gu id e

Library Server
The connection URL for MicroStrategy Library.

MicroStrategy Web
This provides a connection URL to MicroStrategy Web, which enables the
Web options in Library.

Related Content Settings

This section allows you to manage the content displayed in the Related
Content section of your dossier. You can choose to show all related content,
restrict recommendations to only certified items, or disable the setting
completely.

Authentication Modes
The Authentication Modes section gives an administrator to dictate which
authentication modes they want to allow. When the authentication mode is

Copyright © 2021 All Rights Reserved 229

In st allat io n an d Co n figu r at io n Gu id e

updated and saved, the server typically requires a restart.

Trusted authentication mode cannot be used in combination with any other

log in mode.

Security Settings

Chrome Web Browser version 80 and above introduces new changes which
may impact embedding. For more information, see KB484005: Chrome v80
Cookie Behavior and the Impact on MicroStrategy Deployments.

As with any web application, extending a user session may increase

security risk and exposure. The extended session is governed by the
Intelligence server Authentication Policy/Token Lifetime. By default, a
Library http session times out after 30 minutes. Enabling the Keep users
logged in feature will extend the user session beyond 30 minutes and up to
Token Lifetime. It is strongly recommended that you do not modify the
Token Lifetime beyond the default value of 24 hours.

The first security settings section allows administrators to allow Library

embedding in other sites. In other words, this section enables Cross-Origin
Resource Sharing (CORS) A mechanism that uses additional HTTP headers
to tell a browser to let a web application running at one origin (domain) have
permission to access selected resources from a server at a different origin.
settings. You must enable your CORS settings to use MicroStrategy
products like HyperIntelligence or MicroStrategy for Office or to embed a
dossier in a website.

To enable CORS, select All. When this security setting is updated and
saved, restart the Library application.

Additionally, the security settings section allows administrator to enter an

optional secret key which is used to allow sharing sessions between
MicroStrategy Web and MicroStrategy Library.

To extend a user session, select the Keep users logged in checkbox.

Copyright © 2021 All Rights Reserved 230

In st allat io n an d Co n figu r at io n Gu id e

Mobile Configuration
The mobile configuration link provides with the mobile server link which can
copied and can be accessed.

Global Search
Select Enable Global Search to allow users to search for content outside
their personal library.

Modeling Service

To share sessions between MicroStrategy Library and the MicroStrategy

Modeling service, ensure the secret key in MicroStrategy Library's Security
Settings section matches the secret key in the MicroStrategy Modeling
service.

For more information on how to configure the secret key in the Modeling
service, see Modeling Service Configuration Properties.

Connection Method

This setting allows the administrator to manage the default approach of how
the Library server locates the Modeling services.

l Auto-discovery: Allows the Library server to automatically locate the

Modeling service and set up the connection using Consul and/or the
connected Intelligence Service by default. (Recommended)

Copyright © 2021 All Rights Reserved 231

In st allat io n an d Co n figu r at io n Gu id e

l Specified URLs: Allows the Library server to refer to the specified URL
path to locate the Modeling service and set up the connection. If it fails, it
falls back to Auto-discovery.

Any changes to this section only impact new user sessions. Existing user
sessions must be logged out and then logged back in.

Enable TLS

Enable this option if the Modeling service is HTTPS enabled, but with a
private Root CA certificate or self-signed certificate. In this case, a
trustStore file and its password must be configured within
configOverride.properties. For a Modeling service that is HTTPS enabled
with a public Root CA certificate, disable this option.

For more information on how to set up the HTTPS connection between the
Library server and the Modeling service, see Configure HTTPS Connection
Between Library Server and Modeling Service.

Intelligence Server Tab

The Intelligence server tab allows the administrator to manage the
Intelligence server Machine information.

Copyright © 2021 All Rights Reserved 232

In st allat io n an d Co n figu r at io n Gu id e

It includes the following sections:

l Intelligence Server Machine Information

This section allows for the input of Machine name and Port Number for the
Intelligence server.

l Intelligence Server Connection Settings

The Intelligence server Connection Settings tab allows the administrator to

configure the following parameters:

l Initial Pool Size

l Maximum Pool Size
l Request Timeout (socket connection request timeout is in milliseconds
for the Intelligence server)
l Working Set Size (indicates the number of recent reports or documents
in memory for manipulation)
l Search Working Set Size (Indicates the maximum number of concurrent
searches which stay in memory)

Copyright © 2021 All Rights Reserved 233

In st allat io n an d Co n figu r at io n Gu id e

Collaboration Server Tab

This tab displays the server URL and that state of the Collaboration server
machine. It also allows the administrator to update the following settings for
the Collaboration server that is currently connected:

l Enable Comments or Discussions

l Enable TLS

l Enable Logging

l Trusted Certificate Setting

To access this section, the communication between the Library server and
the Collaboration server needs to be established first: no errors or warnings
from the Library server to the Collaboration server on the overview page.

Manage Collaboration Panel Features

Manage how your users interact with Collaboration and messaging. This
setting allows you to enable or disable the Comments or Discussions panel
for end users.

You can choose to show Comments only, Discussions only, or hide the
Collaboration panel entirely across the environment. To do this, you can use
the checkboxes or the toggle to easily turn off functionality globally. Once
making new selections in Library Admin, end users will see the changes
immediately.

Copyright © 2021 All Rights Reserved 234

In st allat io n an d Co n figu r at io n Gu id e

Collaboration Server Setting

Enable Logging

This setting can enable or disable diagnostic logging functionality in the

Collaboration server.

Enable TLS

Selecting this setting requires a keystore path and a passphrase.

Any changes to this section require the administrator to restart the

Collaboration server manually. Related warnings appear on this page until
the restart is complete.

Trusted Certificate Setting

This section is only visible when the Collaboration server targets a TLS
enabled Library server.

Copyright © 2021 All Rights Reserved 235

In st allat io n an d Co n figu r at io n Gu id e

Mobile Configuration Tab

The Mobile Configuration tab provides the ability to configure a dossier or
document as the home screen in Library Mobile. This allows the organization
to enhance and personalize the overall Library workflow for their end users.

The panel includes the option to create a new configuration.

When creating a new mobile configuration, administrators can customize the

following:

l Create a name and description for the new configuration

l Select a dossier or document to set as the home screen of Library
l Configure Advanced Settings
l Access: Enable access preferences, advanced settings, or set
automatic configuration updates
l Connectivity: Specify a time for network timeout
l Logging: Select the maximum log size and logging level
l Cache: Choose to clear caches on logout

Learn how to edit Library settings in MicroStrategy Workstation.

Copyright © 2021 All Rights Reserved 236

In st allat io n an d Co n figu r at io n Gu id e

Installing MicroStrategy Library on Windows

Perform the following steps to install MicroStrategy Library on a Windows
server.

1. Run the MicroStrategy installer by clicking the setup.exe application

from the extracted zip file.
2. To install the MicroStrategy Library components, select the following
features when prompted.
l MicroStrategy Library
l MicroStrategy Library Web & Mobile
l MicroStrategy Collaboration Server

3. Click Next

If the install does not complete successfully, review the install.log file for
errors. The log file is located in the MicroStrategy Common Files directory
C:\Program Files (x86)\Common
Files\MicroStrategy\install.log.

Copyright © 2021 All Rights Reserved 237

In st allat io n an d Co n figu r at io n Gu id e

Deployment Scenarios
After the installation of the MicroStrategy Library, applicable default
deployment will be performed automatically. You may need to further
configure the MicroStrategy Library Web/Mobile Server and MicroStrategy
Collaboration server, depending on your environment and requirements. The
following sections describe different deployment scenarios:

Diagrams in the following sections include the following MicroStrategy

components:

l Library Web application

A single page application (SPA) that runs inside a web browser. It is

populated by an initial connection to the MicroStrategy Library server.

l Library Mobile application

A native mobile application that interacts with the same MicroStrategy

Library server.

l MicroStrategy Library server

A Java-based HTTP web service that handles request for data from the
MicroStrategy Library Web, MicroStrategy Mobile, and Workstation
applications.

l MicroStrategy Collaboration server

A Node.js application that establishes a persistent Web Socket connection

with the MicroStrategy Library Web/Mobile application. It interacts with a
Collaboration server repository to persist collaboration data and with the
MicroStrategy Library server as well.

l MicroStrategy Intelligence Server

A native OS application that handles all requests the metadata repository

and Data Warehouse transactions.

Copyright © 2021 All Rights Reserved 238

In st allat io n an d Co n figu r at io n Gu id e

Default Windows Deployment

Default Product Folders

l C:\Program Files (x86)\MicroStrategy\Library
l C:\Program Files (x86)\MicroStrategy\Collaboration
Server
l C:\Program Files (x86)\Common
Files\MicroStrategy\Tomcat\apache-tomcat-
x.x.x\webapps\MicroStrategyLibrary

Default Registered Windows Services

l Library server: Apache Tomcat 9.0 Tomcat9
l Collaboration server repository: MicroStrategy Repository
l Collaboration server: MicroStrategy Collaboration server

MicroStrategy Library Server Configuration File

The MicroStrategy Library server reads configuration settings from the file
configOverride.properties. It also provides default values for the
configuration in the file configDefaults.properties. The file
configDefaults.properties contains a key-value pair of configuration
options. To specify a configuration option, the desired key can be copied
from the configDefaults.properties and saved into
configOverride.properties with a value. For default deployment, the
two files are located in:

l C:\Program Files (x86)\Common

Files\MicroStrategy\Tomcat\apache-tomcat-
x.x.x\webapps\MicroStrategyLibrary\WEB-
INF\classes\config\configDefault.properties

Copyright © 2021 All Rights Reserved 239

In st allat io n an d Co n figu r at io n Gu id e

l C:\Program Files (x86)\Common

Files\MicroStrategy\Tomcat\apache-tomcat-
x.x.x\webapps\MicroStrategyLibrary\WEB-
INF\classes\config\configOverride.properties

If MicroStrategy Library is installed separately from the Intelligence server,

you need to manually configure the connection information by modifying the
file configOverride.properties. These are also the minimum values
which should be specified in configOverride.properties:

l iserver.default.hostname= <host or IP address of

Intelligence server>
l iserver.default.port= <Intelligence server Port>

If the MicroStrategy Collaboration server is configured, and the file

configOverride.properties is being manually set, the following
configuration properties need to be specified:

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 it

may cause issues when migrating or upgrading an environment.

If the MicroStrategy Collaboration server is installed separately from the

MicroStrategy Library, you need to manually configure the connection
information for Collaboration server as well, by modifying configuration
property file located in: C:\Program Files
(x86)\MicroStrategy\Collaboration
Server\MicroStrategy\Collaboration Server\config.json.

Copyright © 2021 All Rights Reserved 240

In st allat io n an d Co n figu r at io n Gu id e

The property needs to be specified: 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 be

started.

The following diagram shows the default deployment:

The communication between components is HTTP, not HTTPS. This

deployment is useful for initial testing in a lab environment, but not
recommended for production. For a production environment, where security
is a priority, it is recommended to implement a secure deployment.

Copyright © 2021 All Rights Reserved 241

In st allat io n an d Co n figu r at io n Gu id e

Windows Secure Deployment

A secure deployment is strongly recommended. In a secure deployment
scenario, you add HTTPS/TLS support to the Library application. The server
processes will remain on the same machine, but will communicate with each
other through a secure channel.

The following diagram shows the secure deployment:

Perform the following procedure to enable secure communication between

the Library applications and services on a Windows server. These
instructions assume that a default deployment has already been completed,
and Intelligence server has already been TLS enabled.

Copyright © 2021 All Rights Reserved 242

In st allat io n an d Co n figu r at io n Gu id e

Prepare Files for Secure Deploym ent

Contact your system administrator to obtain the following files and

information:

l A “key store” file in PKCS12 or PFX format which contains the private key
and the public certificate for this machine. In the example this file is saved
as keystore.pfx

Use this same file for both Collaboration server and Tomcat.

The Collaboration server only supports PKCS12 or PFX format.

l The passphrase used to create the key store file.

The passphrase is needed to read the contents of the key store. In the
example, the passphrase is "keystore_password".

l If the server certificate is not signed by a public certificate authority, then

collect the Root CA certificate in the chain. The 'certificate' file allows
Collaboration server to open a secure connection to the Library server.
l A “trust store” file (that can be created from the certificates) and the
passphrase used.

The trust store file is used by the Library server to open a secure
connection to the Collaboration server.

This is only required if the certificate is not signed by a public certificate

authority.

In the example, the file is saved as truststore.pfx and the

passphrase is "truststore_password".

Copy the files obtained in step 1 into the following directory:

C:\Program Files (x86)\MicroStrategy\Collaboration Server

Copyright © 2021 All Rights Reserved 243

In st allat io n an d Co n figu r at io n Gu id e

Set Up Secure JEE App Server

Configure Tomcat to use HTTPS to configure Tomcat to be a secure

endpoint:

1. Open the following directory:

C:\Program Files (x86)\Common

Files\MicroStrategy\Tomcat\apache-tomcat-9.0.12\conf

2. Open the server.xml file with a text editor.

3. Look for the Connector element whose port is 8443. Ensure it is not
commented out. If Connector doesn't exist, add it.

4. Edit the 'keystoreFile' and 'keystorePass' attributes of this element.

<Connector
protocol="org.apache.coyote.http11.Http11NioProtocol"
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 file.

You can refer to more detailed instruction from Tomcat documentation.

Set Up Secure MicroStrategy Library Server

Modify the MicroStrategy Library server settings to open a secure

connection to the Collaboration server:

1. Navigate to the following directory:

C:\Program Files (x86)\Common

Files\MicroStrategy\Tomcat\apache-tomcat-

Copyright © 2021 All Rights Reserved 244

In st allat io n an d Co n figu r at io n Gu id e

9.0.12\webapps\MicroStrategyLibrary\WEB-
INF\classes\config

2. Edit configOverride.properties file:

services.collaboration.baseURL=https://<FQDN>:3000

// set tlsEnabled to true only when the certificate

is not assigned by a public certificate authority

services.collaboration.tlsEnabled=true

trustStore.path=\WEB-INF\truststore.pfx

trustStore.passphrase=<truststore_password>

All parameters are case sensitive. Read the instructions in

MicroStrategy Library Server Configuration Properties for more
information.

3. Save and close the file.

4. Restart Tomcat Server.

5. Verify that the MicroStrategy Library server is running:

l Open a web browser and enter

https://FQDN:8443/MicroStrategyLibrary

l If you see login page, then MicroStrategy Library server is working.

Set Up Secure Collaboration Server

Modify the Collaboration server settings:

1. Edit the config.json file located in:

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

Server

Copyright © 2021 All Rights Reserved 245

In st allat io n an d Co n figu r at io n Gu id e

2. Insert the following lines into the file. These reference the security
artifacts we created earlier.

"enableTls": true,

"keystoreFile": "C:/Program Files

(x86)/MicroStrategy/Collaboration
Server/keystore.pfx",

"passphrase": "<keystore_passphrase>",

"trustedCerts": [ "C:/Program Files

(x86)/MicroStrategy/Collaboration
Server/certificate.pem" ]

All parameters are case sensitive. Read the instructions

inCollaboration Server Configuration Properties for more information.

3. Modify the authorizationServerUrl field in the config.json file

to specify “https” , the HTTPS port (8443) and replace “localhost” with
the fully qualified domain name (FQDN) for this machine.

It should look like the following:

authorizationServerUrl:
https://<FQDN>:8443/MicroStrategyLibrary/api

4. Make sure the file is still valid JSON. Copy the text into an Internet
JSON validator to verify.

5. Save the file.

6. Restart the Collaboration server.

7. Verify that the Collaboration server is running:

Copyright © 2021 All Rights Reserved 246

In st allat io n an d Co n figu r at io n Gu id e

l Open a web browser and enter https://FQDN:3000/status

l If you see a web page (with no errors), then Collaboration server is

working.

Note the following:

l JEE App Server – key store

This is used to establish the identity of the JEE App Server, which houses
the MicroStrategy Library server. This is changed in a system
configuration file. 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

server for outgoing HTTPS/TLS calls when the Server certificate is not
signed by a public certificate authority. The trust store is configured in the
configOverride.properties file.

l MicroStrategy Collaboration server – key store / certificate

The key store is used for trusted communication between the Library
Web/Mobile Client and the Collaboration server. The certificate is used to
verify the identity of the Library server. The key store and certificates are
configured in the config.json file.

Manually Deploy Library on a Windows Server

Collaboration Server Setup

If MicroStrategy Library Web is going to utilize collaborating features,

perform the following steps to manually configure the Collaboration server.

1. Browse to the Collaboration server installation directory and open the

config.json file.

Copyright © 2021 All Rights Reserved 247

In st allat io n an d Co n figu r at io n Gu id e

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

Server

2. Edit the config.json file in the following format:

{
"port": <COLLAB_SERVER_PORT>
"dburl": "mongodb://{MONGODB_USERNAME}:{MONGODB_PASSWORD}@{MONGODB_
HOSTNAME}:${MONGODB_PORT}/{MONGODB_DB_NAME}?authSource=admin",
"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_HOSTNAME}:{LIBRARY_
PORT}/MicroStrategyLibrary/api",
"secretKey": "SOME SECRET KEY"
}

You may need to configure more settings in the config.json file.

See Configuring Collaboration Server for more information.

3. Restart Collaboration server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to verify.

Deploy Library Web App

The following steps assume Tomcat service has been started.

1. Open <TOMCAT_INSTALLATION_DIRECTORY>\webapps, and paste

the copied MicroStrategyLibrary.war file.
2. Once the MicroStrategyLibrary folder is created, access the
Library Administration control panel:

{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary/admin
with Tomcat administrator credentials.

3. In the Library Server panel, under Security Settings, create a 'secret

key'.

4. Configure Library server, Intelligence server, and Collaboration server

connections.

Copyright © 2021 All Rights Reserved 248

In st allat io n an d Co n figu r at io n Gu id e

5. Restart Tomcat service, and access

{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary to verify.

Configure Logging for Windows Deployment

For default deployment, log files are located in the following default
locations:

l Install 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 Collaboration server log: C:\Program Files (x86)\Common
Files\MicroStrategy\Log\collabsrvr_nodejs.log

Collaboration Server Advanced Logging

To enable Collaboration server advanced logging for troubleshooting
purposes:

1. Set the logging field to true in the config.json file in C:\Program

Files (x86)\MicroStrategy\Collaboration Server
2. Restart the service using the Services application in the Control panel.

Be sure to turn off the advanced logging after troubleshooting.

Installing MicroStrategy Library on Linux

1. Run the MicroStrategy installer:

Choose the setup.sh application from the extracted zip file.

Copyright © 2021 All Rights Reserved 249

In st allat io n an d Co n figu r at io n Gu id e

2. Follow the instruction in the installation wizard:

To install the MicroStrategy Library components, select the following

features when prompted:

l MicroStrategy Library
l MicroStrategy Library Web & Mobile
l MicroStrategy Collaboration Server

3. Click Next.
4. After selecting components to install, specify the Apache Tomcat
Directory, for example:

Copyright © 2021 All Rights Reserved 250

In st allat io n an d Co n figu r at io n Gu id e

If the install does not complete successfully, review the install.log file for
errors. The log file is located in <HOME_PATH>/log/install.log.

Deployment Scenarios
After the installation of the MicroStrategy Library, applicable default
deployment will be performed automatically. You may need to further
configure the MicroStrategy Library Web/Mobile Server and MicroStrategy
Collaboration server, depending on your environment and requirements. The
following sections describe different deployment scenarios:

Diagrams in the following sections include the following MicroStrategy

components:

l Library Web application

A single page application (SPA) that runs inside a web browser. It is

populated by an initial connection to the MicroStrategy Library Server.

Copyright © 2021 All Rights Reserved 251

In st allat io n an d Co n figu r at io n Gu id e

l Library Mobile application

A native mobile application that interacts with the same MicroStrategy

Library Server.

l MicroStrategy Library Server

A Java-based HTTP web service that handles request for data from the
MicroStrategy Library Web, MicroStrategy Mobile, and Workstation
applications.

l MicroStrategy Collaboration Server

A Node.js application that establishes a persistent Web Socket connection

with the MicroStrategy Library Web/Mobile application. It interacts with a
Collaboration Server repository to persist collaboration data and with the
MicroStrategy Library Server as well.

l MicroStrategy Intelligence Server

A native OS application that handles all requests the metadata repository

and 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

Copyright © 2021 All Rights Reserved 252

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Library Server Configuration Files

The MicroStrategy Library server reads configuration settings from the file
configOverride.properties. It also provides default values for the
configuration in the file configDefaults.properties. The file
configDefaults.properties contains a key-value pair of configuration
options. To specify a configuration option, the desired key can be copied
from the configDefaults.properties and saved into
configOverride.properties with a value. For default deployment, the
two files are located in:

l <TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/config/configDefault.properties
l <TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/config/configOverride.properties

If MicroStrategy Library is installed separately from the Intelligence server,

you need to manually configure the connection information by modifying the
file configOverride.properties. These are also the minimum values
which should be specified in configOverride.properties:

l iserver.default.hostname= <host or IP address of

Intelligence server>
l iserver.default.port= <Intelligence server Port>

If the MicroStrategy Collaboration server is configured, and the

configOverride.properties is being manually set, the following
configuration properties need to be specified:

l services.collaboration.enabled=true
l services.collaboration.baseURL= <
{PROTOCOL://HOSTNAME:PORT} The URL path to the
Collaboration server>

Copyright © 2021 All Rights Reserved 253

In st allat io n an d Co n figu r at io n Gu id e

l identityToken.secretKey= <Secret Key phrase (spaces

allowed) for Signing web token>

The configDefaults.properties should never be altered because it

may cause issues when migrating or upgrading an environment.

If the MicroStrategy Collaboration server is installed separately from the

MicroStrategy Library, you need to manually configure the connection
information by modifying configuration property file located in <INSTALL_
PATH>/CollaborationServer/config.json.

The property needs to be specified: 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 be

started.

The following diagram shows the default deployment:

Copyright © 2021 All Rights Reserved 254

In st allat io n an d Co n figu r at io n Gu id e

The communication between components is HTTP, not HTTPS. This

deployment is useful for initial testing in a lab environment, but not
recommended for production. For a production environment, where security
is a priority, it is recommended to implement a secure deployment.

Linux Secure Deployment

A secure deployment is strongly recommended. In a secure deployment
scenario, you add HTTPS/TLS support to the Library application. The server
processes will remain on the same machine, but will communicate with each
other through a secure channel.

Copyright © 2021 All Rights Reserved 255

In st allat io n an d Co n figu r at io n Gu id e

Perform the following procedure to enable secure communication between

the Library applications and services on a Windows server. These
instructions assume that a default deployment has already been completed,
and Intelligence server has already been TLS enabled.

Prepare Files for Secure Deploym ent

Contact your system administrator to obtain the following files and

information:

l A “key store” file in PKCS12 or PFX format which contains the private key
and the public certificate for this machine. In the example this file is saved
as keystore.pfx

Use this same file for both Collaboration server and Tomcat.

The Collaboration server only supports PKCS12 or PFX format.

Copyright © 2021 All Rights Reserved 256

In st allat io n an d Co n figu r at io n Gu id e

l The passphrase used to create the key store file.

The passphrase is needed to read the contents of the key store. In the
example, the passphrase is "keystore_password".

l If the server/leaf certificate is not ultimately signed by a public certificate

authority then collect all of the certificates in PEM format. This should
include all certificates in the chain. The 'certificate' file allows
Collaboration server to open a secure connection to the Library server.

l A “trust store” file (that can be created from the certificates) and the
passphrase used.

The trust store file is used by the Library server to open a secure
connection to the Collaboration server.

This is only required if the certificate is not signed by a public certificate

authority.

In the example, the file is saved as truststore.pfx and the

passphrase is "truststore_password".

Copy the files obtained in step 1 into the following directory:

<INSTALL_PATH>/CollaborationServer

Set Up Secure JEE App Server

Configure Tomcat to use HTTPS to configure Tomcat to be a secure

endpoint:

1. Open the following directory:

<TOMCAT_INSTALL_DIRECTORY>/conf

2. Open the server.xml file with a text editor.

3. Look for the Connector element whose port is 8443. Ensure it is not
commented out. If Connector doesn't exist, add it.

Copyright © 2021 All Rights Reserved 257

In st allat io n an d Co n figu r at io n Gu id e

4. Edit the 'keystoreFile' and 'keystorePass' attributes of this element.

<Connector
protocol="org.apache.coyote.http11.Http11NioProtocol"
port="8443" maxThreads="200" scheme="https"
secure="true" SSLEnabled="true"
keystoreFile="<INSTALL_
PATH>/CollaborationServer/keystore.pfx"
keystorePass="<keystore_passphrase>"
clientAuth="false" sslProtocol="TLS"/>

5. Save and close the file.

You can refer to more detailed instruction from Tomcat documentation.

Set Up Secure MicroStrategy Library Server

Modify the MicroStrategy Library server settings to open a secure

connection to the Collaboration server:

1. Navigate to the following directory:

<TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/config

2. Edit configOverride.properties file:

services.collaboration.baseURL=https://<FQDN>:3000

// set tlsEnabled to true only when the certificate

is not assigned by a public certificate authority

services.collaboration.tlsEnabled=true

trustStore.path=\WEB-INF\truststore.pfx

trustStore.passphrase=<truststore_password>

Copyright © 2021 All Rights Reserved 258

In st allat io n an d Co n figu r at io n Gu id e

All parameters are case sensitive. Read the instructions in

Collaboration Server Configuration Properties for more information.

3. Save and close the file.

4. Restart Tomcat Server.

5. Verify that the MicroStrategy Library server is running:

l Open a web browser and enter

https://FQDN:8443/MicroStrategyLibrary

l If you see login page, then MicroStrategy Library server is working.

Set Up Secure Collaboration Server

Modify the Collaboration server settings:

1. Edit the config.json file located in:

<INSTALL_PATH>/CollaborationServer

2. Insert the following lines into the file. These reference the security
artifacts we created earlier.

"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 in

Collaboration Server Configuration Properties for more information.

3. Modify the authorizationServerUrl field in the config.json file

to specify “https” , the HTTPS port (8443) and replace “localhost” with

Copyright © 2021 All Rights Reserved 259

In st allat io n an d Co n figu r at io n Gu id e

the fully qualified domain name (FQDN) for this machine.

It should look like the following:

authorizationServerUrl:
https://<FQDN>:8443/MicroStrategyLibrary/api

4. Make sure the file is still valid JSON. Copy the text into an Internet
JSON validator to verify.

5. Save the file.

6. Restart the Collaboration server.

7. Verify that the Collaboration server is running:

l Open a web browser and enter https://FQDN:3000/status

l If you see a web page (with no errors), then Collaboration server is

working.

Note the following:

l JEE App Server – key store

This is used to establish the identity of the JEE App Server, which houses
the MicroStrategy Library server. This is changed in a system
configuration file. 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

server for outgoing HTTPS/TLS calls when the Server certificate is not
signed by a public certificate authority. The trust store is configured in the
configOverride.properties file.

l MicroStrategy Collaboration server – key store / certificate

The key store is used for trusted communication between the Library
Web/Mobile Client and the Collaboration server. The certificate is used to

Copyright © 2021 All Rights Reserved 260

In st allat io n an d Co n figu r at io n Gu id e

verify the identity of the Library server. The key store and certificates are
configured in the config.json file.

Manually Deploy Library on a Linux Server

Collaboration Server Setup

If MicroStrategy Library Web is going to utilize collaborating features,

perform the following steps to manually configure the Collaboration server.

1. Browse to the Collaboration server installation directory and open the

config.json file.

{INSTALL_PATH}/CollaborationServer

2. Edit the config.json file in the following format:

{
"port": <COLLAB_SERVER_PORT>
"dburl": "mongodb://{MONGODB_USERNAME}:{MONGODB_PASSWORD}@{MONGODB_
HOSTNAME}:${MONGODB_PORT}/{MONGODB_DB_NAME}?authSource=admin",
"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_HOSTNAME}:{LIBRARY_
PORT}/MicroStrategyLibrary/api",
"secretKey": "SOME SECRET KEY"
}

You may need to configure more settings in the config.json file.

See Configuring Collaboration Server for more information.

3. Restart Collaboration server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to verify.

Deploy Library Web App

The following steps assume Tomcat service has been started.

Copyright © 2021 All Rights Reserved 261

In st allat io n an d Co n figu r at io n Gu id e

1. Open <TOMCAT_INSTALLATION_DIRECTORY>/webapps, and paste

the copied MicroStrategyLibrary.war file.
2. Once the MicroStrategyLibrary folder is created, access Library
Administration Control Panel:

{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary/admin
with Tomcat administrator credentials.

3. In the Library Server Panel, under Security Settings, create a 'secret

key'.
4. Configure Library Server, Intelligence Server, and Collaboration Server
connections.
5. Restart Tomcat service, and access
{PROTOCOL}://<FQDN>:<port>/MicroStrategyLibrary to verify.

Configure Logging for Linux Deployment

Log files are located in the following default locations:

l Install log: <HOME_PATH>/log/install.log

l Library server log: <HOME_PATH>/log/MicroStrategyLibrary-
MicroStrategyLibrary.log
l Collaboration server log: <HOME_PATH>/log/collabsvr_nodejs.log

Collaboration Server Advanced Logging

To enable Collaboration server advanced logging for troubleshooting
purposes:

1. Set the logging field to true in the config.json file in <INSTALL_

PATH>/CollaborationServer/config.json.
2. Restart the service using collaborationServer.sh restart.

Be sure to turn off the advanced logging after troubleshooting.

Copyright © 2021 All Rights Reserved 262

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Library Server Configuration Properties

The configOverride.properties is located in:

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

Files\MicroStrategy\Tomcat\apache-tomcat-
x.x.xx\webapps\MicroStrategyLibrary\WEB-
INF\classes\config\configOverride.properties

Linux: <TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/config/configOverride.properties

This file includes the following properties:

Property Specifies

Authentication Mode Settings

The number of different authentication modes

exposed through the UI. Use commas to separate
multiple values.

l 1: I-Server Standard authentication

l 8: I- Server Guest Authentication
auth.modes.available l 16: I-Server LDAP authentication
l 64: I- Server Security Plugin Authentication
(Trusted)
l 128: Kerberos Authentication
l 1048576: SAML Authentication

l 4194304: OIDC Authentication

Which of the "available" modes (listed above) is

auth.modes.default
shown first (default).

When Trusted authentication is selected as available

auth.trusted.provider or default authentication mode, a provider of this
authentication must be chosen.

Copyright © 2021 All Rights Reserved 263

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

l 1: Tivoli
l 2: SiteMinder
l 3: Custom
l 4: OracleAccessManager
l 6: Ping

Intelligence Server Configuration

The hostname of the Intelligence server to connect

iserver.default.hostname to.

Default: NONE (must provide value)

The port of the Intelligence server to use.

iserver.default.port
Default: NONE (must provide value)

The initial pool size of HTTP(S) connection threads

iserver.initialPoolSize
Default: 10

The pool size of maximum allowed HTTP(S)

iserver.maxPoolSize connection threads

Default: 100

Socket connection timeout in milliseconds for I-

iserver.requestTimeout Server request

Default: 120000

Set to true if Intelligence server is TLS enabled but

with a private Root CA certificate or a self-signed
certificate. In this case, a trustStore file and its
iserver.tlsEnabled password must be provided For Intelligence server
that is TLS enabled with a public Root CA
certificate, set to false.

Default: false

Collaboration Server Configuration

services.collaboration.enabled Whether the Collaboration server is enabled

Copyright © 2021 All Rights Reserved 264

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

Default: false

The URL path to the Collaboration server

services.collaboration.baseURL
Default: NONE

Set to true if Collaboration server is TLS enabled but

with a private Root CA certificate or a self-signed
certificate. In this case, a trustStore file and its
services.collaboration.tlsEnabled password must be provided For Collaboration server
that is TLS enabled with a public Root CA
certificate, set to false.

Default: false

Modeling Service Configuration

services.MicroStrategy-Modeling- The URL path to the Modeling service.

Service.baseURL Default: NONE

Once enabled, the status of the modeling service

services.MicroStrategy-Modeling- cluster is refreshed every 30 seconds.
Service.scheduleEnabled
Default: true

Set to true if the Modeling service is HTTPS

enabled, but with a private Root CA certificate or
self-signed certificate. In this case, a trustStore file
services.MicroStrategy-Modeling- and its password must be provided. For a Modeling
Service.tlsEnabled service that is HTTPS enabled with a public Root CA
certificate, set to false.

Default: false

IdentityToken Configuration

Allow services such as Collaboration server or

Modeling service to validate user session.
identityToken.secretKey
Secret key phrase (spaces allowed) for signing web
token.

Copyright © 2021 All Rights Reserved 265

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

Default: NONE (must provide value)

Token Algorithm
identityToken.algorithm
Default: HS512

Time to live for token in seconds.

identityToken.timeToLiveSeconds
Default: 300

SSL/TLS Configuration

If Intelligence server, Collaboration server, and/or

Modeling service is TLS enabled but with a private
Root CA certificate or self-signed certificate, a trust
store file is required.

The relative path (inside the WAR file) to the Trust

Store file.

Also, supports Optional prefix classpath: (for a

class path resource) or file: (for an absolute
path):

l Example (Relative path):

trustStore.path=/WEB-
trustStore.path
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

The passphrase used in the construction of the Trust

trustStore.passphrase
Store file

Copyright © 2021 All Rights Reserved 266

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

Default: NONE

Server Configuration

The number of recent reports/documents kept in

memory for manipulation. Will apply to all users who
session.workingSet connect to the server

Default: 10

The maximum number of concurrent searches which

stay in memory. Will apply to all users who connect
session.searchWorkingSet to the server

Default: 3

Web/Mobile Server Properties

The relative path to Mobile resources (inside the

mobile.configuration.folder WAR file)

Default: NONE

Exclude the list of custom plugin folder to not load

customCss.excludePlugins the custom css files. This property will take a list of
comma-separated customization plugin names.

Specifies valid parents domain origin that may be

using dossier embedded analytics. If set to true, all
security.allowAllOrigins the origin will be allowed. This is not recommended.

Specifies valid parents domain origin that may be

using dossier embedded analytics. The list of
allowed origins will be appended to Content-
security.allowedOrigins Security-Policy=frame-ancestors. The request URLs
affected by these constraints are defined in the
GlobalHeaders filter of the web.xml

Copyright © 2021 All Rights Reserved 267

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

Configures whether or not to allow HTML on the

security.userInput.allowHtmlOnPro prompt tile and description.
mptDesc

The configuration file location.

auth.kerberos.config

The host keytab location.

auth.kerberos.keytab

Host Service Principal Name (SPN)

auth.kerberos.principal

{True/false] miscellaneous options

auth.kerberos.islnitiator

Configures whether to override the unhandled

security.error.overridelserverError iserver error message with the
Message customErrorMessage.

Configuring Collaboration Server

Collaboration Server Configuration Properties

Settings for the Collaboration server can be changed by editing the
config.json file. All parameters are case sensitive and must be entered
correctly for changes to take effect.

The config.json can be found in:

Windows: <INSTALL_PATH>\MicroStrategy\Collaboration Server

Copyright © 2021 All Rights Reserved 268

In st allat io n an d Co n figu r at io n Gu id e

Linux: <INSTALL_PATH>/CollaborationServer

This file includes the following properties:

Property Specifies

Port and URL Properties

port The communication port number

The dataSource object includes the following properties:

l username = the username to connect to Postgres

l password = the encrypted password to connect to Postgres
l host = this parameter specifies the IP or hostname of a
remote Postgres server. By default, the Collaboration server
tries to connect to the local Postgres server.
l port = this parameter specifies the port of the Postgres
server. By default, the Collaboration server tries to connect
to the 5432 port of the Postgres server
dataSource l encryptionKeyFile = the file which includes the key to encrypt
or decrypt the password
l sslRootCertificate = this parameter specifies the path of a file
containing SSL certificate authority (CA). If the file exists, the
server's certificate will be verified to be signed by one of
these authorities
l sslClientCertFile = this parameter specifies the file location
of the client SSL certificate
l sslClientKeyFile = this parameter specifies the file location
for the secret key used for the client certificate

The URL endpoint of the MicroStrategy Library server. It should

authorizationServerUrl
end with /api.

The address of the Library server when generating email

notifications. This property is available starting in 2020 Update

notificationBaseUrl 2.

Use this property for certain authentication configurations, like

Trusted authentication, to store the address of the

Copyright © 2021 All Rights Reserved 269

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

authentication server. If this property is not set, the address in

authorizationServerUrl is used.

TLS Support Properties

Whether TLS support is enabled

If true, TLS support is enabled, assuming that either of the

following pairs of fields are specified:

l privateKeyFile and publicCertFile

enableTls l keystoreFile and passphrase

The keystoreFile and passphrase properties have a higher

priority than the privateKeyFile and publicCertFile fields.

If omitted or false, then TLS support is disabled.

privateKeyFile The path to the private key.

publicCertFile The path to the public certificate.

keystoreFile The path to the PKCS12 or PFX keystore file.

passphrase The passphrase used in the Certificate Signing Request (CSR)

An array of paths (relative to the current directory) of trusted

certificate files.

This is only needed when Library server is in HTTPS but with a

trustedCerts private Root CA certificate or a self-signed certificate.

We do not need all certificates in the chain, but only the Root
CA certificate.

Each Root CA certificate needs to be in its own PEM file.

Clustering Properties

The type of scaling to use. Values include "horizontal",

scaling "vertical", and "none". If omitted scaling defaults to "vertical", if
"cpus" is greater than 1. Otherwise, it defaults to "none".

Copyright © 2021 All Rights Reserved 270

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

The URL of the Collaboration Cluster Cache (only supported

redisServerUrl
with Redis Server). Only required if scaling is horizontal.

The maximum number of worker processes to create on this

machine. A number greater than 0 specifies the number of
cpus
worker processes to create. A value of -1 indicates to create
one worker process for each core on the machine. Defaults to 1.

User and Group Cache Properties

A non-negative integer which specifies the interval (in minutes)

resetCacheInterval to reset the users and groups information cache. Using a value
of 0 applies the default time of 1440 minutes(24 hours).

General Configuration Properties

Whether diagnostic logging is enabled for the Collaboration

logging
server.

An object which holds socket.io settings. Can set pingInterval

socketlo and pingTimeout. { "pingInterval": 25000, "pingTimeout": 30000
}

Library Administration Support Properties

To establish trusted communication between Library server and

Collaboration server, the value should be the same as that of
secretKey identityToken.secretKey in the Library server configuration file.

This trusted communication is required for configuring the

Collaboration server from Library Admin.

If the MicroStrategy Collaboration server is installed separately from the

MicroStrategy Library, you need to manually configure the connection
information by modifying configuration property file config.json. See the

appropriate Manually Configure Collaboration Server on a Windows Server

Copyright © 2021 All Rights Reserved 271

In st allat io n an d Co n figu r at io n Gu id e

or Manually Configure Collaboration Server on a Linux Server section for

more information.

By default, the Library is accessed using the following URL and

communication port:

http://localhost:8080/MicroStrategyLibrary

By default, the Collaboration server is accessed using the following URL and
communication port:

http://localhost:3000

To check the status of the Collaboration server, you can visit this URL:

http://localhost:3000/status

This only works from the machine where the MicroStrategy Collaboration
server is installed. To access it from another machine, replace "localhost"
with the fully qualified domain name (FQDN) of the machine.

The communication port must be available for Collaboration server to be

started.

The communication between components is HTTP, not HTTPS. This

deployment is useful for initial testing in a lab environment, but not
recommended for production. For a production environment, where security
is a priority, it is recommended to implement a secure deployment.

Manually Configure Collaboration Server on a Linux Server

1. Browse to Collaboration Server installation directory {MSTR_INSTALL_
DIRECTORY}/CollaborationServer.

2. Edit the config.json file

"port": <Collaboration Server port number>

Copyright © 2021 All Rights Reserved 272

In st allat io n an d Co n figu r at io n Gu id e

"dburl": "mongodb://{MONGODB_USERNAME}:{MONGODB_
PASSWORD}@{MONGODB_HOSTNAME}:${MONGODB_PORT}/
{MONGODB_DB_NAME}?authSource=admin",

"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_
HOSTNAME}:{LIBRARY_PORT}/MicroStrategyLibrary/api"

3. Restart Collaboration Server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to verify.

Manually Configure Collaboration Server on a Windows Server

1. Browse to Collaboration Server installation directory {MSTR_INSTALL_
DIRECTORY}\CollaborationServer.

2. Edit the config.json file

"port": <Collaboration Server port number>

"dburl": "mongodb://{MONGODB_USERNAME}:{MONGODB_
PASSWORD}@{MONGODB_HOSTNAME}:${MONGODB_PORT}/
{MONGODB_DB_NAME}?authSource=admin",

"authorizationServerUrl": "{PROTOCOL}://{LIBRARY_
HOSTNAME}:{LIBRARY_PORT}/MicroStrategyLibrary/api"

3. Restart Collaboration Server, and access {PROTOCOL}://{COLLAB_

SERVER_HOSTNAME}:{COLLAB_SERVER_PORT}/status to verify.

Collaboration Server Command Line Administration Tool

MicroStrategy Collaboration server ships with its own command line
administration tool called admintool.js. This administration tool allows
users to search, view, and delete information in the Collaboration server
repository without directly interacting with the database.

Copyright © 2021 All Rights Reserved 273

In st allat io n an d Co n figu r at io n Gu id e

To invoke the Collaboration server admin tool, you need to run the Node.js
executable and supply the file path for the admin tool and the Collaboration
server configuration file.

The Node.js executable (node.exe) can be found here:

l Windows: <INSTALL_PATH>\Common
Files\MicroStrategy\nodejs\node.exe
l Linux: <INSTALL_PATH>/NodeJS/<NODEJS_LINUX_
VERSION>/bin/node

The admintool.js file can be found here:

l Windows: <INSTALL_PATH>\MicroStrategy\Collaboration
Server\node_modules\mstr-collab-svc\admintool.js
l Linux: <INSTALL_PATH>/CollaborationServer/node_
modules/mstr-collab-svc/admintool.js

The Collaboration server configuration file (config.json) can be found

here:

l Windows: <INSTALL_PATH>\MicroStrategy\Collaboration
Server\config.json
l Linux: <INSTALL_PATH>/CollaborationServer/config.json

Starting the Administration Tool

1. Open a terminal application.
2. Enter the three file locations in the following format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>" "<PATH_

TO_CONFIG_FILE>"

You can add the Node.js executable to your PATH variable and
change to the Collaboration Server directory. If so, you can enter:
$ node node_modules/mstr-collab-svc/admintool.js
config.json

Copyright © 2021 All Rights Reserved 274

In st allat io n an d Co n figu r at io n Gu id e

The welcome page is shown in console after the tool starts.

Welcome to the Collaboration Server Administration Tool

(v10.xx.x.xxx)

Type "help" to list the available commands.

cmd>

Command List
The Admin Tool recognizes the following commands:

Command Result

help Shows help page.

quit Exits the tool.

exit Exits the tool.

Shows a summary of
show summary
the database.

Shows information
about topic with a
specific ID. This ID
uniquely identifies the
show topic <ID>
topic. You can find the
ID by using the listing
show of a topic using one of
the other commands.

Shows information
show topics all
about all topics.

Shows information
about topics that have
show topics empty
no comments
associated with them.

Copyright © 2021 All Rights Reserved 275

In st allat io n an d Co n figu r at io n Gu id e

Command Result

Shows information
about topics that have
show topics non-empty
comments associated
with them.

Shows comments for a

show comments for-topic <ID>
specific topic.

Shows comments made

by specific user. The ID
refers to the
show comments for-user <ID> MicroStrategy User
DSS ID stored in
MicroStrategy
metadata.

Shows comments
associated with a
specific dossier (base
show comments for-dossier <ID>
document) ID stored in
MicroStrategy
metadata.

Shows comments
created before the
show comments older-than-date <ISO_
specified ISO 8601
DATE>
date. YYYY-MM-
DDThh:mm:ssTZ.

Drops all the topics that

drop topics empty have no comments
associated with them.

drop
drop comments all Drops all comments.

Drops comments for a

drop comments for-topic <ID>
specific topic.

drop comments for-user <ID> Drops comments for a

Copyright © 2021 All Rights Reserved 276

In st allat io n an d Co n figu r at io n Gu id e

Command Result

specific user.

Drops comments
associated with a
drop comments for-dossier <ID>
specific dossier (base
document).

Drops comments
drop comments older-than-date <ISO_
created before the
DATE>
specified ISO 8601 date

The stored comments are organized into separate topics for each
dossier page. Use the for-topic <ID> commands work with pages
and the for-dossier <ID> commands to work on the entire
document.

You can combine the conditions for show comments and drop
comments. When multiple conditions are used, all conditions must be
true to select the correct comments.

For example, drop comments for-user <UID> for-topic T

older-than-date 2018-01-01 will only drop comments that meet all
the three conditions.

There is no confirmation message for the drop command. Always show

the comments with the condition specified before you drop them to avoid
errors.

Customizing Collaboration Server Notification

To customize Collaboration server notifications, the administrator needs the
following files:

l config.json

This config.json is not the application-level configuration file.

Copyright © 2021 All Rights Reserved 277

In st allat io n an d Co n figu r at io n Gu id e

l email-Invite.template
l email-Mention.template

By default, they are located in these folders:

l Windows: <INSTALL_PATH>\MicroStrategy\Collaboration
Server\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 Invite (email-
Invite.template) and User Mention (email-Mention.template)
emails. They are written in HTML and CSS. The Administrator can modify
any item in the template or develop their own template based on these.

Configure Notifications – config.json

The config.json file is where Administrator can customize Collaboration
server notifications. Administrators can enable or disable notifications,
specify what email templates to use, and modify the email subject and
device type for push notifications.

config.json

{
"enabled": true,
"notification": {
"fromMention": {
"email": {
"enabled": true,
"templateFile": "email-Mention.template",
"subject": "You have been mentioned in a comment"
},
"push": {
"enabled": true,

Copyright © 2021 All Rights Reserved 278

In st allat io n an d Co n figu r at io n Gu id e

"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_DOSSIE
Library"
},
"push": {
"enabled": true,
"title": "You have been invited to view {{TEXT_DOSSIER_
Library",
"deviceType": "MOBILE"
}
}
}
}

Changing a Communication Port

Follow the instructions below to change a communication port:

l Collaboration server: To change the communication port for the

Collaboration server, change the port property in the config.json file
and restart the Collaboration server.

All parameters in the config.json file are case sensitive.

l Collaboration server repository: To change the communication port for

the PostgreSQL database, change the port in the dburl field of the
config.json file and restart the Collaboration server.

The config.json file can be found in the following directory:

Copyright © 2021 All Rights Reserved 279

In st allat io n an d Co n figu r at io n Gu id e

l Windows: <INSTALL_PATH>\MicroStrategy\Collaboration
Server
l Linux: <INSTALL_PATH>/CollaborationServer/config.json

Be sure to open the Collaboration server port in the firewall if you are
employing a firewall.

Cluster the MicroStrategy Collaboration Server

To efficiently increase the number of concurrent users that collaborate in the
MicroStrategy Library application, you can cluster the Collaboration Server.
The MicroStrategy Collaboration Service can be clustered both vertically
and horizontally, depending on your needs.

Vertical Collaboration Server Cluster

In a Vertical Cluster, a single machine with multiple cores hosts a single
Collaboration Server which, in turn, spawns multiple processes to distribute
the load in the server.

To cluster the collaboration vertically, you must have a machine with the
MicroStrategy Library and the MicroStrategy Collaboration Server installed.

Copyright © 2021 All Rights Reserved 280

In st allat io n an d Co n figu r at io n Gu id e

How to Cluster the Collaboration Server Vertically

1. Open the Library Administration Control Panel to verify your servers are
running.
2. From the Control Panel, select Collaboration Server.
3. Under Scaling Settings, select Vertical as the scaling type.
4. From the Number of workers drop-down, select the number of CPU
cores allocated to the server.
5. Click Save.
6. Restart the Collaboration Server.

Horizontal Collaboration Server Cluster

In an Horizontal Cluster of Collaboration Servers, multiple servers are
hosted on multiple nodes. You can create a functional horizontal cluster
configuration in several ways. One way to configure horizontally is by
replicating a single working node into multiple nodes under a load balancer.

In the diagram above, Node 1 and Node 2 represent machines in a network

that host the horizontal cluster of Collaboration Servers.

Copyright © 2021 All Rights Reserved 281

In st allat io n an d Co n figu r at io n Gu id e

Node 1 is obtained by performing a fresh installation of the MicroStrategy

Platform, so it contains the MicroStrategy Library application, the
Collaboration Server, and the Intelligence Server.

Node 2 can also be obtained by performing an installation of the

MicroStrategy Platform, but it is configured so the MicroStrategy Library
application points to the Intelligence Server in Node 1 and the Collaboration
Server points to the Collaborations Stores in Node 1. Both Nodes operate
with the same data.

Lastly, both nodes are configured under a load balancer to provide clients
with a single entry point to the cluster.

How to Cluster the Collaboration Server Horizontally

1. Install the MicroStrategy Platform on a single machine. This becomes

Node 1.

2. In the Library Administration Control Panel, a warning appears after

installing the MicroStrategy Platform indicating the Collaboration
Server is not configured to the Library Server. Click the warning icon

and select Yes.

3. Configure the load balancer on top of Node 1. This provides external
clients with a single entry point to the configuration.

Copyright © 2021 All Rights Reserved 282

In st allat io n an d Co n figu r at io n Gu id e

4. From the Control Panel navigation, select Collaboration Server.

5. Under Collaboration Store Settings, modify the Machine Information to
allow the Collaboration Server to utilize the Collaboration Cluster
Store.
6. Under Scaling Settings, select Horizontal as the scaling type and enter
your Cluster Cache.

7. Click Save.
8. Restart the Collaboration Server.
9. Install the MicroStrategy Platform on a new machine to introduce
additional nodes in the cluster. This becomes Node 2.
10. In Node 1, open WEB-INF/classes/config/configOverride.properties and
copy the values in the file. Paste the values in the
configOverride.properites file in Node 2. Click Save.
11. In Node 1, open MicroStrategy/Collaboration Server/config.json and
copy the values in the file. Paste the values in the config.json file in
Node 2. Click Save.

Copyright © 2021 All Rights Reserved 283

In st allat io n an d Co n figu r at io n Gu id e

12. Restart the Collaboration Server.

13. In the load balancer's configuration file, add the Collaboration Server
and Library Server of Node 2. The load balancer now redirects client
requests between Node 1 and Node 2.

To add more nodes to the configuration, repeat steps 9 through 13.

Copyright © 2021 All Rights Reserved 284

In st allat io n an d Co n figu r at io n Gu id e

14. Click Save.

See Troubleshooting Your MicroStrategy Library Installation if needed.

Migrating Notifications

MicroStrategy Collaboration has been enhanced to use a central data

repository installed as part of the MicroStrategy Platform. Starting in
MicroStrategy 2020 the Collaboration Server constructs the connection
string to the MicroStrategy Data Repository during runtime. After
performing the upgrade, Collaboration Server will only support
connections to the MicroStrategy Data Repository.

After upgrading Collaboration Server, the previous data repository

remains unchanged but it will not be used by the new version of
Collaboration Server. Any comments stored in the previous data
repository will need to be moved to the new repository to be accessible.

All data will remain in the MicroStrategy Data Repository after the data
migration.

Migrating Comments to the MicroStrategy Data Repository

The Collaboration Server Administration Tool provides a way for system
administrators to migrate comments from the previous data repository to
the new data repository. The Collaboration Administration Page will
display a warning message when it detects that a previous data
repository was used by the Collaboration Server before the upgrade.

The Collaboration Server Administration Tool is a console application

and will connect to the data repository using the same configuration as
the Collaboration Server so no user input is required to connect. The tool
will provide feedback as data is being migrated and will show a message
when the migration is complete.

Copyright © 2021 All Rights Reserved 285

In st allat io n an d Co n figu r at io n Gu id e

In order to recover collaboration messages that were stored in the

previous version of the MicroStrategy Platform please follow these
steps:

1. Click Start > Windows Administrative Tools > Services.

2. Stop the service MicroStrategy Collaboration/Realtime Service.

3. Start the service Mongo DB.

4. Run the Data Migration Command:

l Enter the three file locations in the following format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>"
"<PATH_TO_CONFIG_FILE>"

"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 Collaboration Server Administration Tool.

5. Stop the service Mongo DB.
6. Start the service MicroStrategy Collaboration/Realtime Service.

The Collaboration Admin Page will stop displaying the warning message
at this point.

MicroStrategy Collaboration has been enhanced to use a central data

repository installed as part of the MicroStrategy Platform. Starting in

Copyright © 2021 All Rights Reserved 286

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy 2020 the Collaboration Server constructs the connection

string to the MicroStrategy Data Repository during runtime. After
performing the upgrade, Collaboration Server will only support
connections to the MicroStrategy Data Repository.

After upgrading Collaboration Server, the previous data repository

remains unchanged but it will not be used by the new version of
Collaboration Server. Any comments stored in the previous data
repository will need to be moved to the new repository to be accessible.

All data will remain in the MicroStrategy Data Repository after the data
migration.

Migrating Comments to the MicroStrategy Data Repository

The Collaboration Server Administration Tool provides a way for system
administrators to migrate comments from the previous data repository to
the new data repository. The Collaboration Administration Page will
display a warning message when it detects that a previous data
repository was used by the Collaboration Server before the upgrade.

The Collaboration Server Administration Tool is a console application

and will connect to the data repository using the same configuration as
the Collaboration Server so no user input is required to connect. The tool
will provide feedback as data is being migrated and will show a message
when the migration is complete.

In order to recover collaboration messages that were stored in the

previous version of the MicroStrategy Platform please follow these
steps:

Copyright © 2021 All Rights Reserved 287

In st allat io n an d Co n figu r at io n Gu id e

1. Stop the Collaboration service:

cd
/opt/mstr/MicroStrategy/install/CollaborationServe
r/

./collaborationServer.sh stop

2. Start the previous data repository:

cd
/opt/mstr/MicroStrategy/install/CollaborationServe
r/MongoDB/

./mongod.sh start

3. Run the Data Migration Command:

l Enter the three file locations in the following format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>"
"<PATH_TO_CONFIG_FILE>"

/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 Collaboration Server Administration Tool.

4. Stop the service Mongo DB.
5. Start the service MicroStrategy Collaboration/Realtime Service.

The Collaboration Admin Page will stop displaying the warning message
at this point.

Copyright © 2021 All Rights Reserved 288

In st allat io n an d Co n figu r at io n Gu id e

Manually Upgrade the Collaboration Server Schema

To leverage collaboration functions, the schema of the Collaboration server
must be upgraded. The Collaboration server automatically checks and if
necessary, upgrades the schema. However, the upgrade may fail if the
following situations occur:

l The account for the Collaboration Store in config.json does not have
the appropriate privilege to modify table (e.g., Create table and Add
column).
l The connection between the Collaboration server and Collaboration Store
is broken (e.g., the Collaboration Store service is stopped).

In the case the automatic upgrade fails, you can manually upgrade the
schema.

1. Click Start > Windows Administrative Tools > Services.

2. Stop the MicroStrategy Collaboration/Realtime Service.
3. Ensure that the account for Collaboration Store in the
config.json file under the C:\Program Files
(x86)\MicroStrategy\Collaboration Server directory has
the appropriate privileges to modify tables.

4. Run the following command for the schema upgrade.

l Enter the three file locations in the following format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>" "<PATH_TO_CONFIG_

FILE>"

For example:

"C:\Program Files (x86)\Common

Files\MicroStrategy\nodejs\node.exe" "C:\Program Files
(x86)\MicroStrategy\Collaboration Server\node_modules\mstr-

Copyright © 2021 All Rights Reserved 289

In st allat io n an d Co n figu r at io n Gu id e

collab-svc\admintool.js" "C:\Program Files

(x86)\MicroStrategy\Collaboration Server\config.json"

l Use the upgrade command to run the schema upgrade:

cmd> upgrade

l Enter quit to close the Collaboration/Realtime Service.

5. Start the MicroStrategy Collaboration/Realtime Service.

1. Stop the MicroStrategy Collaboration/Realtime Service:

./collaborationServer.sh stop

2. Ensure that the account for Collaboration Store in the

config.json file under the
/opt/mstr/MicroStrategy/install/CollaborationServer
directory has the appropriate privileges to modify tables.

3. Run the following command for the schema upgrade.

l Enter the three file locations in the following format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>" "<PATH_TO_CONFIG_

FILE>"

For example:

/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 upgrade command to run the schema upgrade:

Copyright © 2021 All Rights Reserved 290

In st allat io n an d Co n figu r at io n Gu id e

cmd> upgrade

l Enter quit to close the Collaboration/Realtime Service.

4. Start the MicroStrategy Collaboration/Realtime Service:

./collaborationServer.sh start

Set Up Application Servers

The sections below provide instructions for setting up different application
servers to deploy MicroStrategy Library.

Deploy MicroStrategy Library on JBoss

Bef o r e Dep l o yi n g t h e M i cr o St r at egyLi b r ar y.w ar Fi l e:

Open /jboss-eap-
7.3/standalone/configuration/standalone.xml and search for
"jaxrs" and disable following lines:

<!--extension module="org.jboss.as.jaxrs"/-->

<!--subsystem xmlns="urn:jboss:domain:jaxrs:1.0"/-->

Dep l o y b y Exp l o d ed Fo l d er :

1. Unzip MicroStrategyLibrary.war file as a folder, the folder name

is MicroStrategyLibrary.war.
2. Put the MicroStrategyLibrary.war folder under ./jboss-eap-
7.3/standalone/deployments/.
3. Download modules_config.zip and extract it under the jboss-
eap-7.3/modules folder .
4. Download jboss-deployment-structure.xml and put it under
jboss-eap-

Copyright © 2021 All Rights Reserved 291

In st allat io n an d Co n figu r at io n Gu id e

7.3/standalone/deployments/MicroStrategyLibrary.war/W
EB-INF/.
5. In the ./jboss-eap-7.3/standalone/deployments/ folder
create a marker file named
MicroStrategyLibrary.war.dodeploy.
6. After deploying the marker file would be updated to
MicroStrategyLibrary.war.deployed, if we want to redeploy the
folder, just rename it as before.
7. Open MicroStrategyLibrary/admin page to configure connection
to Intelligence Server and Collaboration Server.

Linking MicroStrategy Library to MicroStrategy Web

After installation you can link MicroStrategy Library to MicroStrategy Web.

Ensure you have the Use Library privilege for all projects, so you can access
dossiers within all projects. See Privileges in Library Web for more information.

1. In MicroStrategy Web, navigate to the General Project Defaults page.

See the General Project Defaults topic in the MicroStrategy Web
Administration Help for more information.
2. Enter the MicroStrategy Library URL into Link to MicroStrategy
Library field, formatted as follows:

http://HOST_NAME:PORT/MicroStrategyLibrary/

This URL should be the externally facing URL that takes into
consideration any networking infrastructure such as load balancers.

3. Save and apply this change to all projects on the Intelligence server.

Copyright © 2021 All Rights Reserved 292

In st allat io n an d Co n figu r at io n Gu id e

Deep Link to Library from Other Applications

Library Mobile supports deep linking from other applications. The deep links
can be used to target dossiers, bookmarks, and even filtered contents with
the Library Mobile app. This topic describes how to construct the URL for the
Web and Mobile scheme and distribute it to end users.

Deep Link URL Structure

Dossier URLs should have the following structure:

https://<EnvironmentFQDN>/<LibraryAppContext>/app/<ProjectID>/<DossierID>/<
PageKey>

Example:

https://test.microstrategy.com/MicroStrategyLibrary/app/EC70648611E7A2F962E
90080EFD58751/837B57D711E941BF000000806FA1298F/K53--K46

Dossier URL with a Bookmark

You can generate a dossier URL that contains a bookmark.

1. Open a dossier in Library.

2. Choose Share and Export > Share Dossier.

3. Select the bookmark you want to include and copy the generated
URL link.

The generated URL should be in the following format:

https://<EnvironmentFQDN>/<LibraryAppContext>/app/<ProjectID>/<Dossier
ID>/bookmarks?ids=<BookmarkID>

Dossier URL with Filters

You can target a dossier with filters by appending a <FilterExpression>
to the dossier URL. The <FilterExpression> is simple encoded JSON
that specifies the filters to target and the corresponding elements to apply.

Copyright © 2021 All Rights Reserved 293

In st allat io n an d Co n figu r at io n Gu id e

https://<EnvironmentFQDN>/<LibraryAppContext>/app/<ProjectID>/<DossierID>/<
PageKey>?dossier.filters=<EncodedFilterExpression>

Attribute Filter Example

l Attribute filter with the name "Category"
l Filter on element names: "Electronics" and "Music"

[
{
"name": "Category",
"selections": [
{
"name": "Electronics"
},
{
"name": "Music"
}
]
}
]

Metric Qualification Filter Example

l Metric filter with the name, "Revenue"
l Qualifications between 300000 and 500000

[
{
"name": "Revenue",
"qualifier":"Between",
"constants":
[
"300000",
"500000"
]
}
]

Copyright © 2021 All Rights Reserved 294

In st allat io n an d Co n figu r at io n Gu id e

Multiple Filters Example

A filter expression also supports multiple filters. This example combines the
two previous filters into one expression.

[
{
"name": "Category",
"selections": [
{
"name": "Electronics"
},
{
"name": "Music"
}
]
},
{
"name": "Revenue",
"qualifier":"Between",
"constants":
[
"300000",
"500000"
]
}
]

Here is an example of the filter expression above, encoded and appended to

the dossier URL:

https://test.microstrategy.com/MicroStrategyLibrary/app/EC70648611E7A2F962E
90080EFD58751/837B57D711E941BF000000806FA1298F/K53--
K46?dossier.filters=%5B%0A%09%7B%0A%09%09%22name%22%3A%20%22Category%22%2C%
09%09%09%0A%09%09%22selections%22%3A%20%5B%0A%09%09%09%7B%0A%09%09%09%09%22
name%22%3A%20%22Electronics%22%0A%09%09%09%7D%2C%0A%09%09%09%7B%0A%09%09%09
%09%22name%22%3A%20%22Music%22%0A%09%09%09%7D%0A%09%09%5D%0A%09%7D%2C%0A%09
%7B%0A%09%09%22name%22%3A%20%22Revenue%22%2C%09%09%09%0A%09%09%22qualifier%
22%3A%22Between%22%2C%0A%09%09%22constants%22%3A%0A%09%09%5B%0A%09%09%09%22
3000000%22%2C%0A%09%09%09%225000000%22%0A%09%09%5D%0A%09%7D%0A%5D

Copyright © 2021 All Rights Reserved 295

In st allat io n an d Co n figu r at io n Gu id e

Advanced Cases
While you can use names to specify filters most of the time, you can also use
filter keys for advanced cases, such as supporting localized filter names in
the metadata internalization. Using the MicroStrategy REST API, you can
retrieve information about the filter applied in each chapter in a specific
dossier.

1. Browse the MicroStrategy REST API.

2. Retrieve a filter key from a chapter, within a specific dossier, using the
MicroStrategy REST API.

Filter Key Example

l Attribute filter with the name "Category" and filter key "W887"
l Filter on element names "Electronics" and "Music"

[
{
"key": "W887",
"selections": [
{
"name": "Electronics"
},
{
"name": "Music"
}
]
}
]

Privileges in Library Web

Administrator can control the exposure of Library Web features with
privileges.

Copyright © 2021 All Rights Reserved 296

In st allat io n an d Co n figu r at io n Gu id e

Web

Privilege Allows the user to... Behavior without privileges

User without the Use Library privilege

will not be able to access Library Web.
There will be Access Error.
Enable users to access Library User with the Use Library privilege can
using mobile browsers and log in to Library Web, but they can
perform dossier-related only see documents or dossiers in the
operations project they have privileges granted
Use Library
Web for.
The Use Mobile privilege
allows users to connect to If the user tries to directly execute a
Library using mobile document or dossier URL from a
platforms. project without the Use Library
privilege, there will be an Access
Error.

User without the Web run Dossier

Web run
Execute and display a dossier privilege cannot execute dossiers in
Dossier
Library Web.

User without the Web Run Document

Web run Execute and display a Report
privilege cannot execute documents in
Document Services Document
Library Web.

Edit a dossier
User without the Web edit Dossier
Web edit If you do not have this permission, privilege cannot edit a dossier by
Dossier the Visualization Gallery, as well navigating from Library Web to
as the Datasets, Editor, Filter, and MicroStrategy Web.
Format panels are not displayed.

Create a document page, access

Design Mode for documents, and User without the Web Document
Web
perform WYSIWYG editing of design privilege cannot edit a
Document
documents in Flash Mode document by navigating from Library
design
Web to MicroStrategy Web.
This privilege is required to define

Copyright © 2021 All Rights Reserved 297

In st allat io n an d Co n figu r at io n Gu id e

Privilege Allows the user to... Behavior without privileges

conditional formatting.

Web drill Use links to view related data not User without the Web drill and link
and link shown in the original report results privilege cannot drill in a document.

Web drill on User without 'Drill on metrics' privilege

Drill on metrics
Metrics cannot drill on metrics in a document.

Sort report data by clicking on sort User without 'Web sort' privilege will
Web sort
icons in column headings not be able to sort in a document.

Web set User without the Web sort privilege

Modify the column widths and row
column cannot change the column width and
height for a grid report
widths row height for a grid in a document.

Web use User without the Web use locked

Locked Use the Lock Grid Headers feature headers privilege cannot view grids
Headers with locked headers in a document.

Common Privileges

Privilege Allows the user to... Behavior without privileges

User without the Export to PDF privilege

Export a report or document
Export to PDF cannot export the dossier or document to
to a PDF document
a PDF.

Export to
Export a dossier or dataset User without the Export to .mstr File
MicroStrategy
from the server privilege cannot download a dossier.
File

User without the Export to text privilege

Export a report or document
Export to text cannot export a visualization to a .CSV
to plain text
file.

Export a report or document User without the Export to Excel privilege

Export to Excel to a Microsoft Excel cannot export a grid visualization to
spreadsheet Excel.

Copyright © 2021 All Rights Reserved 298

In st allat io n an d Co n figu r at io n Gu id e

Collaboration

Allows the
Privilege Behavior without privileges
user to...

User without the Use Collaboration Service privilege

cannot:

l See the Notification menu icon or the total number

of comments for a dossier in library page.
Use Access
l See the Comment and Invite User menu icons in a
collaboration Collaboration
dossier.
services Services
l Receive browser notifications.
l Receive email notification.
l Be mentioned or invited by other users from
dossiers in all projects.

Transaction

Privilege Allows the user to... Behavior without privileges

Edit the grids and fields in a User without the Execute transaction
Execute Transaction Services report privilege will not be able to edit a
transaction and submit the changed transaction document and submit the
results to the report changed results to the document.

How to Enable Seamless Login Between Web, Library,

and Workstation
Enabling seamless login allows you to navigate between MicroStrategy Web,
Library, and Workstation without having to re-authenticate regardless of
your configured authentication mode. It uses an encrypted (secret) key to
securely share the session among the applications.

Copyright © 2021 All Rights Reserved 299

In st allat io n an d Co n figu r at io n Gu id e

For new installations of MicroStrategy 2021 seamless login will be

configured and active if the prerequisite components are installed on the
same machine. Distributed environments and customers upgrading to
version 2021 need to configure the secret key by following the steps below.

Important Considerations
The following are some points to keep in mind while configuring seamless
login between Web, Library, and Workstation.

l For Web and Library configuration, use the same Intelligence Server.
l Once you configure seamless login between Web and Library, it will also
work in Workstation.
l For collaboration to work properly, use the same secret key in
config.json.

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. Click Apply.
5. In your cloud environment's homepage, hover over MicroStrategy
Web and click Configure.
6. Click 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.

Copyright © 2021 All Rights Reserved 300

In st allat io n an d Co n figu r at io n Gu id e

8. Click Save.
9. In your cloud environment's homepage, hover over Library, and
click Configure.
10. In the Library Server tab, in the MicroStrategy Web > Link field,
enter the MicroStrategy Web link.

11. In the Security Settings > Secret Key field enter the secret key
from step 7.

12. Click Save.

Configure the Secret Key Between Web and Library

If the secret key is not available in the configOverride.properties
file, you can add any phrase or passcode to the parameter to be used as
the secret key. A secret key should be between 5 and 30 characters
long.

1. Open the Library configOverride.properties with a text

editor.
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. Click Save.
7. Restart your MicroStrategy Web server to apply the changes.

Copyright © 2021 All Rights Reserved 301

In st allat io n an d Co n figu r at io n Gu id e

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 to
MicroStrategy 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 under
MicroStrategy Web
(<FQDN>:<port>/MicroStrategy/servlet/mstrWeb).
6. Click Save.

Ensuring Images in MicroStrategy Web Work With

Content in the Library
The MicroStrategy Library and MicroStrategy Web are different web
applications that do not share a common images directory. As a result,
documents and dossiers in MicroStrategy Web with images in them may
appear incorrectly in MicroStrategy Library if the images are stored as
relative paths. To ensure that any documents or dossiers that you make
available in MicroStrategy Library appear as expected with images, we
recommend the following:

1. When creating documents and dossiers, it is possible to embed images

into the content. When you do this, you insert an image into the content
via upload and the image is referenced on disk via the MicroStrategy
metadata. This is the recommended way of including images in your
content since it ensures that both MicroStrategy Web and Library are
able to commonly access the image. For images embedded in your

Copyright © 2021 All Rights Reserved 302

In st allat io n an d Co n figu r at io n Gu id e

content in this method, the images will work in both Web and Library
and no further action is required.
2. The second way to include images in content is via an absolute path
reference. An absolute path reference typically looks like this,
"https://www.microstrategy.com/getmedia/3534c22d-a593-
4ecc-bbec-c8c6ac3deab5/logo.jpg". Images referenced via
absolute paths will also work in both Web and Library and no further
action is required.
3. The third way to include images in content is via a relative path.
Whenever possible, we recommend you either embed images in your
content, or use absolute path references. A relative path typically looks
like this, /images/logo.jpg. Relative paths point to locations that
are relative to the application that they were originally created for. As a
result, a relative path defined for MicroStrategy Web will not work with
MicroStrategy Library. This means that documents and dossiers
deployed on MicroStrategy Web with relative paths will appear with
broken images. There are two ways to fix this:
l Replace all of the relative paths with embedded images or absolute
paths. This is recommended when there are only a few impacted
documents. However, if you have many documents and dossiers in
MicroStrategy Web with many relative path images, you should use
the next option.
l Copy or synchronize the /images directory from MicroStrategy Web to
the /images directory in MicroStrategy Library. This will allow the
Library to access the images required to render the documents
correctly.

MicroStrategy Library Web Internationalization

There are 5 key aspects of internationalization which are controlled by two
different settings in MicroStrategy Library Web:

Web Browser Language Setting

Copyright © 2021 All Rights Reserved 303

In st allat io n an d Co n figu r at io n Gu id e

l Library Web Interface Language: This refers to the general interface of

the Library Web application.
l Number and Date Format: This refers to the data; specifically to the data
defined as Date type or Numerical type.
l Intelligence Server Message Language: This refers to the Intelligence
server messages that are displayed in the Library Web application.

MicroStrategy User Preferences

l Metadata Language: This refers to the translations of the various

metadata objects. These translations are saved in the metadata database.
l Data Language: This refers to the translations of the actual data
displayed in dossiers and documents. These translations are saved in the
data warehouse.

MicroStrategy User Preferences - Language

From Developer, the administrator can set metadata and data languages for
all users at a specific project level: Project Configuration > Language >
User Preferences.

Copyright © 2021 All Rights Reserved 304

In st allat io n an d Co n figu r at io n Gu id e

From Developer, the administrator can also set metadata and data
languages for a specific user at a specific project level: Project
Configuration > Language > User Preferences > User Language
Preferences Manager > Modify.

Copyright © 2021 All Rights Reserved 305

In st allat io n an d Co n figu r at io n Gu id e

From Platform Web, the administrator can set all internationalization

settings for a specific user at a specific project level: Web Preferences >
User Preferences > General > Language.

Platform Web vs. Library Web Internationalization Settings

Platform Web internationalization settings are controlled by MicroStrategy
Web User Preferences only. The Web browser language setting will not

Copyright © 2021 All Rights Reserved 306

In st allat io n an d Co n figu r at io n Gu id e

affect the internationalization setting of Platform Web unless the metadata

setting is 'Default'.

Load Balancer and Clustering Considerations for

Library and Collaboration Server
When deploying MicroStrategy Library in a load balanced environment, there
are several important points to consider:

1. The MicroStrategy Collaboration Service can be clustered both

horizontally and vertically. See Cluster the MicroStrategy Collaboration
Server for instructions.

The service can be deployed behind a load balancer, but it relies on a

Redis server instance to ensure proper message distribution across all
of the various instances. The load balancer must utilize "sticky
sessions" to ensure that clients are directed to the instance that
established the initial session. The load balancer should also support
the Web Socket protocol (wss:), which relies on the HTTP 1.1 Upgrade
protocol.

SeeDeployment Topology for more information about the Redis

configuration.

2. The MicroStrategy Web and Library server applications can be

clustered behind a load balancer with any number of instances.
However, the load balancer must utilize "sticky sessions" to ensure that
clients are directed to the instance which established the initial
session.
3. When deploying a cluster of MicroStrategy Library servers, the
Collaboration servers should be configured to point to the Web load
balancer, rather than a specific instance, to fully utilize the cluster.

Copyright © 2021 All Rights Reserved 307

In st allat io n an d Co n figu r at io n Gu id e

4. To fully utilize a cluster of MicroStrategy Collaboration servers, the

MicroStrategy Library server should be configured to point to the Web
load balancer, rather than a specific instance.

5. Since both web browsers and mobile apps will connect to it directly, the
MicroStrategy Collaboration server port (default :3000) must be
accessible and open through the load balancer.

The Collaboration server port can be changed from the default value
by specifying it in the config.json file.

6. Since both web browsers and mobile apps will connect to it directly, the
MicroStrategy Library server (default :8443) must be accessible and
open through the load balancer.

Deployment Topology

In the diagram, there is a single load balancer with an external facing DNS
name, loadbalancer.acme.com which is used for both Library server and
Collaboration server configuration:

l The Library server configOverrides.properties file uses this name

in the services.collaboration.baseURL property, as in:
https://loadbalancer.acme.com:3000.

Copyright © 2021 All Rights Reserved 308

In st allat io n an d Co n figu r at io n Gu id e

l The Collaboration server config.json file uses this name in the

authorizationServerUrl property, as in:
https://loadbalancer.acme.com:8443/MicroStrategyLibrary/
api.

In this configuration, the Collaboration server specifies horizontal scaling by

setting two properties in the config.json file:

l "scaling": "horizontal"
l "redisServerUrl": "redis://sharedmachine.acme.com:6379"

In the diagram, there is a shared machine used by each of the instances

behind the load balancer. On this machine, there are two essential services:

l PostgreSQL Server - version 4.0.0 or higher.

l Redis Server - version 4.0.0 or higher.

In this environment, both shared services - PostgreSQL Server and Redis

Server - may themselves by replicated. In this case, you must specify the
correct URL in the config.json file properties:

l "dburl": "<PostgreSQL URL>"

l "redisServerUrl" : "<Redis URL>"

Using the Collaboration Server Outside of a Load Balanced

Environment
The Collaboration server can be run outside of a load balanced environment,
on a single machine. To configure the Collaboration server to run without
any form of scaling, set "scaling": "none".

The Collaboration server can also run multiple processes on the same
machine with vertical scaling by setting the following config.json fields:

l "scaling": "vertical"
l "cpus": "<number of worker processes to launch>"

Copyright © 2021 All Rights Reserved 309

In st allat io n an d Co n figu r at io n Gu id e

Load Balancer and Clustering for Library: Example Setup

Workflow

Install and Configure Redis Server

1. Download a proper Redis version and install, following instructions from
Redis Labs Ebook - Chapter Appendix.
2. Run Redis Server.

3. Check if Redis is working properly by sending a 'PING' command in

redis-cli.

A 'PONG' will be responded if Redis Server is good.

127.0.0.1:6379> ping

PONG

127.0.0.1:6379>

Collaboration servers require a URL to connect to the running Redis

Server for horizontal clustering purpose.

Example: redis://redis_host_machine:6379

Modify the Redis configuration file so it can accept external traffic.

l In Redis configuration file (redis.conf or redis.windows-

service.conf), add/change the bind entry to bind 0.0.0.0
l Save modification and restart Redis Server

Configure Collaboration Server

1. For all the Collaboration servers installed in different machines, set
Redis Server URL, web load balancer URL, clustering mode in the
configuration files:

Copyright © 2021 All Rights Reserved 310

In st allat io n an d Co n figu r at io n Gu id e

"port": 3000,

"dataSource": {"username": "mstr_collab","password":

"xxx"},

"logging": true,

"authorizationServerUrl":"<web_load_balancer_
url>/api",

"scaling": "horizontal",

"redisServerUrl": "<redis_server_url>",

.......

2. Save configuration files and restart Collaboration servers.

3. Make sure all the Collaboration servers are running properly by visiting
their individual /status URL. It will tell the actual state of the
Collaboration server instance. For example, the Collaboration server
below is actually paused due to unreachable Postgres and Redis
servers.

"version":"11.0.0.720",

"enableTls":false,

"scaling":"horizontal",

"logging":true,

"state":"paused",

"reason":"The following dependent services are

unavailable: DB Service, Redis Server",

"main":

Copyright © 2021 All Rights Reserved 311

In st allat io n an d Co n figu r at io n Gu id e

"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 utilize "sticky sessions" to ensure that clients are
directed to the instance which established the initial session. It should also
support the Web Socket protocol (wss:), which relies on the HTTP 1.1
Upgrade protocol.

For example, following is the configuration for Horizontally clustered

Collaboration servers, when using NGINX as web load balancer.

......

http {
......

upstream collabServer {
ip_hash; # this is a must, ensures that we are sticky to
enable a correct socket.io handshake
server collabServer1:3000; # provide the list of the Collaboration serve
from here
server collabServer2:3000;
server collabServer3:3000;

Copyright © 2021 All Rights Reserved 312

In st allat io n an d Co n figu r at io n Gu id e

location /socket.io/ { # API Pattern for socket

proxy_http_version 1.1; # Required for proper HT
proxy_set_header Upgrade $http_upgrade; # This is a Hop-by-Hop
must pass through manually
proxy_set_header Connection "upgrade"; # Another hop-by-hop h
proxy_pass http://collabServer/socket.io/; # Directs the request
server in upstream "collabServer"
}

location /status { # forward the /status API

CollabServer list
proxy_pass http://collabServer/status;
}

......

......

Command Line Tools to Create Security Artifacts

There are several command line tools that assist in the creation of security
artifacts, most notably, openssl and keytool. Here is how we are using these
tools to construct our own security artifacts.

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 file to create.

l PRIV_FILE is the path to the private key file.

Copyright © 2021 All Rights Reserved 313

In st allat io n an d Co n figu r at io n Gu id e

l CER_FILE is the path to the public certificate file.

l PASS_FILE is the path to the file 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 public certificate file.

l TS_FILE is the path of the trust store file to import into (or create).
l PASS_PHRASE is the actual pass phrase to use with the trust store.

You can create other security artifacts, such as private key, Client Signing
Request (CSR) and self-signed certificate using openssl.

Troubleshooting Your MicroStrategy Library

Installation
Issue: My Library is Empty
1. Open the Library Administration Control Panel and check that
Intelligence server is configured and running.
2. No content has been added to your Library.
3. Monitor REST API error

When the Library Web application behaves unexpectedly without any

error message, monitor the error messages being returned from the
MicroStrategy 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.

Copyright © 2021 All Rights Reserved 314

In st allat io n an d Co n figu r at io n Gu id e

4. Check that all of the requests are captured.

5. Click a network request that you are interested in.
6. Within the request info window, open the Preview tab. This will
display the response in JSON format.
7. Look for any network requests that are red, as this indicates that
the REST API request may have failed. If you are looking for API
errors only, click the XHR option so that the network tab displays
all http(s) calls including the APIs.
4. Review the MicroStrategyLibrary error logs and look for any console
errors in the browser debugging tool.
5. Ensure you have the Use Library privilege for all projects (see
Privileges in Library Web), so you can access dossiers within all
projects.

Issue: Collaboration Server is Unavailable

1. If the Notification Icon is not available:

l Go to the Library Administration Control Panel and configure the

Collaboration server.
l Ensure you have the Use Collaboration Services privilege (see
Privileges in Library Web).
2. If the Notification Icon is available but disabled, the Collaboration
server is not connected. Click the icon and use the error message
dialog to contact your administrator.
3. Monitor Web Socket error

When Collaboration server features within the Library fail without a

detailed error message, monitor the error message directly from Web
Socket messages using the web browser debugging tool.

1. From Chrome, open Developer Tools.

2. Open network tab.
3. Perform the steps to reproduce.

Copyright © 2021 All Rights Reserved 315

In st allat io n an d Co n figu r at io n Gu id e

4. Filter the request type by "WS" (WebSockets).

5. Click on a network request.
6. Within the request info window, open the Frames tab. This will
display the requests and responses in JSON format.

l If you don't see any request, refresh the page. It is possible that the
browser debugging tool started capturing network calls after the Web
Socket connection is established.
l If you don't see any requests even after refreshing, the
communication between the Library Web and Collaboration server in
your environment is through HTTP polling instead of a Web Socket
due to an environment limitation.

Common Configuration Errors

l The Collaboration server is in a "paused" state because a dependent
service is down or unreachable. You can see this by inspecting the status
page (for example, http://localhost:3000/status) and looking at the state
(value is "paused") and reason fields. The reason will explain the details,
for example:
l The following dependent services are unavailable: Authentication Server
l The following dependent services are unavailable: Authentication
Server, PostgreSQL Server
l The following dependent services are unavailable: PostgreSQL Server
l The "Authentication Server" refers to the "authorizationServerUrl"
property in the Collaboration server config.json file. Can you enter
this URL into a browser and see a JSON response?
l If the Tomcat service is not running, then it needs to be started. For the
Collaboration server, the "authorizationServerUrl" refers to the
MicroStrategy Library server.
l The "PostgreSQL" service is defined in the config.json file by the
dburl field. Are the machine and port correct? Are the user name and
password values correct?

Copyright © 2021 All Rights Reserved 316

In st allat io n an d Co n figu r at io n Gu id e

l Error indicating that the connection is refused, such as:

l Unable to invoke Authentication Server Method. Error: connect
ECONNREFUSED 127.0.0.1:8443 (code=ECONNREFUSED) Unable to
connect to the Authentication Server.
l Verify that the "authorizationServerUrl" uses the same machine name as
the "Common Name" associated with your certificate. In short, you
cannot open a secure connection to a machine if you don't have the
certificate for that same machine and the certificate is not signed by a
trusted certificate authority.
l Error indicating a problem with the certificate, such as:
l Unable to invoke Authentication Server method. Error: unable to verify
the first certificate <code=UNABLE_TO_VERIFY_LEAF_SIGNATURE>.
Unable to connect to the Authentication Server.
l Verify that the certificates specified in the Collaboration server
config.json file are the same used to create the keystore file used
with Tomcat.

Diagnose Collaboration Server Connection Issues

MicroStrategy installations provide a command line diagnostic tool for
troubleshooting Collaboration 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:

Copyright © 2021 All Rights Reserved 317

In st allat io n an d Co n figu r at io n Gu id e

Run the following command from the

/opt/mstr/MicroStrategy/install/CollaborationServer
directory to launch the Collaboration server's diagnostic tool:

./collaborationServer.sh diagnose

Invoking the diagnostic tool on a running system will return the following:

l Both dependent servers will show as Connected

l Collaboration server shows as Started and in a running state.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected

√ PostgreSQL Server: Connected

Collaboration Server: Started on port 3000

(state=running)

l A list of trusted certificates with the name and expiration date (only if
trusted certificates are set in config.json file)

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected

√ PostgreSQL Server: Connected

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

Copyright © 2021 All Rights Reserved 318

In st allat io n an d Co n figu r at io n Gu id e

Common Errors from the Diagnostic Tool

Collaboration Server Shows as Stopped

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected

√ PostgreSQL Server: Connected

Collaboration Server: Stopped

This means the Collaboration server is not running. You need to start the
Collaboration server and re-run the diagnostic tool.

Collaboration Server State Shows as Paused: Authorization

Server Not Connected
Authorization Server hostname is found but hostname:port is not accessible.
Check that port number is correct.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Not Connected Unable to invoke

Auth Server: Unreachable: Either the machine/process
is down or the port is inaccessible.

! PostgreSQL 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 not accessible.

Check that port number is correct.

Copyright © 2021 All Rights Reserved 319

In st allat io n an d Co n figu r at io n Gu id e

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Not Connected Unable to invoke

Auth Server: Call failed (statusCode=404)

! PostgreSQL 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:port is accessible however it's not a Library

Web server. The URL being used may be incorrect, even the hostname and
port number is correct.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Not Connected Unable to invoke

Auth Server: getaddrinfo ENOTFOUND fakeurl fakeurl:80
[code=ENOTFOUND]

! PostgreSQL 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 not a valid domain/ip address. You need to

verify the URL being used for Authorization Server.

Collaboration Server Diagnostics

Dependencies:

Copyright © 2021 All Rights Reserved 320

In st allat io n an d Co n figu r at io n Gu id e

√ Authorization Server: Not Connected Unable to invoke

Auth Server: getaddrinfo ENOTFOUND fakeurl fakeurl:80
[code=ENOTFOUND]

! PostgreSQL Server: Connected

server: [localhost:27017] on first connect

[MongoError: connect ECONNREFUSED 127.0.0.1:27017]

Collaboration Server: Started on port 3000

(state=paused)

Missing proper certificate for the Authorization Server which is running with
TLS enabled using some private root CA signed certificates. You need to set
proper values for the trusted certificate paths. See Collaboration Server
Configuration Properties.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Not Connected Unable to invoke

Auth Server: unable to verify the first certificate
[code=UNABLE_TO_VERIFY_LEAF_SIGNATURE]

! PostgreSQL Server: Connected

server: [localhost:27017] on first connect

[MongoError: connect ECONNREFUSED 127.0.0.1:27017]

Collaboration Server: Started on port 3000

(state=paused)

Collaboration Server State Shows as Paused: PostgreSQL Server

Not Connected
The hostname or port is not correct.

Collaboration Server Diagnostics

Dependencies:

Copyright © 2021 All Rights Reserved 321

In st allat io n an d Co n figu r at io n Gu id e

√ Authorization Server: Connected

! PostgreSQL Server: Not Connected Unable to connect

to PostgreSQL server: failed to connect to server
[fakedurl: 28017] on first connect

[mondoNetworkError: getaddrinfo ENOTFOUND fakedurl

fakedurl: 28017]

Collaboration Server: Started on port 3000

(state=paused)

Username or password is wrong: Authentication fail

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected

! PostgreSQL Server: Not Connected Unable to connect

to PostgreSQL server: authentication fail

[mondoNetworkError: getaddrinfo ENOTFOUND fakedurl

fakedurl: 28017]

Collaboration Server: Started on port 3000

(state=paused)

You are using replica set for PostgreSQL but the setName does not match.

Collaboration Server Diagnostics

Dependencies:

√ Authorization Server: Connected

! PostgreSQL Server: Not Connected Unable to connect

to PostgreSQL server: setName from ismaster does not
match provided connection setName [rs1] != [rss1]

[mondoNetworkError: getaddrinfo ENOTFOUND fakedurl

fakedurl: 28017]

Copyright © 2021 All Rights Reserved 322

In st allat io n an d Co n figu r at io n Gu id e

Collaboration Server: Started on port 3000

(state=paused)

Trusted CA Certificate Files

The diagonistic tool will try to read each file path configured in
config.json file as a trustedCert. There may be multiple certificates in a
single file. Here are the possible results:

l Success

l Un-supported format

l Warning: Contains an expired certificate

l Invalid PEM block

l Success: 2 certificates

l Warning: Contains an expired certificate (There are 2 certificates inside

this file. One is valid and one is expired)

Troubleshooting through Collaboration Server Logging

If Collaboration server logging is enabled, the logs created by Collaboration
server will provide more detailed information including:

l Running warnings and errors

l Request activities
l Notification records

See Configure Logging for MicroStrategy Library and Collaboration Server

for more information.

Collaboration Service and PostgreSQL Server Shell Scripts

The ./collaborationServer.sh and ./mongod.sh scripts can be used
to resolve issued displayed by the diagnostic tool. Both scripts accept the
following commands:

Copyright © 2021 All Rights Reserved 323

In st allat io n an d Co n figu r at io n Gu id e

l start: Start the Collaboration or PostgreSQL server.

l stop: Stop the Collaboration or PostgreSQL server.
l status: Return the status of the Collaboration or PostgreSQL server.
l restart: Stop then start the Collaboration or PostgreSQL server.

Library Server to Collaboration Server Errors and Warnings

Warning: Secret Keys Do Not Match

Library server and Collaboration server need to be set up with the same
secret key (a string with a minimum of 5 characters) in order to verify the
other server's identity. If the secret keys do not match, the Library server
cannot talk to the Collaboration server. Functionality such as updating the
Collaboration server configuration in Library Admin control panel will fail.
The Library server itself is okay to use.

Warning: Truststore is m issing in Library Server

If the Collaboration server is running with TLS enabled and is using a private
root CA signed certificate, the Library server is required to present the
corresponding certificate in order to establish a secure communication. The
administrator can configure a truststore file in the Library server (see
MicroStrategy Library Server Configuration Properties). Failure to reference
the required certificate in the truststore will lead to this warning. With this
warning active, the Library server cannot communicate with the
Collaboration server. Functionality such as updating the Collaboration

Copyright © 2021 All Rights Reserved 324

In st allat io n an d Co n figu r at io n Gu id e

server configuration in Library Admin control panel will fail. The Library
server itself is okay to use.

Warning: Cannot establish socket connection from browser to

Collaboration server

In some cases, the Library server can talk to the Collaboration server but
end users (browsers) may fail to establish communication to the
Collaboration server (failure to establish a socket connection). There are
three possible causes:

l The Library server is running with TLS enabled (URL starting with 'https')
while the Collaboration server is running with TLS disabled (URL starting
with 'http'). Some browsers will block any request to 'http' if the current
website is using 'https'.

l The Collaboration server is running with TLS enabled but using a private
root CA signed certificate. Some browsers will consider such private root
CAs as untrusted and block requests to those servers. The administrator
may need to add those private root CAs into the trust list.

Copyright © 2021 All Rights Reserved 325

In st allat io n an d Co n figu r at io n Gu id e

l The administrator may use a hostname like 'localhost' as the machine

name for the Collaboration server in the Library server. That hostname is
only recognized by the Library server and not accessible from other users
(client machine/browsers).

There may be two causes:

l Cannot find IP address for that hostname: end user can update the
hosts file in system which can help system to resolve domain names to
an IP address

l The IP address is not visible to end user: It may be a local ip address

or the port is not exposed to public.

Collaboration Server to Library Server Errors and Warnings

Warning: The Collaboration Server is Not Targeted at the Current Library

Server.

This is only a warning: the Collaboration server is talking to a different

Library server. The current Library server is okay to use. Potential issues

Copyright © 2021 All Rights Reserved 326

In st allat io n an d Co n figu r at io n Gu id e

may occur when the two Library servers provide different data.

Error: The Collaboration Server is Not Targeted at the Current Library

Server and the Target Library Server is Not Reachable.

For this case, the collaboration-related features in Library are not usable
since the Collaboration server is paused due to this error. The administrator
may choose to use the current Library server as the target Library server for
this Collaboration server.

Error: Target Library Server is Not Reachable and Cannot be Set Up

through Adm inistration Control Panel

There are two cases when Admin UI can display issues about the current
Collaboration server but cannot provide any solutions for the problem:

l Secret keys do not match between the Library server and Collaboration
server.

Copyright © 2021 All Rights Reserved 327

In st allat io n an d Co n figu r at io n Gu id e

l The Collaboration server is TLS enabled using a private root CA signed

certificate while the Library server is missing the truststore for that
certificate.

Both causes will lead to the Library server being unable to communicate with
the Collaboration server and thus unable to control/update Collaboration
server settings.

Error: The Collaboration Store is Not Reachable

The current Administration control panel does not expose an interface to

update the Collaboration Store. The administrator can manually update it
through the Collaboration server configuration.

Copyright © 2021 All Rights Reserved 328

In st allat io n an d Co n figu r at io n Gu id e

Library Server to Intelligence Server Errors and Warnings

Error: Intelligence Server is Not Reachable

The administrator will see this error message when the Library server is
unable to connect to the current Intelligence server.

The administrator will see this error message when the Library server is
unable to connect to the current Intelligence server and Admin UI has
succeeded in a connection test using the hostname and port of the current
Intelligence server. This is most likely caused by using an incorrect TLS
setting.

Error: Minim um Version Requirem ent

If the Library server has set a minimum Intelligence server version

requirement and the current Intelligence server doesn't meet that
requirement, this error message will be displayed.

Copyright © 2021 All Rights Reserved 329

In st allat io n an d Co n figu r at io n Gu id e

Certificate Store Integration with MicroStrategy

Library
Certificate Store primarily serves as a data source exposed via a REST API.
This data source provides the data for display in the Certificates section of
the Workstation window.

Integration with MicroStrategy Library

To integrate Certificate Store with MicroStrategy Library, you can select
Certificate Store when installing Library. This will ensure that the Certificate
Store REST API appears to be a part of the entire MicroStrategy REST API
suite.

So while it looks as if the Certificate Store REST API

(/api/serviceCertificates) is served from the same web endpoint as
the other APIs, in reality requests made to the
/api/serviceCertificates endpoint are actually redirected to the
Certificate Store Server. This redirection is accomplished by a proxy servlet
configured in the Library web.xml file.

The servlet is configured by the installer and takes all URLs that match the
url-pattern property, and redirects them to the URL specified in the
targetUri property. If you are altering these settings to add or remove
SSL support, you must update the targetUri property so that it specifies
either "http" or "https".

Copyright © 2021 All Rights Reserved 330

In st allat io n an d Co n figu r at io n Gu id e

If self-signed certificates are used then the trustAllCertificates and

disableHostnameVerification properties must be set to true. If a user
switches from self-signed to CA-assigned certificates, they should set both
certificates to 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</par
am-value>

</init-param>

<init-param>

<param-name>log</param-name>

<param-value>true</param-value>

</init-param>

<!-- SSL SUPPORT START - The following group of

parameters are only relevant when the targetUri above
uses the "https" protocol. -->

<init-param>

<param-name>truststorePath</param-name>

<param-value>{PATH_TO_TRUSTSTORE}</param-value>

</init-param>

<init-param>

<param-name>truststoreType</param-name>

Copyright © 2021 All Rights Reserved 331

In st allat io n an d Co n figu r at io n Gu id e

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

<!-- DEVELOPMENT - START - The following parameters are

for development/debugging use only and should not be set
to TRUE in production systems. -->

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

<!-- DEVELOPMENT END -->

<!-- SSL SUPPORT END -->

</servlet>

<servlet-mapping>

Copyright © 2021 All Rights Reserved 332

In st allat io n an d Co n figu r at io n Gu id e

<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 by

ServletContext.getResourceAsStream().

The path rules for this method can be found in the Oracle documentation.
The path must begin with a slash (/) and is interpreted as relative to the
current context root or relative to the /META-INF/resources directory
of a JAR file inside the web application's /WEB-INF/lib directory. The
path separator is a slash (/) on both Unix and Windows.

l truststoreType accepts a variety of keystore/truststore types, for a full

list, see the Java SE Documentation. MicroStrategy supports JKS and
PKCS12.

Certificate Store Configuration Properties

Settings for the Certificate Store can be changed by editing the
application.properties file. All parameters are case sensitive and
must be entered correctly for changes to take effect.

The application.properties can be found in:

l Windows: <INSTALL_PATH>\MicroStrategy\Certificate Manager

l Linux: <INSTALL_PATH>/Certificate Manager

This file includes the following properties:

Property Details Notes

IP address Certificate  If you modify any of these

server.address
Store will use to listen for three settings, be sure to

Copyright © 2021 All Rights Reserved 333

In st allat io n an d Co n figu r at io n Gu id e

Property Details Notes

incoming REST API

requests. By default this
is set to 127.0.0.1 to
restrict access to
processes on the same
machine.
make the corresponding
To listen on all IP change to the targetUri
addresses, specify property of the proxy servlet
0.0.0.0 as the address. described above.

IP port Certificate Store

will use to listen for
server.port
incoming REST API
requests.

server.servlet.context- Path to the Certificate

path Store endpoint.

The path to the PKCS12

or PFX keystore file,

e.g.
server.ssl.key-store classpath:/opt/mstr
/MicroStrategy/inst
all/

your-cert.crt
These settings are relevant
server.ssl.key-store- Passphrase for the only if Certificate Store's
password keystore file REST API is running over
HTTPS.
Passphrase for the key
server.ssl.key-password contained within the
keystore

Type of keystore, default

server.ssl.keyStoreType
is PKCS12

Alias of key in keystore,

server.ssl.key-alias
used if keystore contains

Copyright © 2021 All Rights Reserved 334

In st allat io n an d Co n figu r at io n Gu id e

Property Details Notes

multiple keys

Maximum amount of time

to allow for retrieval of all
certificates from defined
max.certificate.retriev services. Default is 30
al.time.seconds seconds which should be
more than enough time
for the services defined
in 11.1.

IP address of Consul
consul.host
agent These settings control which
Consul agent is contacted for
consul.port IP port of Consul agent the list of defined services

Delay (in milliseconds) and how often the agent is

consul.initialDelay.mil contacted to refresh that list.
before initial connection
liseconds The default settings should
to Consul
be sufficient for most installs
Interval (in milliseconds) and users should not need to
consul.fixedRate.millis
between each connection change them.
econds
to Cosul

These two settings control the

Socket.io endpoint that
GUIs can connect to to
wss.server.host Socket.io IP address
receive async. updates
regarding the existing
services and the state of their
certificates. Note that the
firewall must allow
WebSocket access to this
wss.server.port Socket.io IP port
endpoint (similar to the
Socket.io connection in
Collaboration Server)

Copyright © 2021 All Rights Reserved 335

In st allat io n an d Co n figu r at io n Gu id e

Property Details Notes

spring.mail.host Mail server IP address

spring.mail.port Mail server IP port

Mail server protocol

spring.mail.protocol These settings configure how
(SMTP)
Certificate Store
spring.mail.properties. communicates to an email
Time out for connecting
mail.smtp.connectiontim host. The default is to use
to mail host
eout SMTP but user must provide
the IP address, etc. By
spring.mail.properties.
default this is not configured
mail.smtp.timeout
by the installer and must be
spring.mail.properties. Time out sending data to manually enabled by the user.
mail.smtp.writetimeout mail host

spring.mail.default- Encoding used to send

encoding data to mail host

Certificate Store periodically

scans the certificates it finds
to look for those that have
expired or will expire within
the next {
expiry.notification.da
ys} days.

These settings control this

expiry.notification.day certificate scanning process
s and defines which email
address will receive the
notifications.

Multiple email addresses may

be specified by comma-
separated list, e.g.

expiry.notification.email=use
[email protected],user2@doma
in.net

Copyright © 2021 All Rights Reserved 336

In st allat io n an d Co n figu r at io n Gu id e

Property Details Notes

Delay (in milliseconds)

expiration.check.initia before certificates are
lDelay.milliseconds scanned for expired
certificates. No notifications are sent if
the expiry.notification.email
Interval between each is empty.
expiration.check.fixedR
scan for expired/expiring
ate.milliseconds expiry.notification.email.from
certificates.
must be specified for emails
expiry.notification.ema to be sent successfully.
il

expiry.notification.ema
il.from

A profile collects different

configuration properties
A Spring framework
together in one file so they
setting used to select a
profile.name can be applied together. It's
profile within the
not recommended to change
application.
the profile to anything other
than prod.

Considerations in Clustered Environments

The Certificate Store process normally listens for REST API requests on
localhost:5050. The server is bound to the loopback interface so that only
processes on the same machine may make API requests.

In a clustered environment, there is a Certificate Store process on each

node. Because Certificate Store builds its data from the services registered
with Consul, and Consul contains entries for all nodes, Certificate Store will
contain entries for all services in the cluster and not those services on the
current node. However, because some services are bound to the loopback
address, some certificates will not be retrievable from other nodes in the
cluster.

Copyright © 2021 All Rights Reserved 337

In st allat io n an d Co n figu r at io n Gu id e

Other Library Considerations

If your Library installation does not have Certificate Store the proxy servlet
may still be configured, however the targetUri will not point to a valid
endpoint. Users with this configuration will receive a 502 Bad Gateway error
(or other 5xx level HTTP errors). To resolve these errors, you can install
Certificate Store or remove the proxy servlet configuration from the Library
web.xml file.

Configuring the Modeling Service

The Modeling service is a new microservice that enables MicroStrategy
users to create and manage application and schema objects through
Workstation. In MicroStrategy 2021 Update 1 release, users can create and
manage standalone filters, facts, attributes, tables, and schema using the
Filter Editor, Fact Editor, Attribute Editor, Schema Editor, and access
Schema tab to lock, unlock, and reload (update) schema from the main
Workstation window. The Modeling service is deployed and enabled when
you install MicroStrategy. Admins can view and manage this service through
Monitors view in the Workstation window or through their cloud console.

Copyright © 2021 All Rights Reserved 338

In st allat io n an d Co n figu r at io n Gu id e

Components and Architecture

The following components are part of the Modeling service dependencies

and architecture:

l Workstation: Users can initiate filter, fact, and attribute creation workflow
from Workstation, which communicates with the Library Server. Admins
can also view the status of the modeling service using the Topology view
in Workstation.
l Library server: A SPA (single page app) built on the MicroStrategy REST
APIs for all communication.
l Modeling service: Holds the logic of creating, editing, and managing
objects. The response from the modeling service to Workstation is in
JSON format. The Modeling service is a self-contained Java application
that serves the modeling requests and communicated with the Intelligence
server to save objects.
l Intelligence server: Provides and saves the object definition and interacts
with the metadata to retrieve the relevant information. The Intelligence
server also holds the logic for locking and unlocking the schema. The

Copyright © 2021 All Rights Reserved 339

In st allat io n an d Co n figu r at io n Gu id e

response from the Intelligence server to the modeling service is in JSON

format.
l Metadata: MicroStrategy metadata is a repository that stores
MicroStrategy object definitions and information about your data
warehouse.

Modeling Service Configuration Properties

Setting for the Modeling service can be changed by editing the
application.conf, modelservice.conf and modelservice.ini files.
All parameters are case-sensitive and must be entered correctly for changes
to take effect.

The application.conf and modelservice.conf files can be found in:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin

Linux: <INSTALL_PATH>/MicroStrategy/ModelingService/admin

Make your configuration changes to the configuration files under the admin
folder. Do not change the files under the conf folder. All files under the
conf folder are overwritten when you upgrade MicroStrategy.

The modelservice.ini can be found in:

Windows: <INSTALL_PATH>\MicroStrategy\ModelingService\bin

Linux: <INSTALL_PATH>/MicroStrategy/ModelingService/bin

The application.conf file includes the following properties:

Property Specifies

Port

The communication port for HTTP. Set to

http.port
disabled if you want to disable the

Copyright © 2021 All Rights Reserved 340

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

HTTP communication channel for the Modeling

service.

Default: 9500

Library Server HTTPS Configuration

The communication port number for HTTPS.

https.port
Default: 10443

The path to the keystore containing the private

play.server.https.keyStore.path key and certificate.

Default: NONE

The key store type.

play.server.https.keyStore.type
Default: JKS

The password.
play.server.https.keyStore.password
Default: NONE

The modelservice.conf file includes the following properties:

Property Specifies

Library Server Support Properties

To establish trusted communication between the

Library server and Modeling service, the value should
be the same as that of identityToken.secretKey
modelservice.identity_ in the Library server configuration file.
token.secret_key
This trusted communication is required for
configuring the connectivity between the Modeling
service and the Library server.

Intelligence Server TLS/SSL Configuration

Copyright © 2021 All Rights Reserved 341

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

Set to true if Intelligence server is TLS enabled but

with a private Root CA certificate or a self-signed
certificate. In this case, a trustStore file and its
modelserver.iserver.tlsEnabled passphrase must be provided. For Intelligence server
that is TLS enabled with a public Root CA certificate,
set to false.

Default: false

If Intelligence server is TLS enabled, but with a

private Root CA certificate or a self-signed
certificate, a trust store file is required.

l Example:
modelserver.trustStore.path
trustStore.path=/path/to/truststore.pf
x

Default: NONE

The passphrase used in the construction of the Trust

modelserver.trustStore.passphrase Store file.

Default: NONE

The modelservice.ini file includes the following properties:

Property Specifies

Memory Allocation

The configuration of the maximum memory allocation

pool for Modeling service.
MODELSERVICE_JAVA_MAX_
OS Mem Default Value
MEMORY
2G -Xms500M
8G -Xms1G

Copyright © 2021 All Rights Reserved 342

In st allat io n an d Co n figu r at io n Gu id e

Property Specifies

16G -Xms1G
32G -Xms1G
64G -Xms2G
128G -Xms2G
256G -Xms3G
512G -Xms3G
1024G -Xms3G
2048G -Xms3G

The configuration of the initial memory allocation pool for

MODELSERVICE_JAVA_ Modeling service.
INITIAL_MEMORY
Default: -Xms500M

Manually Configure the Modeling Service on a Linux Server

1. Browse to the Modeling service installation directory at <INSTALL_
PATH>/MicroStrategy/ModelingService.

2. Under the ./admin/ directory, locate and edit the

application.conf file.

http.port = <modeling_service_port_number>

3. Restart the Modeling service using one of the following commands. The
second option starts the Modeling service from console as an
application, rather than a background job.

./bin/modelservice.sh restart

./bin/start.sh

4. Navigate to http://localhost:<port_
number>/model/application/health to check the status of the
Modeling service.

Copyright © 2021 All Rights Reserved 343

In st allat io n an d Co n figu r at io n Gu id e

Manually Configure the Modeling Service on a Windows

Server
1. Browse to the Modeling service installation directory at <INSTALL_
PATH>\MicroStrategy\ModelingService.

2. Under the .\admin\ directory, locate and edit the

application.conf file.

http.port = <modeling_service_port_number>

3. Restart the Modeling service using one of the options below.

Open the Windows Service Application, right-click MicroStrategy

Modeling Service, and choose Restart.

or

Use the command line to start and stop the Modeling service.

./bin/stop.bat
./bin/start.bat

4. Check the status of the Modeling service at

http://localhost:<port_
number>/model/application/health.

Copyright © 2021 All Rights Reserved 344

In st allat io n an d Co n figu r at io n Gu id e

Change the Communication Port for the Modeling Service

1. Locate the application.conf file in one of the following directories:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin\

Linux: <INSTALL_
PATH>/MicroStrategy/ModelingService/admin/

2. Change the port property in the application.conf file. Remember

that all parameters in the application.conf file are case-sensitive.
Make sure to open the Modeling service port in the firewall, if you are
employing a firewall.

HTTP Port:

http.port = <modeling_service_http_port_number>

HTTPS Port:

https.port = <modeling_service_https_port_number>

3. Restart the Modeling service.

Configure HTTPS Connection Between Library Server and

Modeling Service
To enable the HTTPS communication channel between Library server and
the Modeling service, you must make configuration changes to both.

Modeling Service
Enable related configurations in the application.conf file, in the
following locations:

l Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin\

Copyright © 2021 All Rights Reserved 345

In st allat io n an d Co n figu r at io n Gu id e

l Linux: <INSTALL_
PATH>/MicroStrategy/ModelingService/admin/

1. Enable the HTTPS port.

https.port = <modeling_service_https_port_number>

2. Configure the path to the keyStore, keyStore type, and password.

play.server.https.keyStore.path = path/to/model.pfx
play.server.https.keyStore.type = JKS
play.server.https.keyStore.password = password

3. Restart the Modeling service.

4. Check the status of the Modeling service at
https://localhost:<https_
port>/model/application/health.

Library Server
Enable related configurations in the configOverride.properties file, in
the following locations:

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

Files\MicroStrategy\Tomcat\apache-tomcat-
8.5.30\webapps\MicroStrategyLibrary\
WEB-INF\classes\config\configOverride.properties

Linux: <TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/config/configOverride.properties

1. Add relevant certificates into the trustStore.

If the Modeling service is using a self-signed certificate, add the

certificate into the trustStore for Library server. Refer to the
trustStore.path property.

Copyright © 2021 All Rights Reserved 346

In st allat io n an d Co n figu r at io n Gu id e

If the Modeling service certificate is signed by a private root CA, add

the private root certificate into the trustStore for Library server.

If the trustStore for Library server is not set, configure the correct path
and passphrase.

trustStore.path=path/to/trustStore.jks
trustStore.passphrase=passphrase

2. Enable the TLS communication to the Modeling service.

If the Modeling service is using a self-signed certificate or the

certificate is signed by a private root CA, set it to true. If the certificate
is signed by a public root CA, set to false.

services.MicroStrategy-Modeling-Service.tlsEnabled = true

3. Restart the Library server.

Configure Modeling Service When Intelligence Server is TLS

Enabled
When the Intelligence server is TLS enabled, configuration changes are
needed in the Modeling service side to enable the TLS communication
between the Modeling service and Intelligence server.

You have configured the Intelligence server to use SSL encryption. See
Configuring Secure Communication for MicroStrategy Web, Mobile Server, and
Developer in the the System Administration Help for more information.

You have configured MicroStrategy Library to communicate with the

Intelligence server with SSL enabled.

Enable related configurations in the modelservice.conf file, in the

following locations:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin\

Linux: <INSTALL_PATH>/MicroStrategy/ModelingService/admin/

Copyright © 2021 All Rights Reserved 347

In st allat io n an d Co n figu r at io n Gu id e

1. Enable TLS communication to Intelligence server.

modelservice.iserver.tlsEnabled = true

2. Add Intelligence server certificates into trustStore.

If Intelligence server is using a self-signed certificate, add the

certificate into the trustStore for the Modeling service. Refer to the
modelservice.trustStore.path property.

If the Intelligence server certificate is signed by a private root CA, add

the private root certificate into the trustStore for the Modeling service.

3. Configure the trustStore and passphrase for the Modeling service.

modelservice.trustStore.path= path/to/trustStore.jks
modelservice.trustStore.passphrase=passphrase

4. Restart the Modeling service.

Troubleshooting the Modeling Service

This section describes the errors you may encounter when using the
Modeling service and how to troubleshoot them.

Make your configuration changes to the configuration files under the admin
folder. Do not change the files under the conf folder. All files under the
conf folder are overwritten when you upgrade MicroStrategy.

The configuration files can be found in:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin

Linux: <INSTALL_PATH>/MicroStrategy/ModelingService/admin

See the following topics to enable relevant loggings if necessary:

l Logging in Modeling Service

l Logging on Library Server for Modeling Service

Copyright © 2021 All Rights Reserved 348

In st allat io n an d Co n figu r at io n Gu id e

Error Troubleshoot

Make sure the Library server is

The New Filter option is disabled in
upgraded to MicroStrategy 2020 Update
Workstation.
2 or a later version.

Make sure the "modelservice.identity_

The MicroStrategy Modeling service is not
token.secret_key" in the
configured with the correct secret key. Please
modelservice.conf file is configured
set identity_token.secret_key in
correctly. It should be the same as
“modelservice.config“ to the same value as
"identityToken.secretKey" in the Library
corresponding property in MicroStrategy
server configOverride.properties
Library.
file.

Make sure the "modelservice.identity_

An error occurs when restoring the IdToken: token.secret_key" in the

modelservice.conf file is configured
Error restoring identity token. Please, validate correctly. It should be the same as
that the 'identityTokenSecretKey' is configured "identityToken.secretKey" in the Library
correctly. server configOverride.properties
file.

Make sure the “modelservice.identity_

An error occurs when restoring the IdToken: token.secret_key“ in the

modelservice.conf file is configured
JWT signature does not match locally computed correctly. It should be the same as
signature. JWT validity cannot be asserted and “identityToken.secretKey“ in the Library
should not be trusted. server configOverride.properties
file.

An error occurs when building the Intelligence

Make sure
server session: Connection failed: Unable to
“modelservice.truststore.path“ in the
find path to the certification target. Please
modelservice.conf file is configured
verify that the path to the certification is correct
correctly.
and restart the MicroStrategy Web Server.

Check to make sure:

The MicroStrategy Modeling service is not
1. The Modeling service is running.
running, or MicroStrategy Library server cannot
find it or is not configured correctly. 2. The Modeling service is running on
the expected port.

Copyright © 2021 All Rights Reserved 349

In st allat io n an d Co n figu r at io n Gu id e

Error Troubleshoot

3. The firewall is open for the

Modeling service port.

This can be caused by accidentally

deleting the RUNNING_PID file under
the ModelingService root directory. To
On Linux, using the command, sh stop the Modeling service, run the
./bin/modelservice.sh stop, to stop a following command in a terminal:
running Modeling service under the
# query the running process id
ModelingService root directory returns,
of Modeling Service
"Modeling service is not running," in the
$ pgrep -f ModelingService
console output.
8952
# kill the process directly
$ kill -9 8952

When an SSL validation related error is

received, make sure the truststore name
An error is returned in the Filter editor: SSL and truststore password are correct in
Configuration issue. the configOverride.properties
The error can be found in the Library log: filed located at <tomcat root
directory>/webapps/MicroStrate
[Error] [main] [CEFPluginBridge.swift:48]
gyLibrary/WEB-
logError(_:) > fetchUtils::checkStatus(): ,
INF/classes/config.
{"code":"ERR024","message":"SSL
Configuration To troubleshoot connectivity issues
issue","ticketId":"af1441eec17e41969af9ee144 between the Library server and Modeling
92f4bb7"} service, please enable logs on the
Library server. See Logging on Library
Server for Modeling Service.

The logging functionality fails when starting the

This error is caused when using
Modeling service in command line.
start.bat in command line while the
1. main ERROR Unable to move file Modeling service is already started from
C:\Program Files Services. Use stop.bat to exit and run
(x86)\MicroStrategy\ModelingService\.\lo start.bat again, or start from
gs\ModelService.log to C:\Program Files Services, to restart Model service.

Copyright © 2021 All Rights Reserved 350

In st allat io n an d Co n figu r at io n Gu id e

Error Troubleshoot

(x86)\MicroStrategy\ModelingService\.\lo
gs\ModelService-2020-06-24-15-45.log:
java.nio.file.FileSystemException
C:\Program Files
(x86)\MicroStrategy\ModelingService\.\lo
gs\ModelService.log -> C:\Program Files
(x86)\MicroStrategy\ModelingService\.\lo
gs\ModelService-2020-06-24-15-45.log:
The process cannot access the file
because it is being used by another
process.
2. main ERROR Unable to delete file
C:\Program Files
(x86)\MicroStrategy\ModelingService\.\lo
gs\ModelService.log:
java.nio.file.FileSystemException
C:\Program Files
(x86)\MicroStrategy\ModelingService\.\lo
gs\ModelService.log: The process cannot
access the file because it is being used
by another process.

The Topology error messages are returned: Check to make sure:

1. Something when wrong. Unable to 1. The Modeling service is running.

start/stop the Model service, the following 2. The Modeling service is running on
are possible solutions. the expected port.
a. Services Registration use SSH 3. The firewall is open for the
command to start/stop the service, Modeling service port.
please ask your administrator to 4. The secret key set on the Library
make sure the SSH Server is server and Modeling service are
running on the target machine. the same.
b. Please restart web container on 5. If HTTPS is enabled between the
target machine and try to start/stop Library server and Modeling
the service again. service, please ensure it is
c. Please ask your administrator to configured correctly. For more

Copyright © 2021 All Rights Reserved 351

In st allat io n an d Co n figu r at io n Gu id e

Error Troubleshoot

retrieve related information from the

log file if the problem persists.
d. Please check Topology Services
Tab to see whether all depended
services are up.
details, please refer to Configure
2. Something went wrong. Unable to
HTTPS Connection Between
start/stop the service. This can happen
Library Server and Modeling
when the credential you input does not
Service.
have the permissions or the SSH
command has failed to execute. If the
problem persists, please contact your
administrator.
3. Something went wrong.

The HTTPS connection between

MicroStrategy Library and the Modeling
service is not configured correctly.
Unable to connect to the service using a secure
TLS channel. For steps on configuring HTTPS
connection, please refer to Configure
HTTPS Connection Between Library
Server and Modeling Service.

The TLS/SSL connection between the

Modeling service and the Intelligence
The TLS/SSL between the MicroStrategy server is not configured correctly.
Modeling service and MicroStrategy Intelligence
server is not configured correctly due to the For steps on configuring TLS enabled

invalid trust store path: The path provided was between the Modeling service and the

not valid, please double-check that it exists. Intelligence server, please refer to
Configure Modeling Service When
Intelligence Server is TLS Enabled.

An error occurs when opening a fact object via

This is a known defect that is being
the Workstation Fact editor:
investigated by the Technology team.
"Model Server internal error: Invalid argument:
Please use MicroStrategy Developer as
The requested fact does not contain the
a workaround. See KB484818.
requested expression."

Copyright © 2021 All Rights Reserved 352

In st allat io n an d Co n figu r at io n Gu id e

Error Troubleshoot

Or

"Model Server internal error: No value present."

Logging in Modeling Service

The Modeling service uses log4j 2 to support the logging requirements.

By default, the logs for the Modeling service are enabled at the "INFO"
level. For more information about the standard log levels built into Log4J,
see Custom Log Levels on the Apache website.

The log files can be found in:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\logs\

Linux: <INSTALL_PATH>/MicroStrategy/ModelingService/logs/

Custom ize the Logging in the Modeling Service

Follow the procedures below to customize the logging in the Modeling

service.

En ab l e t h e Co n f i gu r at i o n Fi l e f o r Lo ggi n g

1. Locate the logging configuration template file, log4j2.xml.template

in:

Windows: <INSTALL_
PATH>\MicroStrategy\ModelingService\admin

Linux: <INSTALL_
PATH>/MicroStrategy/ModelingService/admin

Copyright © 2021 All Rights Reserved 353

In st allat io n an d Co n figu r at io n Gu id e

2. Under the admin folder, make a copy of log4j2.xml.template and

rename it to log4j2.xml.
3. Restart the Modeling service.

Ch an ge t h e Lo g Level f o r t h e M o d el i n g Ser vi ce

If a more detailed log is needed for troubleshooting:

1. Enable the configuration file for logging.

2. Under the admin folder, modify log4j2.xml.
3. Change the level to "DEBUG" or "TRACE".

<Root level="INFO" includeLocation="false">

4. Restart the Modeling service.

M ai n t ai n t h e Lo g Hi st o r y

By default, the Modeling service keeps the log for the last 30 days or the
most recent 45 files, whichever comes first. To configure a different log
history:

1. Enable the configuration file for logging.

2. Under the admin folder, modify log4j2.xml.
3. Change the values for the following properties:

<IfLastModified age="30d" />

<IfAccumulatedFileCount exceeds="45" />

4. Restart the Modeling service.

Logging on Library Server for Modeling Service

To troubleshoot connectivity issues between the Library server and
Modeling service, you need to enable the logs on the Library server.

Copyright © 2021 All Rights Reserved 354

In st allat io n an d Co n figu r at io n Gu id e

1. Locate the logback.xml file in:

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

Files\MicroStrategy\Tomcat\apache-tomcat-9.0.30\
webapps\MicroStrategyLibrary\WEB-INF\classes\

Linux: <TOMCAT_INSTALL_
DIRECTORY>/webapps/MicroStrategyLibrary/WEB-
INF/classes/

2. Edit the logback.xml file. Add the following code to enable the log for
the Modeling service.

<logger name="com.microstrategy.auth.util.ProxyServiceUtil"
level="DEBUG" additivity="false">
<appender-ref ref="SIFT" />
<appender-ref ref="STDOUT"/>
</logger>

3. Restart the Library server.

4. The log file can be found in:

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

Files\MicroStrategy\Tomcat\apache-tomcat-9.0.30\
logs\MicroStrategyLibrary-MicroStrategyLibrary.log

Linux: <TOMCAT_INSTALL_
DIRECTORY>/bin/logs/MicroStrategyLibrary-
MicroStrategyLibrary.log

Copyright © 2021 All Rights Reserved 355

In st allat io n an d Co n figu r at io n Gu id e

A CTIVATIN G YOUR
I N STALLATION

Copyright © 2021 All Rights Reserved 356

In st allat io n an d Co n figu r at io n Gu id e

After your MicroStrategy installation is complete, you have 30 days to

activate your installation. Before you activate your installation you must
request an activation code from MicroStrategy. You can complete this
request when you install MicroStrategy with the MicroStrategy Installation
Wizard or after installation using MicroStrategy License Manager or
automated server activation.

Requesting an Activation Code

You can request an activation code by supplying MicroStrategy with
important information related to your installation. The information you
provide helps MicroStrategy understand how you plan to use MicroStrategy
software. With this information MicroStrategy can provide better information
and technical support for your software configuration.

On Windows, MicroStrategy products can be activated only in graphics user

interface (GUI) mode, using License Manager.

MicroStrategy products can be activated on Linux, either in GUI mode or in

command line mode, using License Manager. In both cases, License
Manager runs and requests the same information. The main differences are
in how you provide the information and navigate through the activation code
request steps.

Request an activation code with License Manager

If you requested an activation code during installation you can skip this
procedure and activate your installation by following the instructions in the
next procedure, Activate your software installation, page 359.

1. Open MicroStrategy License Manager:

l Windows: Go to Start > Programs > MicroStrategy Tools >
License Manager. License Manager opens.

Copyright © 2021 All Rights Reserved 357

In st allat io n an d Co n figu r at io n Gu id e

l Linux: License Manager can be run in GUI mode or command line

mode.
n GUI: In a Linux console window, browse to HOME_PATH where
HOME_PATH is the specified home directory during installation.
Browse to the folder bin and type ./mstrlicmgr, then click
Enter. 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 specified home directory during
installation.Browse to the folder bin and type ./mstrlicmgr -
console, then click Enter. The MicroStrategy License Manager
opens in command line mode.

The steps to request an activation code in command line mode of

License Manager vary from the steps below. Refer to the License
Manager command line prompts to guide you through the steps to
request an activation code. For more information specific to
requesting an activation code for your installation in command line
mode, refer to MicroStrategy Tech Note TN13550.

2. Select the License Administration tab. Under Server Activation select

the Activate Server Installation option and click Next.
3. Select the Generate Activation File and Request Activation Code
option and click Next .
4. Enter the characteristics of your server installation and click Next .
5. Enter the contact information for the person who installed the software.
Make sure to correctly select whether you are an employee of the
licensed company or installing the software on the licensed company's
behalf.
l If you select that you are an employee of the licensed company, click
Next. Once you complete the following step, the activation code is
sent to the email address given; therefore it is important that the
email address is valid and entered correctly.

Copyright © 2021 All Rights Reserved 358

In st allat io n an d Co n figu r at io n Gu id e

l If you select that you are not an employee of the licensed company, a
contact information page is displayed after you click Next. Enter the
contact information for the licensed company. Click Next. Once you
complete the following step, the activation code is sent to the email
address given; therefore it is important that the email address is valid
and entered correctly.
6. Select Yes, I want to request an Activation Code now and click
Next.

An email containing the activation code is sent to the email address or

addresses you confirmed in the steps above.

Activating Your Installation Using License Manager

After you have requested an activation code, MicroStrategy sends an email
to the addresses provided in the request. This email contains the activation
code that is necessary to complete the activation of your installation.

Activate your software installation

This procedure assumes that you have requested an activation code and
received an email 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 Installation
and click Next .
3. Select the Server Activation using Activation Code option and enter
your activation code in the text field. Click Next .
4. Click OK.

Copyright © 2021 All Rights Reserved 359

In st allat io n an d Co n figu r at io n Gu id e

Linux

1. License Manager can be run in GUI mode or command line mode:

l GUI: In a Linux console window, browse to HOME_PATH where HOME_

PATH is the specified home directory during installation. Browse to
the folder bin and type ./mstrlicmgr, then click 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 specified home directory during installation.
Browse to the folder bin and type ./mstrlicmgr -console, then
click Enter. The MicroStrategy License Manager opens in command
line mode.

The steps to activate your installation in command line mode of

License Manager vary from the steps below.

2. Go to the License Administration tab > Activate Server Installation

and click Next .

The step above is not necessary for License Manager in command line
mode.

3. Select the Server Activation using Activation Code option and enter
your activation code in the text field. Click Next .
4. Click OK.

You must restart your Intelligence Server for the activation status to update.
You must also restart your Web server for the activation status to update in
MicroStrategy Web.

Remember to select the correct environment "use" type during activation.

Please see Select Environment Type for Crash Reports for details on how
such an environment information can help debug issues.

Copyright © 2021 All Rights Reserved 360

In st allat io n an d Co n figu r at io n Gu id e

Activating Your Installation Using Silent Mode

The License Manager allows for a silent activation mode, which is referred to
as automated server activation. Automated server activation reads from a
pre-configured response file to automatically retrieve and apply the
activation code from MicroStrategy's Licensing website. This functionality is
available in both Windows and Linux environments through the console with
the same response file across operating systems.

Windows Activation
When executing Windows License Manager automated activation through
the console or via script, the session for the execution requires an elevated
privilege set to complete successfully. When searching for the response file
by providing just the name, the system searches the current working
directory that License Manager is called from.

Use the following command for Windows activation:

MALicMgr.exe -activate -f Response_File [-l Log_File] [-showoutput]

Linux Activation
When executing Linux License Manager automated activation through the
terminal or via script, the session requires access to the License Manager
executable. You should not have to use the root, although this is dependent
on system configuration. When searching for the response file by providing
just the name, the system searches the home directory. The default home
directory is /var/opt/MicroStrategy.

Use the following command for Linux activation:

mstrlicmgr -activate -f Response_File [-l Log_File] [-showoutput]

Copyright © 2021 All Rights Reserved 361

In st allat io n an d Co n figu r at io n Gu id e

Windows and Linux Activation

In both Windows and Linux, if no specific log file is given, the default
License Manager log located in the MicroStrategy logging directory is used.
After a successful activation, an e-mail is sent. This email is similar to the
traditional activation e-mail with details of the activation for record keeping.
In the Activation Information section of the automated email, the Activation
Method is listed as Automatic.

After the activation is complete, you can verify it in License Manager. It is

not recorded in the same manner as a manual activation to allow for tracking
of changes within the environment.

Sample Response File

Use the following sample response file to set up automated activation:

; MicroStrategy Secure Enterprise Automatic Activation Response File.

; Usage:
; Linux mstrlicmgr -activate -f Response_File [-l Log_File] [-
showoutput]
; Windows MALicMgr.EXE -activate -f Response_File [-l Log_File] [-
showoutput]

; System Information for Server Activation

[System]
SystemName=
SystemLocation=
;SystemUse = 1 to 5 (1-production,2-development,3-testing,4-training,5-
other)
SystemUse=

Copyright © 2021 All Rights Reserved 362

In st allat io n an d Co n figu r at io n Gu id e

; Licensed User information for MicroStrategy Point of Contact within the

company.
[LicensedCustomer]
UserCompanyName=
UserFirstName=
UserLastName=
UserDepartment=
UserTitle=
UserEmail=
UserPhone=
UserStreet=
UserCity=
UserState=
UserPostal=
UserCountry=
;InstallerIsLicensedUser = true or false,
; Set it to true if the person installing the software is an employee of
the licensed company.
; If set to true, please leave the [Installer] section blank.
; Set it to false if somebody is installing on behalf of the licensed
company.
; If set to false, please fill the [Installer] section.
InstallerIsLicensedUser=

[Installer]
InstallerCompanyName=
InstallerFirstName=
InstallerLastName=
InstallerDepartment=
InstallerTitle=
InstallerEmail=
InstallerPhone=
InstallerStreet=
InstallerCity=
InstallerState=
InstallerPostal=
InstallerCountry=

Copyright © 2021 All Rights Reserved 363

In st allat io n an d Co n figu r at io n Gu id e

Deactivation
Automated deactivation can be done the same way, using the -deactivate
flag.

Use the following command for Windows deactivation:

MALicMgr.exe -deactivate

Use the following command for Linux deactivation:

mstrlicmgr -deactivate

Server Activation FAQ

What is MicroStrategy server activation?
MicroStrategy server activation is a licensing technology that ensures that
installations of MicroStrategy server products are authentic and have been
legitimately licensed. Server activation registers each server installation
with MicroStrategy and locks the installation to a specific machine.

Why is server activation necessary?

Server activation provides benefits to both MicroStrategy and its customers:

l It ensures that the software products being used are authentic.

l It helps customers in identifying software installations to prevent over-
installation.
l It improves customer service by maintaining a register of the hardware
configurations used by our customers.

Does MicroStrategy adhere to best practices for software

activation?
Yes. Extensive research was performed on software activation and it was
found that the Business Software Alliance (www.bsa.org) provides the most
comprehensive information. MicroStrategy has closely followed these best
practices.

Copyright © 2021 All Rights Reserved 364

In st allat io n an d Co n figu r at io n Gu id e

Which products require activation?

All MicroStrategy modular and non-modular server products require server
activation, including:

l Intelligence Server, Intelligence Server Module, Clustering Option, Report

Services, Report Services Option, OLAP Services, OLAP Services Option,
Distribution Services, MultiSource Option
l Web, Web Reporter Module, Web Analyst Option, Web Professional
Option
l Mobile Server
l Narrowcast Server Delivery Engine

If more than one server product is installed on the same

machine, does each server product need to be activated and
deactivated separately?
No. All MicroStrategy server products installed on a single machine are
grouped as a server installation and are activated and deactivated as a
group.

Which customers are required to activate MicroStrategy server

products?
All customers who install MicroStrategy server products need to activate
their server installations.

Is a new CD key needed to install products on different

machines?
No. Server activation has no impact on CD keys. The latest CD key sent by
MicroStrategy can be used to install products on many machines. The only
difference is that each installation on a different machine needs a different
activation code to activate the installation. Server activation is independent
of the CD keys.

Copyright © 2021 All Rights Reserved 365

In st allat io n an d Co n figu r at io n Gu id e

Is server activation required for both named-user and CPU

based licenses?
Yes. Server activation is required for both named-user and CPU based
licenses. Server activation is designed to track software installations
regardless of licensing model. Server activation does not manage or limit the
number of servers on which server software is installed.

Does server activation aggregate the total number of licenses

installed and prevent over-installation of products?
No. Server activation and the licensing models are independent. However,
using server activation information available at
https://licensing.microstrategy.com, organizations can monitor
the number of installations. Deactivating server installations that are not
being used ensures this information is up-to-date.

Does server activation apply to evaluation editions?

Yes. Evaluation editions must be activated within seven days of installation.

What is the procedure for activating server installations?

Installing, modifying, or upgrading MicroStrategy server installations
automatically generates an activation XML file that contains information
about the installation. This XML file, referred to as the "activation file" is
uploaded to MicroStrategy automatically by the installation routine, through
License Manager, manually uploading the activation file at
https://licensing.microstrategy.com, or using automated server
activation. MicroStrategy then creates a machine-specific activation code
that is emailed to the installer and MicroStrategy Tech Support liaisons. The
activation code must be manually entered into License Manager on the
target server installation, unless you are using automated server activation.

What information is sent to MicroStrategy in the activation

XML file?
The following information is sent to the activation XML file:

Copyright © 2021 All Rights Reserved 366

In st allat io n an d Co n figu r at io n Gu id e

l Installation Information:
n Installation timestamp
n Activation ID (if the installation has previously been activated)
n Contract information
n CD Key used in installation
n Installer contact details – name, address, email
n Company contact details – name, address, email
n Server installation information – name, location, use
l Hardware information:
n Unique hardware identifier
n CPU information – type, bit-size, clock speed, total quantity
n Physical memory installed
l Operating system information:
n Type, version, bit-size, page/swap size
n Locale
n Additional information – 4GT mode and hyperthreading in Windows
l MicroStrategy information:
n Install type – new/modify/upgrade
n Products and version installed
n Number of CPUs allocated for CPU licenses
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 file is sent to MicroStrategy in the following ways:

l Automatically during installation or through License Manager. This

information is encrypted using a RIPEMD-160 algorithm before being sent

Copyright © 2021 All Rights Reserved 367

In st allat io n an d Co n figu r at io n Gu id e

to MicroStrategy.
l Manually in the https://licensing.microstrategy.com website.
Communication with this website is conducted through Secure Socket
Layer once the user has been authenticated.

Can I change the information in the activation XML file?

The content of this file is secured with a digital signature. Contact
MicroStrategy Technical Support if the content is incorrect.

What is used to lock the server to a machine?

A unique hardware identifier for each machine is used to lock an installation
to that machine. Any changes to these identifiers will require reactivation of
the Server Installation:

l Windows: An identifier generated from a one-way hash of the network

interface card MAC address
l Linux: An identifier generated from a one-way hash of the network
interface card MAC address

Is there a grace period from the time server products are

installed to when it can be activated?
Yes. There is a 30 calendar day grace period from installation (seven days
for an evaluation edition) before a server installation must be activated.

What happens if the server installations are not activated?

If a server installation has not been activated within 30 calendar days (7
days for an evaluation edition), the server products cannot be restarted.

Should the installations be automatically or manually activated

and deactivated?
It is preferable to automatically send the activation information to
MicroStrategy, either during installation or using License Manager. This is
an easy process that should take less than one minute to complete, and
ensures that the correct information is sent to MicroStrategy.

Copyright © 2021 All Rights Reserved 368

In st allat io n an d Co n figu r at io n Gu id e

What should be done if requesting an activation code fails

during installation?
First, allow the installation to complete. The activation code request should
then be attempted using License Manager. If this does not work, activate the
server installation manually by visiting the activation website at
https://licensing.microstrategy.com.

What should be done if automatic request for an activation

code does not work?
The server installation should be manually activated using License Manager
on a machine that has access to the Web. The activation XML file should be
copied from the server installation that requires activation to this computer.
If this does not work, contact MicroStrategy Technical Support.

Can the activation code be used on different machines?

No. The activation code contains the unique identifier for a specific machine
and can only be used on that machine. The server products are not activated
if the incorrect activation code is used.

What if the server installation has to be moved to another

machine?
If the server installation needs to be moved to another machine, uninstall the
MicroStrategy products or deactivate the server Installation from License
Manager. Notify MicroStrategy that the server installation has been
deactivated. This keeps your active server inventory up to date at
https://licensing.microstrategy.com.

What if the server machine has a catastrophic failure and

cannot be deactivated automatically or manually?
If a machine has a catastrophic failure and the server products cannot be
uninstalled or deactivated, contact MicroStrategy Technical Support to
update the status of the server.

Copyright © 2021 All Rights Reserved 369

In st allat io n an d Co n figu r at io n Gu id e

If there is more than one server product installed on a machine

and one is removed, does the server installation need to be
deactivated?
Upon removal of a server product, all remaining server products are
automatically deactivated. The remaining server product(s) need to be
reactivated to reflect the new product configuration on that machine. For
example, if a machine contains MicroStrategy Narrowcast Server and
MicroStrategy Web, and MicroStrategy Narrowcast Server is removed,
MicroStrategy Web is automatically deactivated. MicroStrategy Web will
need to be reactivated.

What information can be monitored on the website?

When registered Technical Support liaisons log into the MicroStrategy
Activation website, they can display a list of all server installations. This
report lists each server installation along with the following information for
reference:

l Installation 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 installed
l Activation and deactivation history

The Installation ID is a unique identifier for server installations. This ID is

provided along with the activation code in the email received when
requesting activation.

Copyright © 2021 All Rights Reserved 370

In st allat io n an d Co n figu r at io n Gu id e

Does server activation apply to the MicroStrategy Suite?

Yes. The MicroStrategy Suite must be activated within 30 days of
installation.

Configuring your MicroStrategy Installation

After completing the steps to activate your installation, you can continue
your setup and configuration. To help guide the rest of your installation and
configuration steps, refer to the section Installation and Configuration
Checklists, page 139 in Chapter 1, Planning Your Installation, for installation
and configuration checklists.

Copyright © 2021 All Rights Reserved 371

In st allat io n an d Co n figu r at io n Gu id e

CON FIGURIN G AN D
CON N ECTIN G
I N TELLIGEN CE SERVER

Copyright © 2021 All Rights Reserved 372

In st allat io n an d Co n figu r at io n Gu id e

After installing MicroStrategy, you must complete a few configuration tasks.

This chapter addresses the processes used to configure the databases you
intend to use in your business intelligence system, as well as an installed
MicroStrategy suite of products.

The MicroStrategy platform includes a Tutorial project, which is a sample

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

This chapter includes the following information:

If you are configuring MicroStrategy on a Linux machine that does not have
a GUI, you can perform configuration tasks with command line tools. For
steps to perform configuration tasks using command line tools in Linux, see
Chapter 11, Configuring MicroStrategy Using Command Line Tools.

Communicating with Databases

Establishing communication between MicroStrategy and your databases or
other data sources is an essential first step in configuring MicroStrategy
products for reporting and analyzing data. This section explains how
MicroStrategy communicates with various data sources and the steps
required to set up this communication.

ODBC (Open Database Connectivity) is a standard database access

method. ODBC enables a single application to access database data,
regardless of the database management system (DBMS) that stores the
data. A DBMS is a collection of programs that enables you to store, modify,
and extract information from a database.

MicroStrategy Intelligence Server, when used in a three- or four-tier

configuration, is the application that uses ODBC to access a DBMS. ODBC

Copyright © 2021 All Rights Reserved 373

In st allat io n an d Co n figu r at io n Gu id e

drivers translate MicroStrategy Intelligence Server requests into commands

that the DBMS understands. MicroStrategy Intelligence Server connects to
several databases (at a minimum, the data warehouse and the metadata
repository) to do its work.

Users of MicroStrategy Web can also connect to data sources using

database connections. A database connection supports connecting to data
sources through the use of DSNs, as well as through DSNless connections,
to import and integrate data into MicroStrategy. For steps to create database
connections in MicroStrategy Web, see Creating Database Connections in
Web, page 737.

This section describes the ODBC standard for connecting to databases and
creating data source names (DSNs) for the ODBC drivers that are bundled
with the MicroStrategy applications.

The diagram below illustrates the three-tier metadata and data warehouse
connectivity used in the MicroStrategy system.

Copyright © 2021 All Rights Reserved 374

In st allat io n an d Co n figu r at io n Gu id e

The diagram shown above illustrates projects that connect to only one data
source. However, MicroStrategy allows connection to multiple data sources
in the following ways:

l With MicroStrategy MultiSource Option, a MicroStrategy project can

connect to multiple relational data sources. For information on MultiSource
Option, see the Project Design Help.
l You can integrate MDX cube sources such as SAP BW, Microsoft Analysis
Services, and Hyperion Essbase with your MicroStrategy projects. For
information on integrating these MDX cubes sources into MicroStrategy,
see the MDX Cube Reporting Help.

This section provides information and instructions on the following tasks:

Copyright © 2021 All Rights Reserved 375

In st allat io n an d Co n figu r at io n Gu id e

Setting up ODBC
The following information assists you in setting up ODBC between
Intelligence Server and your metadata database and data warehouse.

ODBC is a standard method of communicating with database servers.

Intelligence Server uses ODBC to connect to and communicate with all
database servers in the system. Specifically, ODBC connects to and
transfers data to and from data sources within relational databases.

ODBC permits maximum interoperability—an application can access data in

diverse DBMSs through a single framework. A client application uses a
database driver and a driver manager to make a connection to the data
source. A data source, identified by a data source name, is the database or
file accessed by a driver. Data source is another term for a logical database
within a database server. A database server can contain multiple logical
databases or data sources.

When setting up your MicroStrategy environment, you must create a

separate connection to the data warehouse and metadata repository. This
requirement is true even if both databases are accessed through the same
DBMS. Further description of these two requirements is below:

l A data warehouse stores the data that users of the system must analyze to
track and respond to business trends, and to facilitate forecasting and
planning efforts.
l Metadata is a repository whose data associates the tables and columns of
a data warehouse with user-defined attributes and facts to enable the
mapping of business views, terms, and needs to the underlying database
structure. Metadata can reside on the same server as the data warehouse
or on a different server. It can be stored in different relational DBMSs.

A successful ODBC connection requires the following information:

l A data source name (DSN) is the name for a pointer used by a client
application to find and connect to a data source. A data source is the
database accessed by a driver. The information obtained through a DSN

Copyright © 2021 All Rights Reserved 376

In st allat io n an d Co n figu r at io n Gu id e

generally includes the host computer name or IP address, instance name,

and database name. However, the exact information varies depending on
the type of database server.
l An ODBC driver is a type of software that translates information between
the client application (Intelligence Server) and the database server API.
For more information on ODBC drivers and how they work with
MicroStrategy, see ODBC drivers, page 377.
l A connection string stores the information required to connect to a
database server. A connection string usually includes a DSN, as well as
the user ID and password required to log in to the database server. This
information varies depending on the particular database server. For
MicroStrategy environments, a connection string is commonly provided by
a database instance (see Creating a database instance, page 446).

ODBC drivers
ODBC drivers are DBMS-specific and must be installed on MicroStrategy
Intelligence Server prior to creating the ODBC connection to the warehouse
and metadata databases. MicroStrategy embeds and brands Progress and
Magnitude ODBC drivers in the MicroStrategy platform. These drivers are
certified to work with MicroStrategy products.

The purpose of an ODBC driver is to translate MicroStrategy Intelligence

Server requests into commands that the DBMS understands. Users of the
MicroStrategy platform can employ the MicroStrategy-branded ODBC drivers
to connect MicroStrategy products to various DBMSs. For a list of the
available ODBC drivers for Windows and Linux that are certified for
Intelligence Server and different DBMS types, see Certified ODBC Drivers
for MicroStrategy Intelligence Server, page 130.

• Although it is possible to use a non-certified driver, it is strongly

recommended that you contact your database vendor to obtain a
certified driver if the selected driver is not certified as valid.

Copyright © 2021 All Rights Reserved 377

In st allat io n an d Co n figu r at io n Gu id e

• MicroStrategy products include certified ODBC drivers for you to use.

The MicroStrategy Readme lists these MicroStrategy ODBC drivers.

Default location for ODBC and driver files for Windows

MicroStrategy components require 64-bit drivers to achieve ODBC

connectivity.

The ODBC driver manager and support libraries are commonly installed in
the C:\WINDOWS\SYSTEM or C:\WINDOWS\SYSTEM32 directories. Refer to
your third-party documentation for the locations of ODBC support and driver
files.

The database-specific ODBC drivers are installed in the locations specified

during the installation of the drivers. MicroStrategy-branded drivers are
installed in C:\Program Files (x86)\Common Files\MicroStrategy
on a 64-bit Windows environment.

Default location for ODBC and driver files for Linux

MicroStrategy components require 64-bit drivers to achieve ODBC

connectivity.

The ODBC driver manager and support libraries are usually installed in
INSTALL_PATH/lib

The database-specific ODBC drivers are installed in the locations specified

during the installation of the drivers. MicroStrategy-branded ODBC drivers
are installed in INSTALL_PATH/lib, where INSTALL_PATH is the directory
you specified as the Install Directory in the Install Wizard.

The MicroStrategy Connectivity Wizard lists only the MicroStrategy-branded

ODBC drivers. However, this guide also provides information on how to
install drivers from other vendors with MicroStrategy. For more information,
see Creating DSNs for Specific Data Sources, page 697.

Copyright © 2021 All Rights Reserved 378

In st allat io n an d Co n figu r at io n Gu id e

Defining DSNs
After you install an ODBC driver, you can define one or more data sources
for it. The DSN should provide a unique description of the data, for example,
Payroll_Project_Metadata or Payroll_Warehouse.

The DSN is the name for a pointer used by a client application (in this case
MicroStrategy) to find and connect to a data source. Multiple DSNs can point
to the same data source and one DSN can be used by different applications.

You can define a data source connection with a DSN by using:

l The MicroStrategy Connectivity Wizard—configures connectivity to data

sources by creating a DSN that uses a MicroStrategy-branded ODBC
driver (see Creating a DSN for a data source, page 379).
l The Microsoft ODBC Data Source Administrator—creates a DSN for an
ODBC driver that is not MicroStrategy-branded (see Managing ODBC and
data sources with Microsoft ODBC Data Source Administrator, page 381).
l Edit the odbc.ini on Linux. For more information, please see Configuring
ODBC Parameters with odbc.ini.

It is strongly recommended you use the MicroStrategy Connectivity Wizard

when creating a new DSN for a MicroStrategy-branded ODBC driver. Use
the Microsoft ODBC Data Source Administrator only if you intend to use a
driver that is not MicroStrategy-branded.

If you create DSNs using the Microsoft ODBC Data Source Administrator,
you must create system DSNs. Otherwise, MicroStrategy interfaces will not
recognize them.

Creating a DSN for a data source

If a DSN does not already exist in your empty metadata repository or the
repository installed with MicroStrategy, you can add or create a new one.

Copyright © 2021 All Rights Reserved 379

In st allat io n an d Co n figu r at io n Gu id e

The MicroStrategy Connectivity Wizard is a tool designed specifically to

configure connectivity to data sources by creating a DSN that uses a
MicroStrategy-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 Connectivity Wizard interface, perform the following steps:

l In a Linux console window, browse to HOME_PATH where HOME_
PATH is the specified home directory during installation.
l Browse to the folder bin and type ./mstrconnectwiz, and then
press ENTER.
l From the command line, perform the following steps:
l In a Linux console window, browse to HOME_PATH where HOME_
PATH is the specified home directory during installation.
l Browse to the folder bin and type ./mstrconnectwiz -h, and
then press ENTER.
l This command displays command line operation syntax and
examples for different database platforms. Create your command
based on the syntax and examples displayed. Once you perform
your command, the DSN is created and no further action is
required. For detailed steps on how to use the command line
version of this tool, see Creating a DSN for a Data Source, page
638 in Chapter 11, Configuring MicroStrategy Using Command Line
Tools.
3. Click Next.

Copyright © 2021 All Rights Reserved 380

In st allat io n an d Co n figu r at io n Gu id e

4. Select a database driver with which to create a DSN and click Next.

Only a few databases can contain metadata repositories. For details,

refer to the MicroStrategy Readme. Only DSNs created to connect to
these databases can be used to connect to metadata repositories.

5. Enter the information in the appropriate fields for connecting with the
selected database driver. The information to enter varies depending on
the database platform that you selected. For more information, see
Creating DSNs for Specific Data Sources, page 697.
6. Click Test.
7. Enter the User Name and Password to connect to the database.
8. Click Connect. If the test is performed successfully, the connection
with the database is established. If the test fails, verify the correct
connection information with your database administrator and make any
required changes to the information you provided in the previous steps.
9. Click Close, and then Finish.

If you already have an existing DSN with the same name as the one you
provided, a message box appears. You have the following options:

• Select Yes to make sure the DSN points to the location you are
expecting. This overwrites the existing DSN.

• Select No to save the DSN with a different name.

Repeat the above steps to create as many DSNs as you require. At a

minimum, create one for your metadata and one for your warehouse.

Managing ODBC and data sources with Microsoft ODBC Data

Source Administrator
The Microsoft ODBC Data Source Administrator manages database drivers
and data sources on Windows. The Microsoft ODBC Data Source
Administrator utility creates a log with which to trace calls to data sources

Copyright © 2021 All Rights Reserved 381

In st allat io n an d Co n figu r at io n Gu id e

and to view, create, and edit DSNs. The utility is available from Microsoft
and is usually included with the purchase of an ODBC driver.

l It is strongly recommended that you use the Connectivity Wizard when

creating a new DSN for a MicroStrategy-branded ODBC Driver. Use the
Microsoft ODBC Data Source Administrator only if you intend to use a non-
MicroStrategy driver.
l If you choose to create DSNs using the Microsoft ODBC Data Source
Administrator, they must be system DSNs. Otherwise, MicroStrategy
interfaces 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 ability to

create a system-wide DSN, rather than a user-specific DSN.
2. In most Windows systems you can access the ODBC Data Source
Administrator from the Control Panel. Refer to your third-party
Microsoft documentation for steps to access the ODBC Data Source
Administrator tool.
3. Click the System DSN tab.

To view all the installed ODBC drivers, click the Drivers tab.

4. Click Add.
5. Select the desired driver and click Finish.

We recommended that you select a MicroStrategy ODBC driver. These

drivers, whose names start with MicroStrategy, were installed when
you installed the MicroStrategy application on the computer.

6. Enter the information in the appropriate fields to create a data source

for the selected database driver.

Copyright © 2021 All Rights Reserved 382

In st allat io n an d Co n figu r at io n Gu id e

The information to enter varies depending on the database platform

that you selected, which is discussed in Creating DSNs for Specific
Data Sources, page 697.

7. Click OK.

Testing ODBC connectivity

ODBC connectivity is one of two layers of connectivity that are listed in the
next table, along with the associated connectivity testing programs.
Connectivity should be tested from the bottom up—the network layer first
and then the ODBC layer.

Layer Test with

Test ODBC
ODBC driver
mstrtestodbc or mstrtodbcx

Network Simple Network Layer Testing Tool

TCP/IP Ping, PING.EXE , for TCP/IP

The test method described above reflects the situation when the ODBC
driver and the database network software are bundled. If they are not
bundled, they must be configured and tested separately, using database-
specific tools.

Using the DB Query Tool

The MicroStrategy DB Query Tool is available in Windows, and Linux
Intelligence Server installations. It is used to test and troubleshoot
connectivity to databases, create and execute SQL commands through
ODBC, and run scripts.

Before you use the DB Query Tool, test the network layer with the network
layer utility, PING.EXE. Consult your operating system or network system
documentation for details.

Copyright © 2021 All Rights Reserved 383

In st allat io n an d Co n figu r at io n Gu id e

To use the DB Query Tool

1. To use the DB Query Tool:

l On Windows using the DB Query Tool interface, perform the following
step:

From the Windows Start menu, go to Programs > MicroStrategy

Tools > DB Query Tool.

l On Windows from the command line, perform the following steps:

1. From the Windows Start menu, select Run.
2. In the Open drop-down list, type cmd and click OK. A command
prompt opens.
3. Type todbcx.exe and click Enter. Prompts guide you through
testing your ODBC connection from the command line and
should be used in place of the steps below. For detailed steps on
how to use the command line version of this tool, see Testing
ODBC connectivity in Chapter 11, Configuring MicroStrategy
Using Command Line Tools.
l On Linux using the DB Query Tool interface, perform the following
steps:
1. In a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory
during installation.
2. Browse to the folder bin and type ./mstrdbquerytool, then
click Enter.
l On Linux from the command line, perform the following steps:
1. In a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory
during installation.
2. Browse to the folder bin and type ./mstrtodbcx, then click
Enter. Prompts guide you through testing your ODBC connection

Copyright © 2021 All Rights Reserved 384

In st allat io n an d Co n figu r at io n Gu id e

from the command line and should be used in place of the steps
below. For detailed steps on how to use the command line
version of this tool, see Testing ODBC connectivity in Chapter
11, Configuring MicroStrategy Using Command Line Tools.
2. From the Session menu, select Open Connection, or click the
Connect icon on the toolbar. The Connect dialog box opens. The
connection interface varies depending on the destination database.
3. Select the DSN for a data source.
4. Enter the appropriate user name and password.
5. Click Connect. After your connection is opened, the connection string
is displayed in the MicroStrategy DB Query Tool at the bottom. Your
cursor is inserted automatically in the SQL Statement window.
6. In the SQL Statement window, type a SQL query such as:
select count (*) from Table
where Table is a system-defined table, such as SYSOBJECTS for
Microsoft SQL Server or a MicroStrategy-created table such as
DSSMDSYSPROP in the MicroStrategy metadata.

7. From the Queries menu, select Execute Query. A table of data from
the database is displayed in the Query Result window.
8. From the Session menu, select Close Connection to close the
database connection.
9. From the File menu, select Exit.

Initial MicroStrategy configuration

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

Copyright © 2021 All Rights Reserved 385

In st allat io n an d Co n figu r at io n Gu id e

If you are configuring MicroStrategy using the Windows operating system,

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

You can also configure your MicroStrategy installation using the

Configuration Wizard in silent or unattended mode. This allows you to load
an existing setup routine to configure your MicroStrategy installation. For
information on running the Configuration Wizard with a response file, see
Configuring MicroStrategy with a Response File, page 417.

You can also use the Configuration Wizard to create an Enterprise Manager
project, which provides insights about governing and tuning all areas of your
MicroStrategy environment. For steps on how to create an Enterprise
Manager project, see the Enterprise Manager Help.

Configuration Wizard Prerequisites

Before you begin using the Configuration Wizard you should review and
complete the following requirements:

l Install the necessary MicroStrategy products. You should have at least

MicroStrategy Developer and MicroStrategy Intelligence Server installed.
For information on how to install MicroStrategy on Windows, see Chapter
2, Installing MicroStrategy on Windows. For information on how to install
MicroStrategy on other operating systems, see Chapter 3, Installing
MicroStrategy on Linux.
l Have access to an empty database location certified to house the
metadata. This includes creating DSNs for your databases (see
Communicating with Databases, page 373). For a list of certified metadata
platforms, see the MicroStrategy Readme.
l In a Linux environment, the Configuration Wizard must be able to
communicate with Intelligence Server over TCP/IP network protocol. To
achieve this, the hosts file in the /etc directory must include one entry
identifying the local host in the form:

Copyright © 2021 All Rights Reserved 386

In st allat io n an d Co n figu r at io n Gu id e

IP-address local-machine-name

For example, 123.4.5.6 FakeISmachine. Modifying the hosts file may

require an account with root privileges.

l MicroStrategy products must be configured on the machine on which they

are installed. You cannot configure them remotely.

Configuring MicroStrategy Software

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

You can configure a MicroStrategy Web and Intelligence Server (four-tier),

Intelligence Server (three-tier), or direct (two-tier) setup for MicroStrategy.

The following figure describes how to configure MicroStrategy to suit an

Intelligence Server (three-tier) environment. It also shows how the various
components of the MicroStrategy Configuration Wizard, the metadata
repository, Intelligence Server, and the project source interact with each
other.

Copyright © 2021 All Rights Reserved 387

In st allat io n an d Co n figu r at io n Gu id e

A MicroStrategy Web (four-tier) setup involves configuring a web server to

communicate between Intelligence Server and MicroStrategy Web. For more
information on deploying MicroStrategy Web, see Chapter 6, Deploying
MicroStrategy Web and Mobile Server.

The figure below describes how to configure MicroStrategy to suit a direct

(two-tier) environment. It also shows how the various components of the
MicroStrategy Configuration Wizard, the metadata repository and the project
source interact with each other:

It is not recommended to use a direct setup for the production environment.

The procedure below provides the high-level steps to configure

MicroStrategy 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 a
configuration task, page 390.

Copyright © 2021 All Rights Reserved 388

In st allat io n an d Co n figu r at io n Gu id e

l Windows from the command line, then perform the following steps:
l From the Windows Start menu, select Run.
l In the Open drop-down list, type cmd and click OK. A command prompt
opens.
l Type macfgwiz and click Enter.

This command displays the command line version of the Configuration

Wizard. You can configure the connection of a data source to
Intelligence Server by creating a response file or using an existing
response file. The command line prompts guide you through configuring
the connection of a data source to Intelligence Server by creating a
response file or using an existing response file and should be used in
place of the steps below. For information on using a response file to
configure MicroStrategy, see Configuring MicroStrategy with a
Response File, page 417.

l Linux using the Configuration Wizard interface, then perform the following
steps:
l From a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory during
installation.
l Browse to the folder bin and type ./mstrcfgwiz, then click Enter. The
Configuration Wizard opens.
l Linux from the command line, then perform the following steps:
l From a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory during
installation.
l Browse to the folder bin and type ./mstrcfgwiz-editor, then click
Enter.

This command displays the command line version of the Configuration

Wizard. You can configure the connection of a data source to
Intelligence Server by creating a response file or using an existing

Copyright © 2021 All Rights Reserved 389

In st allat io n an d Co n figu r at io n Gu id e

response file. The command line prompts guide you through configuring
the connection of a data source to Intelligence Server by creating a
response file or using an existing response file and should be used in
place of the steps below. For information on using a response file to
configure MicroStrategy, see Configuring MicroStrategy in Command
Line Mode, page 620.

To select a configuration task

Choose from the following configuration tasks and then click Next to begin
the selected task:

l Create Metadata, History List and Enterprise Manager Repositories:

Runs the SQL scripts necessary to create and initialize the metadata
repository, History List tables, and Enterprise Manager statistics tables
and repositories in the database location that you select. For steps to
complete these configuration tasks, see Creating Metadata, History List,
and Statistics Repositories, page 391.
l Configure Intelligence Server: Creates a new server definition object in
the metadata repository that you select. This setup provides Intelligence
Server (three-tier) access to all projects that are stored in the repository.
This option also allows you to use or delete an existing server definition.
For steps to complete these configuration tasks, see Setting up
MicroStrategy Intelligence Server, page 404.
l Create Enterprise Manager project: The Enterprise Manager project
provides insights about governing and tuning all areas of your
MicroStrategy environment. For steps on how to create an Enterprise
Manager project, see the Enterprise Manager Help.
l Create Platform Analytics project: The Platform Analytics project
provides insights about governing and tuning all areas of your
MicroStrategy environment.
l Create a Project Source: A project source contains the configuration
information that each client system requires to access an existing project.

Copyright © 2021 All Rights Reserved 390

In st allat io n an d Co n figu r at io n Gu id e

It stores the location of the metadata repository and Intelligence Server

that is used to run the project. A project source determines how
MicroStrategy Developer, Web, and other client applications access the
metadata. For steps to complete these configuration tasks, see Creating
Project Sources, page 411.
l Upgrade existing environment to MicroStrategy Intelligent
Enterprise: You can use the Configuration Wizard to upgrade your
MicroStrategy environment and migrate various features to the new
version. For all available upgrade and migration options, see the Upgrade
Help.

The remainder of this section describes each configuration option in detail.

After completing these steps, an empty metadata repository is created. To

learn how to add projects to your metadata repository, see the Project
Design Help.

Creating Metadata, History List, and Statistics Repositories

You can create metadata, History List, and statistics and Enterprise
Manager repositories using the MicroStrategy Configuration Wizard.
Repositories for your metadata, History List, and statistics tables are
created in the data source specified by the DSN(s) you connect to.

It is recommended that you create the metadata, History List, and statistics
repository tables in different databases to ensure enhanced performance.

As you complete the configuration process, messages may be displayed. For

details on system messages displayed during the configuration process, see
Configuration messages, page 403.

You can choose to create metadata, History List, and statistics repositories
using a response file with the Configuration Wizard. This lets you provide
users with a configuration file to complete the configuration tasks rather
than requiring users to step through the Configuration Wizard. Creating and
using a response file can be done using the Configuration Wizard interface
or a command line tool available for Linux.

Copyright © 2021 All Rights Reserved 391

In st allat io n an d Co n figu r at io n Gu id e

Required database permissions to create metadata, History List,

and statistics repositories
To create metadata, History List, and statistics repositories in a database,
you need a database user account to associate with the tables created for
the repositories. MicroStrategy recommends that the database user account
used to create these repositories is granted full permissions for the
database.

If the database user account cannot be granted full permissions to the

database, be aware that this account requires Select, Insert, Update,
Create, Drop, and Delete permissions. These permissions are required for
various database objects depending on the database type you are using. For
example, the following database object permissions are required where
applicable for your database type:

Database Object Type of Permissions Required

Tables Select, Insert, Update, Create, Drop, Delete

Indexes Create, Drop

Triggers Create, Drop

Functions Create, Execute

Packages Create

Procedures Create, Execute

While creating metadata, History List, and statistics repositories, the

Configuration Wizard provides an option to preview the SQL statements that
will be executed. You can review this SQL preview to have a better
understanding of the tasks that will be required as part of creating
metadata, History List, and statistics repositories.

Refer to your third-party database documentation for specific names and

details on database permissions and database objects.

Copyright © 2021 All Rights Reserved 392

In st allat io n an d Co n figu r at io n Gu id e

Creating a metadata repository

The metadata repository is a collection of tables that contain the definitions
for nearly all MicroStrategy objects including database logins, server
definitions, database instances and connections, reports, metrics, facts, and
so on. It is mandatory to have a metadata repository to which Intelligence
Server can connect.

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

If the Intelligence Server is not installed on the same machine as

Configuration Wizard, you can only create a metadata repository using the
32-bit Configuration Wizard.

If you are upgrading your metadata from a previous version of

MicroStrategy rather than creating a brand new metadata, see the Upgrade
Help.

l Before you create a metadata repository, you should ensure that you are
storing it on a certified database, ODBC driver, and operating system
combination. For a list of certified metadata repository environments, see the
MicroStrategy Readme.
l A database user account to associate with the metadata tables.
MicroStrategy recommends that the database user account used to create a
metadata repository is granted full permissions for the database. If the
database user account cannot be granted full permissions to the database,
refer to Required database permissions to create metadata, History List, and
statistics repositories, page 392 for additional details on the database
permissions required for this configuration.

Copyright © 2021 All Rights Reserved 393

In st allat io n an d Co n figu r at io n Gu id e

l While metadata creation errors are rare in general, you can review a list of
potential errors in Metadata and Other Repository Creation Errors, page 836
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 and
click Next.
3. Select the Metadata Tables check box and click Next. The Repository
Configuration: Metadata tables page opens.

You can also select to create a History List and a statistics repository
immediately after creating a metadata repository. If you create a
History List or statistics repository as part of the same configuration
routine as creating a new metadata repository, and the configuration is
being done on a Windows environment, database instances are
automatically created for the History List and statistics repositories.

4. From the DSN drop-down list, select the DSN for your metadata
repository.

If a DSN for your metadata repository does not exist, you can click New
to open the Connectivity Wizard and create a new DSN. The steps to
create a new DSN with the Connectivity Wizard are described in
Creating a DSN for a data source, page 379.

Although it is possible to use the Microsoft Access database for the

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

Copyright © 2021 All Rights Reserved 394

In st allat io n an d Co n figu r at io n Gu id e

5. Type a User Name and Password that can connect to the data source.

The database user that you provide becomes the owner of all metadata
tables and objects. The database user is required to have the Select,
Insert, and Update permissions. Intermediate tables are created in the
metadata for recursive search queries, which requires Create and Drop
permissions as well. Updating the schema requires the Delete
permission.

6. After providing a valid user name and password, you can click SQL
Preview to open the SQL Preview dialog box. This dialog box provides
the SQL statements that will be executed on your data source to create
the metadata tables. Click Close.

If you use the advanced options to change the SQL script, you can click
SQL Preview after selecting the new script to see an updated listing of
the SQL statements that will be executed.

7. Click Advanced.
8. In the Table Prefix field, you can specify a prefix to be used when
metadata tables are created in the database you select. This is an
optional configuration. However, you must use different prefixes for
your metadata tables and your History List tables if you store them in
the same database.

Most databases use a prefix of two characters. However, you can

supply as many letters, numbers, underscores (_), and periods (.) as
required to support your database prefixes. To determine character
limits for a prefix, refer to your third-party database vendor
documentation.

9. In the Script field, a SQL script to create metadata tables optimized for
your database is selected. If you want to select a different script, click
... to browse to and select a customized script.
10. Click Next. The next configuration page that opens depends on your
configuration scenario:

Copyright © 2021 All Rights Reserved 395

In st allat io n an d Co n figu r at io n Gu id e

l If your metadata repository does not need to be upgraded and you did
not select to create History List or statistics tables, the Summary
page opens. You can complete your configuration as described in
Creating Metadata, History List, and Statistics Repositories, page
391 below.
l If your metadata repository does not need to be upgraded and you
selected to configure History List or statistics tables, you are
prompted to configure these options as described in Creating a
History List repository, page 396 and Creating statistics and
Enterprise Manager repositories to maintain and monitor system
activity, page 400.
l If your metadata repository needs to be upgraded, cancel this
metadata creation process. If you continue with this process of
creating metadata tables, your current metadata will be overwritten
with a brand new metadata. For information on upgrading your
metadata and suite of MicroStrategy projects, refer to the Upgrade
Help.
11. Review the summary information.

You can click Save to save the configuration as a response (.ini) file to
configure metadata repositories on other systems or to run silent
configurations at a later time.

12. Click Finish .

Creating a History List repository

A History List repository stores users' report and document results for future
use. History Lists can be stored on file systems of a server machine. The
History List tables provide an alternative option to store History List
information in a centralized database.

If you create a History List repository as part of the same configuration

routine to create a metadata repository, and the configuration is being done
on a Windows environment, a database instance is automatically created for

Copyright © 2021 All Rights Reserved 396

In st allat io n an d Co n figu r at io n Gu id e

the History List repository. If you create the History List repository
separately, you create it for an existing metadata repository, or you create it
on a Linux environment, you must create a database instance for the History
List repository. For information on creating a database instance, see
Creating a database instance, page 446.

If you are upgrading your History List repository from a previous version of
MicroStrategy rather than creating a brand new History List repository, see
the Upgrade Help.

l Before you create a History List repository, you should ensure that you are
storing it on a certified database, ODBC driver, and operating system
combination. For a list of certified History List repository environments, see
the MicroStrategy Readme.
l A database user account to associate with the History List tables.
MicroStrategy recommends that the database user account used to create
History List Tables is granted full permissions for the database. If the
database user account cannot be granted full permissions to the database,
refer to Required database permissions to create metadata, History List, and
statistics repositories, page 392 for additional details on the database
permissions required for this configuration.
l The steps below are specific to creating a History List repository. If you also
select to create a metadata repository, you must first complete the steps
described in Creating a metadata repository, page 393.
l While History List creation errors are rare in general, you can review a list of
potential errors in Metadata and Other Repository Creation Errors, page 836
to prepare for or avoid specific scenarios that may cause errors.

To create a History List repository

1. Open the MicroStrategy Configuration Wizard.

2. Select Metadata, History List and Statistics Repository Tables and
click Next.
3. Select the History List Tables check box and click Next.

Copyright © 2021 All Rights Reserved 397

In st allat io n an d Co n figu r at io n Gu id e

4. From the DSN drop-down list, select the DSN for your History List
repository.

If a DSN for your History List repository does not exist, you can select
New to open the Connectivity Wizard and create a new DSN. The steps
to create a new DSN with the Connectivity Wizard are described in
Creating a DSN for a data source, page 379.

5. Type a User Name and Password that can connect to the data source.

The database user you provide becomes the owner of all History List
tables and objects. The database user is required to have the Select,
Create, Insert, and Drop permissions.

6. After providing a valid user name and password, you can click SQL
Preview to open the SQL Preview dialog box. This dialog box provides
the SQL statements that will be executed on your data source to create
the History List tables. Click Close once you are done reviewing the
SQL statements to return to the Configuration Wizard.

If you use the advanced options to change the SQL script, you can click
SQL Preview after selecting the new script to see an updated listing of
the SQL statements that will be executed.

7. Click Advanced.
8. In the Table Prefix field, you can specify a prefix to be used when
History List tables are created in the database you select. This is an
optional configuration. However, you must use different prefixes for
your metadata tables and your History List tables if you store them in
the same database.

Most databases use a prefix of two characters. However, you can

supply as many letters, numbers, underscores (_), and periods (.) as
required to support your database prefixes. To determine character
limits for a prefix, refer to your third-party database vendor
documentation.

Copyright © 2021 All Rights Reserved 398

In st allat io n an d Co n figu r at io n Gu id e

If you use a table prefix for your History List tables, you must also
define this table prefix when you create a database instance to connect
to the History List tables. For information on creating a database
instance, see Creating a database instance, page 446.

9. In the Script field, a SQL script to create History List tables optimized
for your database is selected. If you want to specify a different script,
click ... to browse to and select a customized script. For more
information on the default SQL scripts, see SQL scripts, page 403.
10. Click Next. The next configuration page that opens depends on your
configuration scenario:
l If you did not select to create statistics tables, the Summary page
opens.
l If you selected to configure statistics tables, you are prompted to
configure these options as described in Creating statistics and
Enterprise Manager repositories to maintain and monitor system
activity, page 400.
11. Review the summary information.

You can click Save to save the configuration as a response (.ini) file to
configure History List repositories on other systems or to run silent
configurations at a later time. For information on running the
Configuration Wizard with a response file, see Configuring
MicroStrategy with a Response File, page 417.

12. Click Finish to apply the configuration and create the History List
repository.

Once you are finished configuring Intelligence Server and your project
sources, a database instance to connect a project to a History List
repository must be created. If you created the History List repository as
part of the same configuration routine to create a metadata repository
and the configuration is being done on a Windows environment, a
database instance is automatically created for the History List

Copyright © 2021 All Rights Reserved 399

In st allat io n an d Co n figu r at io n Gu id e

repository. For information on creating a database instance, see

Creating a database instance, page 446.

Creating statistics and Enterprise Manager repositories to

maintain and monitor system activity
The statistics and Enterprise Manager repositories are collections of
database tables used to maintain and monitor system activity and
performance. You can run MicroStrategy Enterprise Manager against the
statistical information to analyze and interpret the statistics.

For a detailed description of the statistics tables used in the Enterprise

Manager Statistics database, the fields that each table contains, and the
data types associated with each field for MicroStrategy Intelligence Server,
refer to the Enterprise Manager Data Model and Object Definitions chapter
in the System Administration Guide.

For details on how to configure projects to log statistics, refer to the

Monitoring System Usage chapter in the System Administration Help.

If you create statistics and Enterprise Manager repositories as part of the

same configuration routine to create a metadata repository, and the
configuration is being done on a Windows environment, a database instance
is automatically created for the statistics repository. If you create the
statistics repository separately, you create it for an existing metadata
repository, or you create it on a Linux environment, you must create a
database instance for the statistics repository. For information on creating a
database instance, see Creating a database instance, page 446.

If you are upgrading your statistics and Enterprise Manager repositories

from a previous version of MicroStrategy rather than creating a brand new
statistics repository, see the Upgrade Help.

l Before you create statistics and Enterprise Manager repositories, you should
ensure that you are storing them on a certified database, ODBC driver, and

Copyright © 2021 All Rights Reserved 400

In st allat io n an d Co n figu r at io n Gu id e

operating system combination. For a list of certified environments, see the

MicroStrategy Readme.
l A database user account to associate with the repositories. MicroStrategy
recommends that the database user account used to create the tables is
granted full permissions for the database. If the database user account
cannot be granted full permissions to the database, refer to Required
database permissions to create metadata, History List, and statistics
repositories, page 392 for additional details on the database permissions
required for this configuration.
l The steps below are specific to creating statistics and Enterprise Manager
repositories. If you also select to create a metadata repository or History List
repository, you must first complete the steps described in Creating a
metadata repository, page 393 or Creating a History List repository, page
396, respectively.
l While statistics creation errors are rare in general, you can review a list of
potential errors in Metadata and Other Repository Creation Errors, page 836
to prepare for or avoid specific scenarios that may cause errors.

To create statistics and Enterprise Manager repositories

1. Open the MicroStrategy Configuration Wizard.

2. Select Metadata, History List and Statistics Repository Tables and
click Next.
3. Select the Statistics & Enterprise Manager Repository check box
and click Next.
4. From the DSN drop-down list, select the DSN for your statistics and
Enterprise Manager repositories.

If an applicable DSN does not exist, you can select New to open the
Connectivity Wizard and create a new DSN. The steps to create a new
DSN with the Connectivity Wizard are described in the section Creating
a DSN for a data source, page 379.

Copyright © 2021 All Rights Reserved 401

In st allat io n an d Co n figu r at io n Gu id e

5. Type a User Name and Password that can connect to the data source.

The database user you provide becomes the owner of all tables and
objects. The database user is required to have the Select, Create,
Insert, and Drop permissions.

6. After providing a valid user name and password, you can click SQL
Preview to open the SQL Preview dialog box. This dialog box provides
the SQL statements that will be executed on your data source to create
the statistics and Enterprise Manager tables. Click Close.

If you use the advanced options to change the SQL script, you can click
SQL Preview after selecting the new script to see an updated listing of
the SQL statements that will be executed.

7. Click Advanced.
8. In the Script field, a SQL script to create statistics and Enterprise
Manager repositories optimized for your database is selected. If you
want to specify a different script, click ... (the browse button) to browse
to and select a customized script. For more information on the default
SQL scripts, see SQL scripts, page 403.
9. Click Next.
10. Review the summary information.

You can click Save to save the configuration as a response (.ini) file to
configure statistics repositories on other systems or to run silent
configurations at a later time. For information on running the
Configuration Wizard with a response file, see Configuring
MicroStrategy with a Response File, page 417.

11. Click Finish . The summary information is updated as the

configurations are completed, providing a way to track the progress of
the configurations.

Once you are finished configuring Intelligence Server and your project
sources, a database instance to connect a project to a statistics repository
must be created. If you created the statistics repository as part of the same

Copyright © 2021 All Rights Reserved 402

In st allat io n an d Co n figu r at io n Gu id e

configuration routine to create a metadata repository and the configuration

is being done on a Windows environment, a database instance is
automatically created for the statistics repository. For information on
creating a database instance, see Creating a database instance, page 446.

SQL scripts
MicroStrategy has database-specific SQL scripts for creating metadata,
History List, and statistics tables. The scripts for each certified database
platform are shipped with the product. The MicroStrategy Configuration
Wizard automatically selects a default script based on your ODBC driver's
database platform.

By default, all the scripts reside in the directory where you installed
MicroStrategy and are identified by the .sql extension. It is highly
recommended that no edits be performed on these scripts, except on rare
occasions and only by skilled database personnel.

Configuration messages
Depending on the selected ODBC database, different messages might be
displayed prompting you to complete the configuration successfully. Two
examples are described below:

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 metadata

repository in the database location you specified.

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

l No Metadata Tables were found at this location, do you wish to

create them now?

Copyright © 2021 All Rights Reserved 403

In st allat io n an d Co n figu r at io n Gu id e

This message is displayed if there is no existing metadata repository and

you have not chosen to create one.

Setting up MicroStrategy Intelligence Server

You use the Configuration Wizard to create and configure a server definition
for your MicroStrategy Intelligence Server. A server definition is stored in
the metadata repository, and it contains information about the configuration
of Intelligence Server such as governing settings, which projects should be
loaded, which communication protocols should be used, and so on. This
definition is a required step of configuring your Intelligence Server.

Multiple server definitions can be available, but you can install only one
Intelligence Server on one server machine and Intelligence Server uses
only one server definition at a time.

You can choose to configure the server definition, project source names,
and the metadata and statistics repositories using a response file with the
Configuration Wizard. This lets you provide users with a configuration file to
complete the configuration tasks rather than requiring users to step through
the Configuration Wizard. Creating and using a response file can be done
using the Configuration Wizard interface or a command line tool available for
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

1. Open the MicroStrategy Configuration Wizard.

2. Select Configure Intelligence Server, and click Next.
3. From the DSN drop-down list, select the DSN used to connect to the
metadata repository. Enter the User Name and Password for the
database. Although it is possible to use the Microsoft Access database
for the metadata repository, it is not a suitable metadata repository for

Copyright © 2021 All Rights Reserved 404

In st allat io n an d Co n figu r at io n Gu id e

a production project. You should not use Microsoft Access for anything
other than a proof-of-concept or demonstration type of application.
4. Click Next. If a message is displayed that your metadata is not up to
date with the most recent version of MicroStrategy, you must upgrade
your metadata to take advantage of the new features available in the
most recent version of MicroStrategy. You can upgrade your
MicroStrategy metadata as described in the Upgrade Help.
5. On the MicroStrategy Authentication page, specify the MicroStrategy
administrator's User Name and Password. By default, the user name is
Administrator and it has no password. If you are setting up Intelligence
Server for the first time, use the default user name and password.

For security reasons, you should change the Administrator user name
and password as soon as possible after you initially configure the
system. For details about passwords and other user management
information, see the System Administration Help

6. Click Next.
7. You can create a new server definition, use an existing server
definition, or delete a current server definition. You can perform one of
the following tasks:
l To create a server definition, select Create New Server Definition.
When you create a new server definition in the metadata repository of
your choice, all its parameters use the default settings. You can
modify these default settings using the MicroStrategy Intelligence
Server Configuration Editor. For information about the Intelligence
Server Configuration Editor, see the System Administration Help.
1. In the Name field, type a name to identify the server definition.
2. Select the Use as the active server definition check box to
define Intelligence Server to use the new server definition when
Intelligence Server starts.

Copyright © 2021 All Rights Reserved 405

In st allat io n an d Co n figu r at io n Gu id e

3. Click Next. The Server Configuration: Settings page opens,

described in Setting up MicroStrategy Intelligence Server, page
404 below.
l To use an existing server definition, select Use the selected Server
Definition as active. When you use an existing server definition
different from the current server definition, you are changing the
machine's configuration information, which can be in an entirely
different metadata with different default settings.
1. From the Existing Server Definitions pane, select a server
definition to use.
2. Click Next. The Server Configuration: Settings page opens,
described in Setting up MicroStrategy Intelligence Server, page
404 below.
l To delete an existing server definition, select Delete Selected
Server Definition. When you delete a server definition, you are
deleting the server definition object from the metadata repository, but
not from the Intelligence Server software that you installed.
1. From the Existing Server Definitions pane, select a server
definition to delete.
2. Click Next. The Summary page opens, described in Setting up
MicroStrategy Intelligence Server, page 404 below.

Select the server definition to use from the Existing Server

Definitions pane. Click Next.

Define the Intelligence Server port num ber and other settings

1. If you select to create a server definition or use an existing server

definition, you can define the Intelligence Server port number and other
settings, as described below:
l Port number: You can use the default port number (34952) or specify
another port number. The port number is how a server process

Copyright © 2021 All Rights Reserved 406

In st allat io n an d Co n figu r at io n Gu id e

identifies itself on the machine on which it is running. If the port

number is used by another process, such as in a shared environment,
specify an available port number. For instructions on how to find an
available port number, see Port Number is in Use, page 835.

l REST port number: You can use the default port number (34962) or
specify another port number for the REST API Server inside
Intelligence Server. This port number should not be same with the
Intelligence Server port number.

You can configure REST API Server logging with the Diagnostics
and Performance Logging Tool. Select the Performance
Configuration tab, and find the dispatcher REST Trace under
component Network Classes. For more information, see the
Configuring What is Logged section in the System Administration
Help.

l Register Intelligence Server as a Service: This option is only

available if you are configuring Intelligence Server on a Linux
machine, and you have root access and permissions to the Linux
machine that Intelligence Server is installed on.In Windows,
Intelligence Server is automatically registered as a service upon
completion of the configuration process.Running the Configuration
Wizard again and clearing this check box does not unregister
Intelligence Server as a service. To unregister Intelligence Server on
Linux, you must stop the service, and then use the mstrctl
command line tool. The syntax is mstrctl -s
IntelligenceServer us, where IntelligenceServer is the
name of a server definition. For information about starting, stopping,
and registering Intelligence Server as a service, see the System
Administration Help.
l Projects to load at startup: This pane displays all the projects that
are in the metadata repository. You can select projects to use with

Copyright © 2021 All Rights Reserved 407

In st allat io n an d Co n figu r at io n Gu id e

the server definition that you have chosen. The projects that you
select are loaded on the server at startup.
l Start Intelligence Server when finished: Select this check box to
have Intelligence Server start once you complete this configuration.If
you use Windows NT authentication with SQL Server, you must type
the Windows NT account user name and password in the Service
Manager to successfully start Intelligence Server. For information on
how to access and use the Service Manager, see the System
Administration Help.
l Identify missing DSNs: Select this check box to verify that all DSNs,
which are used for database instances created in MicroStrategy, are
locally available. This helps to ensure that your database instances in
MicroStrategy can connect successfully to their associated data
sources.

By default, this check box is cleared, which means the availability of

all local DSNs used in database instances is not verified. While this
may mean that all DSNs used in database instances are not
available, it can save system resources required for the Intelligence
Server configuration process.

2. Click Next.
3. You can enable or disable secure socket layer (SSL) protocol to encrypt
the communication between Intelligence Server and Developer:

Configure SSL: This option specifies whether to enable Intelligence

Server and Developer to communicate using the SSL protocol. Clear
this check box to disable the use of the SSL protocol for Intelligence
Server and Developer communications. This option also applies SSL
protocol to the REST port number specified above.

When you select to enable the SSL protocol, you must provide the
following information:

Copyright © 2021 All Rights Reserved 408

In st allat io n an d Co n figu r at io n Gu id e

l Certificate: The SSL certificate file you created for Intelligence

Server. Click the browse button to navigate to and select the
certificate file.
l Key: The private key file you created while requesting the certificate
for Intelligence Server. Click the browse button to navigate to and
select the private key file.
l Password: The password that you used while creating the private key
for the SSL certificate.

l SSL Port: The port number to use for SSL access. By default, the
port is 39321. For the REST API Server inside the Intelligence
Server, it will still use the REST port number specified above (which
by default is 34962).

To enable SSL protocol communication in Developer, you must use the

Project Source Editor. For steps to complete the other tasks required
to enable SSL protocol communications, refer to the System
Administration Help.

Configuring port requires Client Certificate: If selected, the SSL

communications with client certificate verification will be configured in
the Intelligence Server, but does not apply to REST port number.
Provide the following information:

l SSL Port: The port number the Intelligence Server will use for SSL
communications with client certificate verification.

l Truststore: The location to the client certificate truststore.

4. Click Next.
5. You can specify the default statistics repository to use for the local
Intelligence Server, including the data source name, user name, and
password, and an option to create a new data source name. The
following options appear:

Copyright © 2021 All Rights Reserved 409

In st allat io n an d Co n figu r at io n Gu id e

l Keep the existing statistics settings: Select this check box to keep
the existing statistics settings for all projects. This option is selected
by default.

l Enable Statistics Database Instance for the Intelligence Server

metadata: Select this check box to enable basic statistics logging for
projects.

You can alter the settings of this option in the Project Configuration
Editor in MicroStrategy Developer. For steps, see the System
Administration Help.

When defining the default statistics repository, you must provide the
following configuration details:

n DSN: Select the data source name for your statistics repository.

If a DSN for your statistics repository does not exist, you can click
New to open the MicroStrategy Connectivity Wizard and create a
new DSN. Unsupported DSNs are grayed out.

n User Name: Enter the database user name for the user that can
connect to the statistics data source.
n Password: Enter the password for the user that can connect to the
statistics data source.
l Disable statistics for the local Intelligence Server metadata:
Select this check box to disable statistics settings for all projects in
the local Intelligence Server metadata.
6. Click Next.

7. You can either enable or disable Messaging Services for Intelligence

Server and configure the Messaging Services host and port settings.

Messaging Services Host(s)/Port(s): Provide host name or IP

address of Messaging Services. Format for this setting should be:

Copyright © 2021 All Rights Reserved 410

In st allat io n an d Co n figu r at io n Gu id e

server1.acme.com:9092, server2.acme.com:9093,
server3.acme.com:9093

8. Click Next.
9. Review the summary information and click Save.

For information on running the Configuration Wizard with a response

file, see Configuring MicroStrategy with a Response File, page 417.

10. Click Finish.

If you created a new server definition, it is displayed in the list of

existing server definitions for that metadata.

If you assigned an existing server definition to Intelligence Server and

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

Starting, stopping, and restarting the server

With a server definition defined for your Intelligence Server, you can use
Service Manager to start or stop your Intelligence Server. For steps to use
Service Manager, see the System Administration Help.

Creating Project Sources

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

When you create a metadata repository, by default it creates a server (three-

tier) project source. You can use the Project Sources option in the
MicroStrategy Configuration Wizard if you need to create multiple project
sources or a direct (two-tier) project source. The steps to create the different
types of project sources are:

Copyright © 2021 All Rights Reserved 411

In st allat io n an d Co n figu r at io n Gu id e

l Creating a direct (two-tier) project source, page 412: Direct project

sources that connect directly to the metadata through ODBC. You cannot
create a direct project source on Linux.
l Creating a server (three-tier) project source, page 413: Server project
sources that connect to the metadata through an Intelligence Server.

You can choose to create project sources using a response file with the
Configuration Wizard. This lets you provide users with a configuration file to
complete the configuration tasks rather than requiring users to step through
the Configuration Wizard. Creating and using a response file can be done
using the Configuration Wizard interface or a command line tool available for
Linux.

Creating a direct (two-tier) project source

A direct project source is used to connect directly to the metadata repository
using ODBC. A direct project source connection does not allow you to
access MicroStrategy Web, run Report Services documents, or use any of
the other MicroStrategy features that are provided through Intelligence
Server.

You cannot create a direct project source on Linux.

For Windows, the Project Source option is available only if the Developer
product is installed on the machine.

To create to a direct project source

1. Open the MicroStrategy Configuration Wizard.

2. Select Project Sources and click Next.
3. In the Project Source Name field, type a name for the project source.
4. Go to Connection Type > Direct (2-tier), and click Next.
5. From the DSN drop-down list, select a DSN for the data source that
stores the metadata and specify a User Name and Password.

Copyright © 2021 All Rights Reserved 412

In st allat io n an d Co n figu r at io n Gu id e

6. You can also click New to create a new DSN (see Creating a DSN for a
data source, page 379) and click Advanced to specify a metadata table
prefix if necessary.
7. Click Next.
8. Select the authentication mode for the project source. For information
on the available authentication modes, see the Authentication modes,
page 415.
9. Click Next.
10. Review the summary information.

You can click Save to save the configuration as a response (.ini) file to
configure a direct project source on other systems or to run silent
configurations at a later time. For information on running the
Configuration Wizard with a response file, see Configuring
MicroStrategy with a Response File, page 417.

11. Click Finish .

Creating a server (three-tier) project source

A server (three-tier) project source is used to connect to the metadata using
the MicroStrategy Intelligence Server. A server project source connection
allows you to access MicroStrategy Web, run Report Services documents,
and use all of the other MicroStrategy features that are provided through
Intelligence 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
product is installed on the machine.

Copyright © 2021 All Rights Reserved 413

In st allat io n an d Co n figu r at io n Gu id e

To create a MicroStrategy Intelligence Server (three-tier) project

source

1. Open the MicroStrategy Configuration Wizard.

2. Select Project Sources and click 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 click Next.
5. In the MicroStrategy Intelligence Server Machine Name drop-down
list, select the Intelligence Server to connect to.
6. In the Port Number used by MicroStrategy Intelligence Server field,
type the port number for the Intelligence Server to connect to.

The port number is how the Intelligence Server process identifies itself
on the server on which it is running. The default port number for
Intelligence Server is 34952. If you use a non-default port number, this
number must be provided while connecting through MicroStrategy
Developer.

If you set up a firewall between Intelligence Server and your

MicroStrategy Web server, refer to the System Administration Help for
steps to ensure the required ports are open to allow communication
between your MicroStrategy systems.

7. Select the Connection times out after (mins) check box to define
and enforce a connection time out for inactive users connected to a
project source. In the field below, type a numerical value (in minutes)
for the amount of inactivity that is allowed before a user is automatically
disconnected from a project source. If this check box is cleared, users
are not disconnected from project sources due to inactivity.
8. Click Next.

Copyright © 2021 All Rights Reserved 414

In st allat io n an d Co n figu r at io n Gu id e

9. Select the authentication mode for the project source. For information
on the available authentication modes, see the Authentication modes,
page 415.
10. Click Next.
11. Review the summary information.

You can click Save to save the configuration as a response (.ini) file to
configure a server project source on other systems or to run silent
configurations at a later time. For information on running the
Configuration Wizard with a response file, see Configuring
MicroStrategy with a Response File, page 417.

12. Click Finish .

Authentication modes
Authentication is the process through which the system identifies the user.
Several authentication modes are supported for MicroStrategy project
sources. They vary primarily by the system that verifies and accepts the
login/password credentials provided by the user.

Some authentication modes require a server project source (three-tier).

Therefore, if you are creating a direct project source (two-tier) some of the
authentication options listed below cannot be used.

For information on the benefits of the various authentication modes and

other authentication topics, see the System Administration Help

Network login ID: Windows authentication

To use Windows authentication, you must create users in the MicroStrategy

environment and then link them to Windows users. If you use Windows as
your network operation system and your users are already defined in the
Windows directory, your users can access the MicroStrategy application
without having to enter a login ID and password.

Copyright © 2021 All Rights Reserved 415

In st allat io n an d Co n figu r at io n Gu id e

Login ID and password entered by the user: Standard authentication

When using standard authentication, the MicroStrategy Intelligence Server

is the authentication authority. Intelligence Server verifies and accepts the
login and password provided by the user. This information is stored in the
metadata repository. When a project source is configured to use standard
authentication, users must enter a valid login ID and password combination
before they can access the project source. Each user has a unique
login/password and can be identified in the MicroStrategy application
uniquely. By default, all users connect to the data warehouse using one
RDBMS login ID, although you can change this using connection mapping.
For information on configuring connection mapping, see the System
Administration Help.

Guest account: Anonym ous authentication

When using anonymous authentication, users log in as Guest and do not

need to provide a password. By default, guest users can access the project,
browse objects, run and manipulate reports, but they cannot create their
own objects or schedule report executions. However, you determine what
the Guest user can and cannot do by modifying the Public user group. Guest
users inherit their privileges from the Public group; they are not part of the
Everyone group.

LDAP authentication

Lightweight Directory Access Protocol (LDAP) authentication identifies

users within a repository of users stored in an LDAP server (such as Novell
Directory Services). If you use an LDAP directory to centrally manage users
in your environment, you may want to use LDAP authentication. Group
membership can be maintained in the LDAP directory without having to also
be defined in the MicroStrategy Intelligence Server. When using LDAP
authentication, LDAP users or groups are linked to users or groups in the
MicroStrategy environment.

Copyright © 2021 All Rights Reserved 416

In st allat io n an d Co n figu r at io n Gu id e

Login ID and password entered by the user for the warehouse: Database
authentication

This mode of database authentication identifies users using a login ID and

password stored in the data warehouse database. Under this mode of
authentication, a warehouse database is associated with each project. When
users log in to a project source, they are logging in to the Intelligence
Server. Use database authentication if you want the data warehouse RDBMS
to be the authority for identifying users and you do not want to maintain user
credentials in the Intelligence Server as well as the RDBMS.

Integrated authentication

Integrated authentication enables a Windows user to log in once to their

Windows machine. The user does not need to log in again separately to
MicroStrategy Developer or MicroStrategy Web. This type of authentication
uses Kerberos to validate a user's credentials.

Configuring MicroStrategy with a Response File

The Configuration Wizard walks you through the process of setting up the
environment for the MicroStrategy products installed in your system. You
can also configure server definitions, project source names, an Enterprise
Manager project, and the metadata, History List, and statistics repositories
using a response file with the Configuration Wizard. This enables you to
provide a configuration file to users to complete the configuration tasks,
rather than requiring users to step through the Configuration Wizard. This
can be done to configure a MicroStrategy installation on Windows and Linux.

The Configuration Wizard can also be used to perform MicroStrategy

upgrades and create an Enterprise Manager project. These tasks can also
be accomplished by using a response file:

l For steps to upgrade MicroStrategy using a response file, see the Upgrade
Help.

Copyright © 2021 All Rights Reserved 417

In st allat io n an d Co n figu r at io n Gu id e

l For steps to create an Enterprise Manager project with a response file, see
the Enterprise Manager Help.

Creating a response file

It is recommended that you always create the response file through the
graphical interface of the Configuration Wizard, as described in the
procedure To create a response file, page 418 in this section. This ensures
that all applicable options are included in the response file with valid values.

However, you can also create and use a response file with the Configuration
Wizard in command line mode on Linux machines. For steps to create and
use a response file as well as perform other configurations using command
line tools in Linux, see the Configuring MicroStrategy with a response.ini
file, page 642 section in Chapter 11, Configuring MicroStrategy Using
Command Line Tools.

To create a response file

1. Open the MicroStrategy Configuration Wizard. To do this, see To

configure MicroStrategy through the Configuration Wizard, page 388.
2. Any configuration tasks you complete with the Configuration Wizard
can be saved to a response file. For steps to complete various
configurations tasks with the Configuration Wizard, see the sections
listed below:
l Creating Metadata, History List, and Statistics Repositories, page
391
l Setting up MicroStrategy Intelligence Server, page 404
l Creating Project Sources, page 411
3. Once you reach the Summary page for a configuration, click Save. The
Save dialog box opens.
4. Specify a name and location to save the response file, and click Save.
You are returned to the Summary page.

Copyright © 2021 All Rights Reserved 418

In st allat io n an d Co n figu r at io n Gu id e

5. To also perform the configuration task, click Finish. The summary

information is updated as the configurations are completed, providing a
way to track the progress of the configurations.

Steps to use a response file to configure MicroStrategy are covered in Using

a response file to configure MicroStrategy installations, page 419 below.

You can modify a response file with a text editor to make configuration
changes such as entering different user login and password information. For
information on the parameters and options available in response files, see
Response configuration parameters and options, page 421.

Using a response file to configure MicroStrategy installations

Rather than stepping through each page of the Configuration Wizard, you
can configure MicroStrategy using a response file. You have the following
options to use a response file to configure MicroStrategy:

l To use a response file with the Configuration Wizard, page 420: This
covers the standard procedure of running a response file with the
Configuration Wizard interface.
l To use a response file through the Windows command line, page 420: This
covers the procedure of running a response file from the Windows
command line. This enables users to run the file without using any
graphical user interfaces.

If you are configuring a MicroStrategy installation on Linux, you can use a

command line version of the Configuration Wizard to create and use a
response file. For steps to create and use a response file as well as
perform other configurations using command line tools in Linux, see the
Configuring MicroStrategy with a response.ini file, page 642 section in
Chapter 11, Configuring MicroStrategy Using Command Line Tools.

l Configuring MicroStrategy components with System Manager: You can use

a Configuration Wizard response file as part of an System Manager
workflow. System Manager lets you define multiple configurations for your

Copyright © 2021 All Rights Reserved 419

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy environment that can be executed in a single workflow. For

information on using MicroStrategy System Manager to configure and
deploy your MicroStrategy environments, see the System Administration
Help.

To use a response file with the Configuration Wizard

1. Open the MicroStrategy Configuration Wizard. To do this, see To

configure MicroStrategy through the Configuration Wizard, page 388.
2. Click Load. The Open dialog box displays.
3. Browse to the path where the response file is saved and click Open.
The Summary page opens.
4. An overview of all of the configuration tasks performed by the response
file is displayed. Review the configuration tasks and click Finish to
perform the configuration. The summary information is updated as the
configurations are completed, providing a way to track the progress of
the configurations.

To use a response file through the Windows command line

The steps below are specific to configuring MicroStrategy installed on

Windows. For steps to create and use a response file as well as perform
other configurations using command line tools in Linux, see Chapter 11,
Configuring MicroStrategy Using Command Line Tools.

1. Type the following command in the Windows command line:

macfgwiz.exe -r "Path\response.ini"
Where Path\ is the fully qualified path to the response file. For
example, the common location of a response file is:

C:\Program Files\Common
Files\MicroStrategy\RESPONSE.INI

Copyright © 2021 All Rights Reserved 420

In st allat io n an d Co n figu r at io n Gu id e

2. If an error message is displayed, check the path and name you supplied
for the response file and make any required changes. Repeat the
previous step to execute the configuration.

Response configuration parameters and options

It is recommended that you always create the response file through the GUI
mode of the Configuration Wizard. However, you can also modify a response
file with a text editor to make minor changes such as entering different user
login and password information.

The file must be saved with ANSI encoding.

The response file for configuring MicroStrategy is divided into three areas of
configuration, which are described in the sections below:

l Creating metadata, History List, and statistics repositories, page 421

l Setting up MicroStrategy Intelligence Server, page 424
l Creating and configuring project sources, page 429
l Creating and Configuring the Enterprise Manager Project
l Creating and Configuring the Platform Analytics Project

Creating m etadata, History List, and statistics repositories

The response file parameters within the [Repository] section define how
metadata, History List, and statistics and Enterprise Manager repositories
are created. The table below lists the available parameters and the
functionality of available options for each parameter.

Options Description

This section configures the metadata repository and statistics tables. You
[Repository] can have more than one [Repository] section. Additional repository
sections can be included as [Repository1] , [Repository2] , and so

Copyright © 2021 All Rights Reserved 421

In st allat io n an d Co n figu r at io n Gu id e

Options Description

on.

Defines whether a metadata, History List, and statistics repositories are

configured, as determined by the following values:

Repository= • 1: Configures metadata, History List, and statistics repositories.

• 0: Does not configure metadata, History List, and statistics

repositories.

Defines whether metadata tables are created in a metadata repository, as

described below:
CreateMDTa
• 1: Creates metadata tables in the metadata repository and creates a
bles=
default configuration

• 0: Does not create metadata tables in a metadata repository

Defines whether a History List repository is created, as determined by the

following values:
CreateHistLis
tTables= • 1: Creates a History List repository.

• 0: Does not create a History List repository.

Defines whether statistics and Enterprise Manager repositories are

created, as determined by the following values:
CreateStatTa
bles= • 1: Creates statistics and Enterprise Manager repositories.

• 0: Does not create statistics and Enterprise Manager repositories.

Locates the SQL scripts for creating the metadata tables. Example paths to
SQL scripts in different environments are listed below:
MetadataPath
• 64-bit Windows environment: C:\Program Files (x86)\Common
=
Files\MicroStrategy\MD8SQL8.sql.

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/mdsql.sql.

Locates the SQL scripts for creating the History List repository. Example
HistoryListPa paths to SQL scripts in different environments are listed below:
th= • 64-bit Windows environment: C:\Program Files (x86)\Common
Files\MicroStrategy\content_server_db_Oracle.sql .

Copyright © 2021 All Rights Reserved 422

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/content_
server_db_Oracle.sql .

Locates the SQL scripts for creating the statistics and Enterprise Manager
repositories. Example paths to SQL scripts in different environments are
listed below:
StatisticsPath • 64-bit Windows environment: C:\Program Files (x86)\Common
= Files\MicroStrategy\StatisticsEnterpriseManagerScrip
ts\DDLScripts\CreateTablesScript.sql

• Linux: /INTELLIGENCE_SERVER_INSTALL_PATH/statistics_
DB2.sql .

Defines the Data Source Name for configuring a metadata repository in the
DSNName=
ODBC database.

Defines the user name to log in to the database containing the metadata
UserName=
repository.

Defines the password to log in to the database containing the metadata

UserPwd=
repository.

DSNNameHis Defines the Data Source Name for configuring the History List repository in
t= the ODBC database.

UserNameHi Defines the user name to log in to the database for configuring the History
st= List repository.

UserPwdHist Defines the password to log in to the database for configuring the History
= List repository.

DSNNameSt Defines the Data Source Name for configuring the statistics and Enterprise
ats= Manager repositories in the ODBC database.

UserNameSta Defines the user name to log in to the database for configuring the
ts= statistics and Enterprise Manager repositories.

UserPwdStat Defines the password to log in to the database for configuring the statistics
s= and Enterprise Manager repositories.

EncryptPass Defines whether the password is encrypted in the response file, as

Copyright © 2021 All Rights Reserved 423

In st allat io n an d Co n figu r at io n Gu id e

Options Description

determined by the following values:

• 0: The password is not encrypted in the response file, which enables

you to modify the password in the response file later using a text editor.
You can then distribute the response file to multiple users with various
word= login and password credentials. However, be aware that this can
compromise your database security if you do not remove the password
from the response file before distributing it.

• 1: Encrypts the password in the response file, which ensures that your
password is secure. This is the default behavior.

Defines the database name to create tables in DB2 z/OS. This option
DBName=
should only be used when connecting to a DB2 z/OS database.

Defines the tablespace name to be created in the database.This option

TBName=
should only be used when connecting to a DB2 z/OS database.

Setting up MicroStrategy Intelligence Server

The response file parameters within the [Server] section configures an

Intelligence Server definition. The table below lists the available parameters
and the functionality of available options for each parameter.

Options Description

In this section you can configure the Intelligence Server

definition. You can have more than one [Server]
[Server]
section. Additional server sections can be included as
[Server1] , [Server2] , and so on.

Defines whether MicroStrategy Intelligence Server is

configured, as determined by the following values:

Server= • 1: Configures MicroStrategy Intelligence Server

• 0: Does not configure MicroStrategy Intelligence

Server

Copyright © 2021 All Rights Reserved 424

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Defines whether a server definition is created, used, or

deleted, as determined by the following values:

• 1: Creates a new server definition

Action= • 2: Uses an existing server definition

• 3: Deletes an existing server definition

• 4: Creates a new server definition and uses it as

the default

Defines the name of the Intelligence Server instance.

If you select to delete Intelligence Server instances,

you can delete multiple instances by listing multiple
InstanceName= instance names, separating each name with the \
character. For example,
InstanceName=ServerInstance1\ServerInstan
ce2 .

Defines projects to be loaded when Intelligence Server

is started. You can select to load multiple projects,
ProjectsToRegister=
separating projects by the \ character. For example,
ProjectsToRegister=Project1\Project2 .

Defines projects to not be loaded when Intelligence

Server is started. You can select to not load multiple
ProjectsToUnRegister= projects, separating projects by the \ character. For
example,
ProjectsToUnRegister=Project1\Project2 .

Defines the data source name for configuring the

DSName= MicroStrategy Intelligence Server. This is the data
source that stores the metadata.

Defines the user name to log in to the metadata

DSNUser=
database.

Defines the password to log in to the metadata

DSNPwd=
database.

Copyright © 2021 All Rights Reserved 425

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Defines whether the password is encrypted in the

response file, as determined by the following values:

• 0: The password is not encrypted in the response

file, which enables you to modify the password in the
response file later using a text editor. You can then
distribute the response file to multiple users with
EncryptPassword= various login and password credentials. However, be
aware that this can compromise your database
security if you do not remove the password from the
response file before distributing it.

• 1: Encrypts the password in the response file, which

ensures that your password is secure. This is the
default behavior.

Defines the MicroStrategy user name to log in to the

DSSUser=
project.

Defines the password for the MicroStrategy user name

DSSPwd=
to log in to the project.

Defines a prefix for metadata repository tables used by

MDPrefix=
the server definition.

Defines whether the Intelligence Server definition is set

as the default server definition to use for Intelligence
Server, as determined by the following values:

UseAsDefault= • True: Defines the Intelligence Server definition as

the default server definition

• False : Does not define the Intelligence Server

definition as the default server definition

Defines the port used by the Intelligence Server.By

Port=
default, the port is 34952.

Defines the port used by the REST API Server. By

RestPort=
default, the port is 34962.

Copyright © 2021 All Rights Reserved 426

In st allat io n an d Co n figu r at io n Gu id e

Options Description

This option is only available on Intelligence Servers

running on Linux operating systems.

Defines whether Intelligence Server is registered as a

service. Registering Intelligence Server as a service is
determined by the following values:
RegisterAsService=
• 1: Registers Intelligence Server as a service.
Performing this task requires a Linux login with root
level access and privileges.

• 0: Does not register Intelligence Server as a

service.

Defines whether Intelligence Server is started after

applying the configuration, as determined by the
following values:

StartServerAfter Config= • 1: Intelligence Server is started after successfully

applying the configuration.

• 0: Intelligence Server is not started after applying

the configuration.

Defines whether to enable Intelligence Server and

Developer to communicate using the SSL protocol, as
determined by the following values:

ConfigureSSL= • 1: Enables the use of the SSL protocol for

Intelligence Server and Developer communications.

• 0: Disables the use of the SSL protocol for

Intelligence Server and Developer communications.

Defines the port to use for SSL access. By default, the

SSLPort=
port is 39321.

Locates the SSL certificate file you created for

CertificatePath= Intelligence Server. Type the full path to the SSL
certificate file.

KeyPath= Locates private key file you created while requesting

Copyright © 2021 All Rights Reserved 427

In st allat io n an d Co n figu r at io n Gu id e

Options Description

the certificate for Intelligence Server. Type the full path

to the private key file.

Defines the password that you used while creating the

KeyPassword=
private key for the SSL certificate.

Specifies whether you can create a default statistics

database instance for the all of the projects of the local
Intelligence Server metadata, as determined by the
following values:

DefaultStatisticsRep • 1 : You can create a default statistics database

instance, using the statistics parameters listed in
this table below.

• 0 : A default statistics database instance is not

created.

DefaultDSNNameDefaultStatisti Specifies the data source name for your statistics

cs repository.

Specifies the database user name for the user that can
UserNameDefaultStatistics
connect to the statistics data source.

Specifies the password for the user that can connect to

UserPwdDefaultStatistics
the statistics data source.

Defines whether the statistics user password is

encrypted in the response file, as determined by the
following values:

• 0: The password is not encrypted in the response

file, which enables you to modify the password in the
response file later using a text editor. You can then
EncryptUserPwdDefaultStatistics
distribute the response file to multiple users with
various login and password credentials. However, be
aware that this can compromise your database
security if you do not remove the password from the
response file before distributing it.

• 1: Encrypts the password in the response file, which

Copyright © 2021 All Rights Reserved 428

In st allat io n an d Co n figu r at io n Gu id e

Options Description

ensures that your password is secure. This is the

default behavior.

Defines a prefix for statistics repository tables used by

DefaultStatisticsPrefix
the server definition.

Provide host name or IP addressee of Telemetry server.

kafkaHost(s)= Format for this setting should be:
server1.acme.com:9092, server2.acme.com:9093,...

Enable or disable Telemetry server for Intelligence

ConfigMessagingService= Server and configure Telemetry server host and port
settings.

Creating and configuring project sources

The response file parameters within the [Client] section create and
configure project sources. The table below lists the available parameters
and the functionality of available options for each parameter.

Options Description

In this section you can configure the project source name. You can
[Client] have more than one [Client] section. Additional client sections
can be included as [Client1] , [Client2] , and so on.

Defines whether project sources are configured, as determined by

the following values:
Client=
• 1: Configures project sources

• 0: Does not configure project sources

Defines whether the password is encrypted in the response file, as

determined by the following values:
EncryptPassword=
• 0: The password is not encrypted in the response file, which
enables you to modify the password in the response file later

Copyright © 2021 All Rights Reserved 429

In st allat io n an d Co n figu r at io n Gu id e

Options Description

using a text editor. You can then distribute the response file to
multiple users with various login and password credentials.
However, be aware that this can compromise your database
security if you do not remove the password from the response
file before distributing it.

• 1: Encrypts the password in the response file, which ensures

that your password is secure. This is the default behavior.

DataSource= Defines the name of the new project source to create.

Defines the database connection type for a project source. The

following connection types are supported:

• 2: Connects a project source to the metadata using an ODBC

ConnType=
DSN (Windows only).

• 3: Connects a project source to the metadata through a

MicroStrategy Intelligence Server (three-tier).

If using connection type 2 (ConnType=2) , defines the name of the

DSN=
ODBC database.

If using connection type 2 (ConnType=2) , defines the user name

UserName=
to connect to the ODBC database.

If using connection type 2 (ConnType=2) , defines the password

UserPwd=
to log in to the database.

If using connection type 3 (ConnType=3) , defines the name of

ServerName=
the MicroStrategy Intelligence Server to connect to.

If using connection type 3 (ConnType=3) , defines the port

number for the Intelligence Server when creating a server (three-
Port=
tier) project source. The default port number for MicroStrategy
Intelligence Server is 34952 .

The following authentication modes are supported:

Authentication= • 1: Standard or login ID and password entered by the user

• 2: Network login ID (Windows authentication)

Copyright © 2021 All Rights Reserved 430

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• 8: Guest account (Anonymous authentication)

• 16: LDAP authentication

• 32: Database login ID and password (database authentication)

• 128: Integrated authentication

For information on the available authentication modes, see the

Authentication modes, page 415.

If using connection type 2 (ConnType=2) , defines a prefix for

MDPrefix=
metadata repository tables.

Defines and enforce a connection time out for inactive users

connected to a project source. The following values are supported:

• 0 : Defines that users are not disconnected from project sources

due to inactivity.
Timeout=
• Numerical value greater than 0: A numerical value (in minutes)
greater than 0 defines the amount of inactivity that is allowed
before a user is automatically disconnected from a project
source.

Creating and Configuring the Enterprise Manager Project

The parameters in the [EMProjectHeader] portion of the response file

create the Enterprise Manager project on this machine and configure the
connection to the Statistics and Enterprise Manager repository. The table
below lists the available parameters and the functionality of available
options for each parameter. For detailed information about each parameter,
see the Configuration Wizard Help.

Options Description

Options in this portion refer to creating the Enterprise

[EMProjectHeader]
Manager project on this machine.

Copyright © 2021 All Rights Reserved 431

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Defines whether to create the Enterprise Manager project,

as determined by the following values:
EMProject=
• 1: Create Enterprise Manager project on this machine.

• 0: Do not create the Enterprise Manager project.

Defines whether the passwords are encrypted in the

response file, as determined by the following values:

• 0: The passwords are not encrypted in the response

file, which enables you to modify the passwords in the
response file using a text editor. You can then
distribute the response file to multiple users with
EMProjectEncryptPwd= various login and password credentials. However, be
aware that this can compromise your database security
if you do not remove the passwords from the response
file before distributing it.

• 1: Encrypts the passwords in the response file, which

ensures that your passwords are secure. This is the
default behavior.

EMProjectDSSUser= The user name to log in to the Enterprise Manager project.

The password for the user name above. This may be

EMProjectDSSPwd= encrypted, depending on the EMProjectEncryptPwd=
setting.

The full path and file name of the MicroStrategy Enterprise

Manager project package file used to create the project.
EMProjectPkgFile= On Windows, by default this is C:\Program Files
(x86)\Common Files\MicroStrategy\OOTB-
EM.mmp .

The Data Source Name for the database that contains

EMProjectDSNName=
your Statistics and Enterprise Manager repository.

The user name to connect to the Statistics and Enterprise

EMProjectDSNUserName=
Manager repository database.

Copyright © 2021 All Rights Reserved 432

In st allat io n an d Co n figu r at io n Gu id e

Options Description

The password for the user name above for the Statistics
and Enterprise Manager repository database. This may be
EMProjectDSNUserPwd=
encrypted, depending on the EMProjectEncryptPwd=
setting.

Creating and Configuring the Platform Analytics Project

The parameters in the [PAProjectHeader] portion of the response file

create the Platform Analytics project on this machine and configure the
connection to the Platform Analytics repository. The table below lists the
available parameters and the functionality of available options for each
parameter. For detailed information about each parameter, see the
Configuration Wizard Help.

Options Description

Options in this portion refer to creating the Platform Analytics

[PAProjectHeader]
project on this machine.

Defines whether to create the Platform Analytics project, as

determined by the following values:
PAProject=
l 1: Create Platform Analytics project on this machine.
l 0: Do not create the Platform Analytics project.

Defines whether the passwords are encrypted in the

response file, as determined by the following values:

l 0: The passwords are not encrypted in the response file,

which enables you to modify the passwords in the
PAProjectEncryptPwd= response file using a text editor. You can then distribute
the response file to multiple users with various login and
password credentials. However, be aware that this can
compromise your database security if you do not remove
the passwords from the response file before distributing it.

Copyright © 2021 All Rights Reserved 433

In st allat io n an d Co n figu r at io n Gu id e

Options Description

l 1: Encrypts the passwords in the response file, which

ensures that your passwords are secure. This is the
default behavior.

PAProjectDSSUser=
The user name to log in to the Platform Analytics project.

The password for the user name above. This may be

PAProjectDSSPwd= encrypted, depending on the PAProjectEncryptPwd=
setting.

Beginning with MicroStrategy 2020, this file will be removed

and the default project package will be used.

The full path and file name of the MicroStrategy Platform

PAProjectPkgFile= Analytics project package file used to create the project.

On Windows, by default this is C:\Program Files

(x86)\Common
Files\MicroStrategy\PlatformAnalyticsProjectObjects.mmp

Beginning with MicroStrategy 2020, this file will be removed

and the default project package will be used.

The full path and file name of the MicroStrategy Platform

Analytics project configuration package file used to create
PAConfigurePkgFile= the project.

On Windows, by default this is C:\Program Files

(x86)\Common
Files\MicroStrategy\PlatformAnalyticsConfigurationObjects.
mmp.

The Data Source Name for the database that contains your
PAProjectDSNName=
Platform Analytics repository.

PAProjectDSNUserName The user name to connect to the Platform Analytics

= repository database.

PAProjectDSNUserPwd= The password for the user name above for the Platform
Analytics repository database. This may be encrypted,

Copyright © 2021 All Rights Reserved 434

In st allat io n an d Co n figu r at io n Gu id e

Options Description

depending on the PAProjectEncryptPwd= setting.

PAProjectDSNPrefix= The prefix for the Platform Analytics repository tables.

Encryption Key Manager

Encryption Key Manager (EKM) creates and manages unique encryption
keys for every MicroStrategy environment. The EKM features include
creating, importing, and exporting of these unique keys through
Configuration Wizard. These keys encrypt potentially sensitive information
stored in the metadata, cube, cache, history list, and session recovery files.

Terms and Definitions

l Master Key: The master key encrypts the key store and is saved in the
master key file. MicroStrategy Intelligence Server will look for the path to
the master key in the registry upon start up.
l Key Store: Contains keys used to encrypt the metadata and file caches.
These keys are encrypted by the master key.
l Secure Bundle: A password protected file that enables administrators to
securely deploy encryption keys between clustered Intelligence Servers or
servers sharing the same metadata.
l Secure Bundle Code: The password used to protect the Secure Bundle
file.

High Level Steps to Use the Encryption Key Manager

1. Enable the Encryption Key Manager Feature and restart Intelligence
Server.

2. Using Configuration Wizard:

Copyright © 2021 All Rights Reserved 435

In st allat io n an d Co n figu r at io n Gu id e

l Update the metadata to apply the new encryption keys.

l Export the Secure Bundle.

3. To configure additional nodes in a clustered environment:

l Enable the Encryption Key Manager Feature and restart Intelligence

Server.
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 Editor

2. Navigate to HKEY_LOCAL_MACHINE > SOFTWARE > Wow6432Node
> MicroStrategy > Feature Flags.
3. Double click KE/EncryptionKeyManager.
4. Change the Value Data field from 0 to 1.
5. Click OK.

6. Restart Intelligence Server.

If Configuration Wizard is open it must be restarted as well.

Linux

To enable the Encryption Key Manager:

1. Locate the MSIReg.reg file in your MicroStrategy root install directory.

2. Modify the following in a text editor:

Change

Copyright © 2021 All Rights Reserved 436

In st allat io n an d Co n figu r at io n Gu id e

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

4. Restart Intelligence Server.

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 to
become encrypted. The encryption keys and master key are automatically
generated and stored locally during the metadata upgrade. See the Update
the Metadata chapter in the Upgrade Help for steps to complete this
process.

Managing Encryption Key Configuration Options

The import and export features of EKM allow you to securely share and
transmit encryption keys using a secure bundle.

Im porting and Exporting Encryption Keys to a Secure Bundle

Clustered Intelligence Servers or servers sharing the same metadata must

use the same set for encryption keys. This is accomplished by exporting the
secure bundle from the first configured Intelligence Server and then
importing the secure bundle to the other servers.

Copyright © 2021 All Rights Reserved 437

In st allat io n an d Co n figu r at io n Gu id e

For recovery purposes you should export and store a secure bundle outside
of your MicroStrategy environment, even if you are only using a single
Intelligence Server instance. You will not be able to recover the information
stored in your metadata without the secure bundle and secure bundle code.

Exp o r t i n g t o a Secu r e Bu n d l e

1. Open Configuration Wizard.

2. Select Manage Encryption Keys.
3. Click Next.
4. Select Export encryption keys to a Secure Bundle.
5. Click Next.
6. Enter your Administrator user name and password.
7. Click Next.

8. Accept the auto-generated Secure Bundle Code or click the refresh

button to regenerate the code.

Record the generated code value. It will be needed for the importing
process.

9. Click Next.
10. Click Finish to export the Secure Bundle.
11. Review the message on the warning dialog box and click OK.

Im p o r t i n g a Secu r e Bu n d l e

You can use this option to configure additional nodes in a clustered

environment. Ensure that you have updated the metadata associated with
the Intelligence Server before importing the Secure Bundle.

1. Copy the exported Secure Bundle to the target Intelligence Server.

2. Open Configuration Wizard.

3. Select Manage Encryption Keys.

Copyright © 2021 All Rights Reserved 438

In st allat io n an d Co n figu r at io n Gu id e

4. Click Next.
5. Select Import encryption keys from a Secure Bundle
6. Click Next.
7. Enter your Administrator user name and password.
8. Click Next.
9. Click the browse button and navigate to the Secure Bundle location.
10. Click Open to select the file.
11. Enter the Secure Bundle Code from the export process.
12. Click Next.
13. Click Finish to import the Secure Bundle.
14. Review the message on the warning dialog box and click OK

Generating a New Master Key

1. Copy the exported Secure Bundle to the target Intelligence Server.

2. Open Configuration Wizard.

3. Select Manage Encryption Keys.

4. Click Next.
5. Select Generate New Master Key.
6. Click Next.
7. Enter your Administrator user name and password.
8. Click Next.
9. The location of the current Master Key and the destination for the new
Master Key are displayed.
10. Click Next.
11. Click Finish to generate the new Master Key.

Copyright © 2021 All Rights Reserved 439

In st allat io n an d Co n figu r at io n Gu id e

Changing the Master Key Location

To modify the location where the Intelligence Server looks for the Master
Key file:

1. Copy the exported Secure Bundle to the target Intelligence Server.

2. Open Configuration Wizard.

3. Select Manage Encryption Keys.

4. Click Next.
5. Select Change Master Key Location.
6. Click Next.
7. Enter your Administrator user name and password.
8. Click Next.
9. Click the browse button and navigate to the new location for the Master
Key.
10. Specify a name for the Master Key file and click Save.
11. Click Finish to change the Masker Key location.
12. Review the message on the warning dialog box and click OK.

Connecting to a Data Warehouse and Other

Repositories
For MicroStrategy users to be able to browse attribute elements and execute
reports, a connection to a data warehouse must be created. A connection to
other data sources can also support History Lists, statistics, and including
data from multiple data sources into your MicroStrategy project.

You can perform data source connection tasks from the Project
Configuration Editor, which can be accessed by right-clicking a project and
selecting Project Configuration.

Copyright © 2021 All Rights Reserved 440

In st allat io n an d Co n figu r at io n Gu id e

The tasks described in this section require MicroStrategy Administrator

privileges.

Specifying Warehouse Connection Information

A database instance is a MicroStrategy object, created in MicroStrategy
Developer by an administrator, that represents a connection to a data
source. A database instance specifies connection information, such as the
data source name, Login ID and password, and other data source specific
information.

The steps to create the required components of a database instance are

provided in the following sections: Creating a database instance, page 446,
Creating a database connection, page 450, and Creating a database login,
page 456.

When a project architect creates a project, the architect assigns a database

instance to that project. A project specifies only one warehouse database
instance at a time, but a database instance can be assigned to multiple
projects. Since only one data source can be included in the project's
relational schema, all reports and documents return information from a
single data source.

If you have a license for the MultiSource Option feature, you can connect a
project to multiple warehouse database instances. There can be multiple
data sources that connect to the Warehouse Catalog for the project. Since
these data source can be integrated as part of the project's relational
schema, all reports and documents can return information from multiple data
sources. For information on accessing multiple data sources in a project,
see the Project Design Help.

Regardless of whether you have a license for the MultiSource Option, you
can also extend a project's access to multiple data sources through other
MicroStrategy features. Freeform SQL, Query Builder, and supporting
access through MicroStrategy to other MDX cube sources such as SAP BW,
Oracle Essbase, and Microsoft Analysis Services allows non-project

Copyright © 2021 All Rights Reserved 441

In st allat io n an d Co n figu r at io n Gu id e

database instances to be included and used in a project along with the

warehouse database instances. For information on Freeform SQL and Query
Builder, see the Advanced Reporting Help. For information on MDX cube
sources, see the MDX Cube Reporting Help

These non-project database instances can allow a project to connect to the

data sources for the various features and additional data sources mentioned
above, instead of accessing the data from the project's relational schema.
For more information on the Warehouse Catalog, see the Project Design
Help.

SQL data warehouses database instances

A SQL data warehouse database instance is any database instance that
connects to a database or other data source through SQL queries. More
specifically, this covers database instances used for standard MicroStrategy
reporting, Freeform SQL, Query Builder, data marts, and any other relational
data source. You can also connect to History List and statistics tables
through SQL data warehouse database instances. The SQL data warehouse
database instances are available in the Project Configuration Editor, as
shown below.

Copyright © 2021 All Rights Reserved 442

In st allat io n an d Co n figu r at io n Gu id e

Selecting a database instance check box makes that database instance

available in the project for standard MicroStrategy reporting, data marts,
Query Builder, and Freeform SQL. If you have a license for the MultiSource
Option, selecting a check box for a database instance also makes the
database instance available from the Warehouse Catalog to be part of the
project's relational schema.

Database instances can be created as part of the Import Data feature. A

database instance used for the Import Data feature is displayed with the
icon. These database instances are created with security permissions for
the user that created them while using the Import Data feature. If you select
one of these database instances to be included as an available database
instance in the project, it is recommended that you change the security
permissions to a MicroStrategy user with administrative privileges. This
includes taking ownership of the database instance and defining an
appropriate access control list. This ensures that no changes are made to
the database instance by other users, which could cause a loss of
connectivity to the data source. For information on the Import Data feature,
refer to the MicroStrategy Web online help.

The shading and color of a database instance in the list of relational

database instances reflects how the database instance is being used in the
project:

l Blue text: This is the warehouse database instance, as selected from the
warehouse database instance drop-down list. There can only be one
warehouse database instance for a project, because this database
instance's data is populated in the Warehouse Catalog to define the
project's relational schema. You cannot choose to disable the warehouse
database instance for the project without first selecting a different
warehouse database instance.

Copyright © 2021 All Rights Reserved 443

In st allat io n an d Co n figu r at io n Gu id e

If you have a license for the MultiSource Option, the primary database
instance acts as the main source of data for a project and is used as the
default database instance for tables added to the project.

For information on the Warehouse Catalog as well as accessing multiple

data sources with the MultiSource Option, see the Project Design Help.

l Bold text: The project contains objects that are dependent on the
database instance. You cannot choose to disable a database instance that
has dependent objects for the project.
l Normal text: The database instance is not being used in the project.

Clearing the check box of a database instance removes the database

instance from the project and deletes any unused Freeform SQL or Query
Builder schemas. You can clear a database instance from a project only if
there are no dependent objects in the project for the database instance. For
more information on removing a database instance and related Freeform
SQL and Query Builder schemas from a project, refer to the System
Administration Help.

MDX cube database instances

An MDX cube database instance is any database instance that connects to
an MDX cube source, such as SAP BW, Oracle Essbase, or Microsoft
Analysis Services. For information on connecting to and reporting on these
MDX cube sources, refer to the MDX Cube Reporting Help. The MDX cube
database instances are available in the Project Configuration Editor, as
shown below.

Copyright © 2021 All Rights Reserved 444

In st allat io n an d Co n figu r at io n Gu id e

A database instance that has an MDX cube schema is represented with bold
text. The shading and color of a database instance in the list of relational
database instances reflects how the database instance is being used in the
project:

l Bold: The project contains objects that are dependent on the database
instance. You cannot choose to disable a database instance that has
dependent objects for the project.
l Normal: The database instance is not being used in the project.

If you remove an MDX cube database instance from a project, you can
delete any unused MDX cube schema objects. You can remove database
instance from a project only if there are no dependent objects in the project
for the database instance. For more information on removing a database
instance and related MDX cube managed objects from a project, refer to the
System Administration Help.

For additional information on configuring MDX cube database instances,

refer to the MDX Cube Reporting Help.

Copyright © 2021 All Rights Reserved 445

In st allat io n an d Co n figu r at io n Gu id e

MDX schem a loading and m aintenance

You can click Schema Maintenance to perform various tasks for an MDX
cube schema that is part of your project, as described below:

l You can choose when an MDX cube schema associated with a database
instance is loaded for a project. By default, MDX cube schemas are loaded
as needed when MDX cube reports are executed. You can also choose to
load MDX cube schemas when Intelligence Server starts. For information
on defining when MDX cube schemas should be loaded, refer to the MDX
Cube Reporting Help.
l When you integrate MDX cube sources into MicroStrategy, the data is
integrated as an MDX cube schema. Once you integrate an MDX cube
source into MicroStrategy, you can exchange the database instance used
to connect to the MDX cube schema for a different database instance. This
allows you to use different database instances with different login and
connection information to access an MDX cube schema. For information
on exchanging the database instance used to connect to the MDX cube
schema, refer to the MDX Cube Reporting Help.

Creating a database instance

Database instances are created and modified in the Database Instance
Manager, which can be found by expanding Administration for a project
source, then expanding Configuration Managers. When you choose to
create a new database instance, the Database Instances Editor opens.

Copyright © 2021 All Rights Reserved 446

In st allat io n an d Co n figu r at io n Gu id e

You can also create a new database instance using the Database Instance
Wizard that is available in the Database Instance Manager shortcut menu.

The Database Instances Editor has the following tabs:

l General—specifies the database instance name, connection type (data

source platform or applicable data source), and default database
connection.

The database connection type you choose should match your data source
and determines whether the database instance is a relational or an MDX
cube database instance.

l Advanced—specifies the database name for intermediate table storage if a

database other than the warehouse is used to store intermediate tables,
as well as other options.

The Advanced tab is not available for MDX cube database instances.

Copyright © 2021 All Rights Reserved 447

In st allat io n an d Co n figu r at io n Gu id e

l Job Prioritization—specifies the job prioritization scheme for the instance

and the number of prioritized connections.

To create a database instance

1. In MicroStrategy Developer, log in to a project source with
administrative privileges.
2. Go to Administration > Configuration Managers > Database
Instances.
3. From the File menu, go to New > Database Instance. The Database
Instances Editor opens.
4. On the General tab, in the Database instance name field, type the
name of the database instance.
5. In the Database connection type drop-down list, select the data
source connection type according to the data source hosting your
database.

If you have upgraded from a previous version of MicroStrategy, you

can click Upgrade to retrieve any database connection types that have
been included since the previous version of MicroStrategy that you
used.

6. On the Advanced tab, you can configure various options for the
database instance, including:
l Intermediate table storage: You can specify the database name and
table name space to use when intermediate tables are created.
Intermediate tables are created to support various queries.
l Database gateway support: You can support backwards
compatibility for database gateway support from MicroStrategy
version 6.x.
To enable database gateway support, select the Primary
database instance check box, and then select a primary
database instance from the drop-down list. The primary

Copyright © 2021 All Rights Reserved 448

In st allat io n an d Co n figu r at io n Gu id e

database instance is the database instance that should be

used for element browsing against the selected table and for
queries that do not require joins to other tables. For
information on database gateway support, see the Project
Design Help.

l Data mart optimization: You can support data mart optimization if

the data source for the database instance is in the same data source
that contains data marts.
To enable data mart optimization, select the This database
instance is located in the same warehouse as check box,
and then select a database instance from the drop-down list.

l Table prefix: If the tables in your data source use a table prefix, you
can include the table prefix to identify the proper collection of tables.
Click Select to select a table prefix or define a new table prefix.
l ODBC Version: You can define which ODBC version to use for the
database instance, as described below:
n Use 2.0 ODBC Calls: ODBC 2.0 was used in pre-9.0 versions of
MicroStrategy. You can use this option for backward compatibility if
your database management system does not support ODBC 3.x.
This also allows you to use extended fetch to retrieve blocks of data
from the database into memory, instead of row by row, which is
included in the steps Specifying Warehouse Connection
Information, page 441.
n Use 3.x ODBC Calls: The support of ODBC 3.x is introduced in
MicroStrategy 9.0. This value is chosen by default for Database
Instances in MicroStrategy 9.x and higher.You should use this
option if your database management system supports ODBC 3.x.
ODBC 3.x will always use extended fetch (SQLFetchScroll) to
retrieve blocks of data from the database into memory rather than
row-by-row retrieval.

Copyright © 2021 All Rights Reserved 449

In st allat io n an d Co n figu r at io n Gu id e

7. On the Job Prioritization tab, you can configure how jobs are
prioritized for the database instance. For information on configuring job
prioritization, see the System Administration Help.
8. On the General tab, in the Database connection (default) pane,
select the default data source connection and click OK.
If the necessary database connection does not exist, you can create
one by clicking New. For steps to create a database connection, see
Creating a database connection, page 450 below.

Creating a database connection

A database connection specifies the DSN and database login used to access
the data source. A database instance designates one database connection
as the default connection for MicroStrategy users; however, users and
groups can be mapped to other database connections using connection
mapping. For more details on connection mapping, see User connection
mapping, page 458.

You create database connections in the Database Instances Editor by

clicking New on the General tab. Any database connection created within
the Database Instances Editor is available for use across all database
instances in the project source. For more information on creating a database
connection for MDX cube sources, refer to the MDX Cube Reporting Help.

When you choose to create a new database connection, the Database

Connections dialog box opens:

Copyright © 2021 All Rights Reserved 450

In st allat io n an d Co n figu r at io n Gu id e

The Database Connections dialog box has different options depending on

the database instance type:

l SQL data warehouse database instances

n General: Specifies the database connection name, the warehouse DSN,
and the default database login.
n Advanced: Specifies the database driver mode, driver execution mode,
and other miscellaneous warehouse connection settings.
l MDX cube database instances
n General: Specifies the database connection name, the default database
login, and additional connection information that you must provide. For
more information on creating a database connection for MDX cube
sources, see the MDX Cube Reporting Help.
n Advanced: Specifies the connection settings, additional connection
string parameters, and connection caching settings.

Copyright © 2021 All Rights Reserved 451

In st allat io n an d Co n figu r at io n Gu id e

To create a database connection

Before moving forward, ensure that a database instance has been created as
described in Creating a database instance, page 446.

1. On the General tab, in the Database connection name box, type a

name to identify the database connection.
2. In the Local system ODBC data sources pane, select the data source
name for the data source.
3. On the Advanced tab, you can define various options per your
requirements and the requirements of the database you are connecting
to, including:
l Database driver mode: Select one of the following database driver
modes:
l Multi-process: Each connection to the warehouse database is
spawned as a separate process, identified in Windows Task
Manager as M8DBMPE.exe. If one process fails, such as when a
database access thread hangs or is lost, other processes are not
affected.
l Multi-threaded: All connections to the warehouse database are
maintained inside the Intelligence Server process MSTRSVR.exe.
All connections, SQL submissions, and data retrievals from the
database are handled within this process.

MicroStrategy recommends setting all database drivers to multi-

process mode. The robustness and stability which come with multi-
process mode greatly overshadow any increased efficiency that
may come with multi-threaded mode. Problems that appear random
and sporadic in multi-threaded operation can often be resolved by
switching to multi-process mode.

l Driver execution mode: Define the driver execution mode depending

on the ODBC driver being used:

Copyright © 2021 All Rights Reserved 452

In st allat io n an d Co n figu r at io n Gu id e

l Asynchronous Connection: All statements allocated within the

connection should be able to run SQL asynchronously.
l Asynchronous Statement: For each statement, the asynchronous
mode is explicitly set.
l Synchronous: Only one statement executes at a time. This is the
default value.

Many newer ODBC drivers do not support asynchronous mode

because the driver is capable of opening a new thread and executing
a new query while simultaneously running an earlier query. The
MicroStrategy Readme gives recommendations for the driver
execution mode options that can be used for different ODBC drivers.

l Use extended fetch: Select this check box to enable Intelligence

server to fetch blocks of data from the database into memory, instead
of row-by-row. Be aware that this check box is only available if the
database instance is defined to use 2.0 ODBC calls, which is included
in the steps Specifying Warehouse Connection Information, page
441. When 3.0 ODBC calls are enabled, extended fetch is already
enabled and this option is grayed out.

l Use parameterized queries: Select this check box to enable

Intelligence server to pass data to the database in blocks instead of
row-by-row. For information on how parameterized queries can
improve performance in MicroStrategy, see the Project Design Help.

In live dossiers connected to certified gateways, as well as reports

and cubes executed against a warehouse, all SQL executions
containing text input from filters, search conditions, and text prompts
are secured through parameterized queries. Starting in 2021 Update
4, this functionality is also extended to transaction inputs in
transaction server reports and documents. See KB485174 for more
information about the transaction part of this security feature and a
list of certified gateways. See KB484512 for more information about

Copyright © 2021 All Rights Reserved 453

In st allat io n an d Co n figu r at io n Gu id e

the non-transaction part of this security feature and a list of certified

gateways.

l Maximum cancel attempt time (sec): Defines the maximum amount

of time the MicroStrategy Query Engine waits for a successful attempt
before it cancels a query. Values of 0 and -1 indicate no limit.
l Maximum query execution time (sec): Defines the maximum
amount of time a single pass of SQL can execute on the database.
Values of 0 and -1 indicate no limit.
l Maximum connection attempt time (sec): Defines the maximum
amount of time Intelligence Server waits to connect to the database.
Values of 0 and -1 indicate no limit.
l Additional connection string parameters: Enables you to pass
additional ODBC connection parameters to the database as part of
the connection string. This is useful if you need to change ODBC
defaults. Click Preview to see the entire connection string.
l Table prefix: Defines a table prefix that specifies the schema
containing the tables to access.
l Character set encoding for Windows drivers: The options listed
below are only relevant when Intelligence Server is running on a
Windows machine:
n Non UTF-8 (default): Select this option if the ODBC driver returns
information in a character encoding other than UTF-8.
n UTF-8: Select this option if the ODBC driver returns information in
UTF-8 character encoding. Drivers for Teradata databases may
require UTF-8 encoding.
l Character set encoding for UNIX drivers: The options listed below
are only relevant when Intelligence Server is running on a UNIX
machine:
n Non UTF-8: Select this option if the ODBC driver returns
information in a character encoding other than UTF-8.

Copyright © 2021 All Rights Reserved 454

In st allat io n an d Co n figu r at io n Gu id e

n UTF-8 (default): Select this option if the ODBC driver returns

information in UTF-8 character encoding. Drivers for Teradata
databases may require UTF-8 encoding.
l Connection Caching: Specify the caching of the database
connection using the following options:
n Connection idle timeout (sec): Defines the amount of time an
inactive connection to the database remains cached until it is
terminated. You must also set the Connection lifetime, described
above, to a value greater than zero for database connections to be
used by more than a single job.

Enforcement of the connection idle timeout can cause a database

connection to be removed before it reaches its connection lifetime.
You can use this connection idle timeout to ensure that database
connections do not remain in Intelligence Server memory in an idle
state for an extended amount of time.

Enforcement of the connection idle timeout can cause a database

connection to be removed before it reaches its connection lifetime.
You can use this connection idle timeout to ensure that database
connections do not remain in Intelligence Server memory in an idle
state for an extended amount of time.

Enforcement of the connection idle timeout can cause a database

connection to be removed before it reaches its connection lifetime.
You can use this connection idle timeout to ensure that database
connections do not remain in Intelligence Server memory in an idle
state for an extended amount of time.

If you type a value of 0, when the job associated with a database

connection is completed, the database connection is deleted and
not put into a cache. If you type a value of -1, a database
connection can remain idle and considered for new jobs until the
database connection lifetime is reached.

Copyright © 2021 All Rights Reserved 455

In st allat io n an d Co n figu r at io n Gu id e

4. On the General tab, in the Default database login name pane, select
the default database login and click OK.

If the necessary database login does not exist, you can create one by
clicking New. For steps to create a database connection, see Creating
a database login, page 456 below.

Creating a database login

A database login specifies the user ID and password used to access the
data source. The database login overwrites any login information stored in
the DSN. A database connection designates one database login as the
default login for MicroStrategy users, however users and groups can be
mapped to other database logins using connection mapping.

Connection mapping is explained in User connection mapping, page 458.

You create database logins in the Database Connections dialog box by

clicking New on the General tab. Any database login created within the
Database Connections dialog box is available for use across all database
connections in the project source.

MicroStrategy reporting and analysis features require a general set of

database login permissions that can connect to and modify the data source
and metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions are required.
Intermediate tables are created in the metadata for recursive search
queries, which requires Create and Drop permissions as well. Updating
the schema requires the Delete permission.
l For the data warehouse, the Select, Create, Insert, and Drop permissions
are required.

When you choose to create a new database login, the Database logins
dialog box opens:

Copyright © 2021 All Rights Reserved 456

In st allat io n an d Co n figu r at io n Gu id e

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 database

instance, page 446.
l A database connection has been created, as described in Creating a
database connection, page 450.

1. In the Database Login field, type the name of the database login.
2. Provide the user ID and password required to access the data source,
using one of the following methods:
l Type the user ID in the Login ID field, and type the password for that
user ID in the Password field.
l Select the Use network login ID check box to connect to the data
source using the network user credentials which are also used to run
Intelligence Server. If Intelligence Server is running as a service, this
is the user that is running the mstrsvr.exe process. To determine
this user, in MicroStrategy Service Manager, select MicroStrategy
Intelligence Server and click Options. The user is listed on the
Service Startup tab, in the Login field. If the Service Account Name is
defined as System Account, the Windows user credentials are used to
access the data source.
3. Click OK.

Copyright © 2021 All Rights Reserved 457

In st allat io n an d Co n figu r at io n Gu id e

Database logins are passed to the data source any time a user executes a
report or browses attribute elements. Therefore, all database logins created
in MicroStrategy Developer must be also be created as valid logins in the
data source.

User connection mapping

User connection mapping is the process of mapping MicroStrategy users to
database connections and database logins. For MicroStrategy users to
execute reports, they must be mapped to a database connection and
database login.

MicroStrategy users link to database connections and logins using:

l The default database connection (and, therefore, default database login)

l Specialized maps to a database connection and/or database login
(different than the default connection and login) for either a user or user
group

You can map users to connections and logins in the Project Configuration
Editor or Command Manager. For information about how connection maps
are used, see the System Administration Help.

MicroStrategy reporting and analysis features require a general set of

database login permissions to connect to and modify the data warehouse
and metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions are required.
Intermediate tables are created in the metadata for recursive search
queries, which requires Create and Drop permissions as well. Updating
the schema requires the Delete permission.
l For the data warehouse, the Select, Create, Insert, and Drop permissions
are required.

Copyright © 2021 All Rights Reserved 458

In st allat io n an d Co n figu r at io n Gu id e

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 database

instance, page 446.
l A database connection has been created, as described in Creating a
database connection, page 450.
l A database login has been created, as described in Creating a database
login, page 456.

1. In Developer, log in to a project.

2. Right-click the project and select Project Configuration. The Project
Configuration Editor opens.
3. In the Categories list, expand the Database Instances category, and
then select Connection mapping.
4. Right-click in the Database instances - Connection mapping pane,
and select New. A new connection mapping is added.
5. You can define the connection mapping by specifying the information
described below:
l Database Instance: The database instance which connects to the
data 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 connection
mapping. You can use connection mappings to support data
internationalization. For information on supporting data
internationalization with connection mappings, see the Project Design
Help.
l Database connection: The data source to connect to.
l Database Login: The database login for the connection mapping.
6. Click OK.

Copyright © 2021 All Rights Reserved 459

In st allat io n an d Co n figu r at io n Gu id e

Related
If the table information is not updated, although you have performed correct
steps, see KB483323: Unable to update table structure in MicroStrategy
Developer Warehouse Catalog.

Creating a Project
Now you have configured Intelligence Server and are ready to create a
project. There are various ways to create a project to get your MicroStrategy
project started. The different methods to create a project are described in
the Project Design Help.

The MicroStrategy platform provides a Tutorial project, which is a sample

data warehouse and demonstration project you can use to learn about the
various features that MicroStrategy offers. It is ready to be used and
requires no additional configuration tasks. To use the MicroStrategy
Tutorial, refer to the Basic Reporting Help for more information. To create a
new project using your own data, see the Project Design Help.

How to Connect the Intelligence Server to a specific

Export Engine
By default, the Intelligence Server connects to the NEE on the same
machine as it through port number 20100. Based on this connection NEE
services will start on port 20100, and the Intelligence Server will access
localhost's port 20100 for export.

However, you can configure the NEE and Intelligence Server default settings
to connect to a specific export engine.

Copyright © 2021 All Rights Reserved 460

In st allat io n an d Co n figu r at io n Gu id e

Configuring the Intelligence Server

1. Open the registry file.
2. Edit the NEE's application.properties file to set the host to the
location of the NEE service, and the port value of server.port property.

3. On Linux, edit 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 Intelligence Server.
6. Open the registry file.

Configuring NEE to Use a Specific Port Number

1. Edit the PDFExportService/application.properties file.
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 the
Intelligence Server's registry to ensure that the server can access the
updated NEE service.

Configuring your MicroStrategy Installation

To help guide the rest of your installation and configuration steps, refer to
the section Installing and Configuring MicroStrategy on Windows, page 140
in Chapter 1, Planning Your Installation, for an installation and configuration
checklist.

Copyright © 2021 All Rights Reserved 461

In st allat io n an d Co n figu r at io n Gu id e

Data Import with Proxy

Introduction to Data Import with Proxy

This section provides an overview of all of the capabilities to get data
through proxy. You will learn how to best leverage these capabilities to
import data and create or update your datasets.

Background
Many enterprise customers cannot import data from URL sources, as they
are in a proxy environment. This considerably inhibits their ability to ingest
data from external sources, and limits MicroStrategy's ability to analyze the
data. Supporting proxy considerably increases their ability to analyze any
third-party data that is currently available via import from URL. There are
also customers in a proxy environment who cannot access Facebook,
Twitter, or other OAuth sources. In short, supporting proxy configuration is
needed for customers in some limited network environment, which is typical
in enterprise deployments.

Currently, we support proxy for File from URL, Sample File, Twitter,
Dropbox, Google Analytics, Google Drive, Google BigQuery, and BI Tools.
Proxy servers with or without basic authentication are supported when
setting a static proxy. We also support proxy setting with PAC files, but
cannot support PAC files with authentication. If authentication for proxy is
required, the USE_PROXY_PAC value in config.json must be set to
false.

See also How to Configure a Proxy.

Copyright © 2021 All Rights Reserved 462

In st allat io n an d Co n figu r at io n Gu id e

How to Configure a Proxy

How to Configure a Proxy in Intelligence Server for Windows

1. Find the configuration file.

After you install or update Workstation for Windows to 10.11 or later,

the default configuration file, proxy.json, is installed automatically.

The file proxy.json is located in C:\Program Files

(x86)\Common Files\MicroStrategy for Intelligence
Server by default.

2. Configure the proxy.json file.

Open proxy.json with a text editor. The following is the default

configuration:

{
"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

Copyright © 2021 All Rights Reserved 463

In st allat io n an d Co n figu r at io n Gu id e

If the username or password contains special characters such as " or \,

please use escape characters for them. For example, if your proxy
username is domain\user, the setting must be "USER_NAME":
"domain\\user" in proxy.json.

Configure proxy.json as follows:

{
"ENABLE_FLAG": "TRUE",
"USE_PROXY_PAC": "FALSE",
"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:

{
"ENABLE_FLAG": "TRUE",
"USE_PROXY_PAC": "FALSE",
"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 is
C:/Config. Configure your proxy.json as follows:

Copyright © 2021 All Rights Reserved 464

In st allat io n an d Co n figu r at io n Gu id e

{
"ENABLE_FLAG": "TRUE",
"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
access issues occur if the format is correct, but the proxy server is
inaccessible.

3. Restart the Intelligence Server.

4. Verify your data.

If you verify data from a URL, you can import data from a source that
was previously inaccessible.

You should always restart the Intelligence Server after changing the
proxy configuration or the PAC file.

To verify that the proxy is taking effect, retrieve a proxy log by

enabling the RESTWrapper Info log in the MicroStrategy Diagnostics
and Performance Logging Tool.

How to Configure a Proxy in Workstation (Windows or Mac) and

the Intelligence Server (Linux)
The steps for other platforms are similar to configuring the Intelligence
Server for Windows. The difference is the proxy.json file location and the
method to restart the server.

Copyright © 2021 All Rights Reserved 465

In st allat io n an d Co n figu r at io n Gu id e

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/OneTierDashboardwindo
w.framework/Resources by default.

Configuration Field Descriptions

Item Description

Enable or disable the proxy. If the flag is false, the

ENABLE_FLAG proxy does not take effect, regardless of the values
in other fields.

Set USE_PROXY_PAC or USE_PROXY_STATIC to

USE_PROXY_PAC
TRUE to turn on the PAC mode or static mode.

Specify the path of the PAC file. Both local and

online files are supported, such as
PAC_URL
Z:/BIN/X64/demo.pac or
http://test/demo.pac.

If this flag is set to TRUE, PROXY_HOST and PROXY_

USE_PROXY_STATIC
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)

Static proxy authentication flag. If this flag is true,

use specified USER_NAME and PASSWORD to access
PROXY_AUTHENTICATION
the static proxy server. This is supported only in
static mode, PAC mode is currently not supported.

USER_NAME User name to access the static proxy server

PASSWORD Password to access the static proxy server

Copyright © 2021 All Rights Reserved 466

In st allat io n an d Co n figu r at io n Gu id e

The ENABLE_FLAG is set to FALSE by default. This means any proxy

configured in this file takes effect when you configure the system proxy. If
you 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 the
RESTWrapper Info log in the MicroStrategy Diagnostics and Performance
Logging Tool.

Priority
There are two levels of proxy settings in MicroStrategy.

l The higher priority level is the server-level configuration, which is

configured in proxy.json.
l The lower priority level is the system configuration, which is an
environment variable in Linux or MacOS, and internet properties in
Windows.

Limitation
The proxy setting is global. MicroStrategy uses the same proxy, even if a
different user logs in.

Copyright © 2021 All Rights Reserved 467

In st allat io n an d Co n figu r at io n Gu id e

D EPLOYIN G
M ICRO STRATEGY W EB
AN D M OBILE SERVER

Copyright © 2021 All Rights Reserved 468

In st allat io n an d Co n figu r at io n Gu id e

This chapter describes the procedure to deploy a project to your user

community using MicroStrategy Web and Mobile Server. The process of
deploying the .NET version of MicroStrategy Web or MicroStrategy Mobile
Server on Windows with Microsoft Internet Information Services (IIS) is
explained in detail.

Steps to deploy MicroStrategy Web (JSP) and MicroStrategy Mobile Server

(JSP) in a Linux and Windows environment with various Web and application
servers are also explained in detail. MicroStrategy Web (JSP) and Mobile
Server (JSP) are platform-independent and can be deployed using different
combinations of operating systems, Web servers, and application servers.

Web application servers are not MicroStrategy products, so detailed steps

cannot be provided for every combination of application server and
operating system. This chapter supplies instructions for a few of the most
common combinations. The procedures for different operating systems are
similar, but you should refer to the vendor-provided information and
documentation for details specific to your configuration, or contact
MicroStrategy Technical Support.

MicroStrategy Web simplifies the job of deploying to large user groups

because end users' machines only need a supported browser. MicroStrategy
Web can be accessed from any supported browser because no code must be
downloaded. Working as a thin client, MicroStrategy Web provides the
functionality that end users and power users require to take full advantage
of the MicroStrategy product suite.

Deploying with IIS (Windows)

Microsoft IIS can be used to deploy MicroStrategy Web and MicroStrategy
Mobile Server:

Copyright © 2021 All Rights Reserved 469

In st allat io n an d Co n figu r at io n Gu id e

Deploying MicroStrategy Web

The ASP.NET version of MicroStrategy Web can be deployed with IIS only
on Windows.

l You must have administrative privileges to deploy MicroStrategy Web for

your project. If this is the first time you are logging in and you have not
changed the default MicroStrategy administrative login, you can use
Administrator as the login with no password. After the first time, the user
name and password should be changed for security purposes.
l The Microsoft Windows' Users group must have read and execute
permissions to all of the files within the MicroStrategy common files folder.
This ensures that Internet Information Services has the required permissions
to host MicroStrategy Web. By default, this folder is stored in the following
directory location:
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, go to Programs > MicroStrategy Tools >

Web Administrator. The MicroStrategy Web Administrator page
where you connect MicroStrategy Web to the Intelligence Server opens.
2. Type the name of your Intelligence Server in the Add a server
manually box on the MicroStrategy Web Administrator page.
3. Click Connect. All projects loaded on the Intelligence Server are now
available from MicroStrategy Web. Click the Home icon to see the list
of projects loaded on the Intelligence Server you specified.

4. Send your users the URL:

http://webservername/MicroStrategy/asp/

Copyright © 2021 All Rights Reserved 470

In st allat io n an d Co n figu r at io n Gu id e

where webservername is the name of the computer hosting your Web

server. For example, if the name of your Web server machine is Web_
Srv1, then the URL your users would use to access MicroStrategy Web
would be

http://Web_Srv1/MicroStrategy/asp

You have manually connected MicroStrategy Web to the Intelligence Server.

You can also connect automatically whenever MicroStrategy Web Server or

Intelligence Server starts.

To make MicroStrategy Web connect to the Intelligence Server

automatically

1. On the MicroStrategy Web Administrator page, click Modify in the

Properties column of the Intelligence Server.
2. Select the Automatically connect to Intelligence Server when Web
Server or Intelligence Server is restarted option and click Save.

Deploying Mobile Server

The ASP.NET version of MicroStrategy Mobile Server can only be deployed
with IIS only on Windows.

l You must have administrative privileges to deploy MicroStrategy Mobile

Server for your project. If this is the first time you are logging in and you have
not changed the default MicroStrategy administrative login, you can use
Administrator as the login with no password. After the first time, the user
name and password should be changed for security purposes.
l The Users group for Microsoft Windows must have read and execute
permissions to all of the files within the MicroStrategy common files folder.
This ensures that IIS has the required permissions to host MicroStrategy
Mobile Server. By default, this folder is stored in the following directory
location:

Copyright © 2021 All Rights Reserved 471

In st allat io n an d Co n figu r at io n Gu id e

l 64-bit Windows environments: C:\Program Files\Common

Files\MicroStrategy
l 64-bit 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 > Mobile

Administrator.
2. Type the name of your Intelligence Server in the Add a server
manually box on the MicroStrategy Mobile Server Administrator page.
3. Click Connect.
4. Click Mobile Configuration to configure your MicroStrategy Mobile
applications to communicate with Mobile Server and Intelligence
Server. For steps on how to define this configuration, see the
MicroStrategy Mobile Administration Help.

You have manually connected MicroStrategy Mobile Server to the

Intelligence Server.

You can also connect automatically whenever MicroStrategy Mobile Server

or Intelligence Server starts.

To make MicroStrategy Mobile Server connect to the Intelligence

Server automatically

1. On the MicroStrategy Mobile Server Administrator page, click Modify in

the Properties column of the Intelligence Server.
2. Select the Automatically connect to Intelligence Server when
Mobile Server or Intelligence Server is restarted option.
3. Click Save.

Copyright © 2021 All Rights Reserved 472

In st allat io n an d Co n figu r at io n Gu id e

General Steps to Deploy MicroStrategy JSP

Applications
After you have installed MicroStrategy Web (JSP), Mobile Server (JSP) you
can deploy and configure it for your specific environment. The configuration
and deployment steps are provided in the Web server and application server
sections in this chapter. The table below lists the general steps for all
environments.

MicroStrategy Web JSP

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

You must perform extra configuration steps to allow graphs to support non-
Western European fonts on MicroStrategy Web (JSP) for a Linux system.
For more information, see Graph and Document Support of Non-Western
European Fonts, page 834 of Appendix B, Troubleshooting.

Copyright © 2021 All Rights Reserved 473

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Mobile Server (JSP)

1. Log on to the application server by using the proper user name and
password.
2. Locate the MicroStrategyMobile.war file in the MicroStrategy Mobile
Server (JSP) Deployment Directory you specified during installation.
3. To increase the performance of the application before proceeding with
the deployment, see the Performance-based setup information section,
if available, for your environment and configure as necessary. Also,
after deploying MicroStrategy Mobile Server (JSP) on your machine,
there may be a few performance-based setup steps that you should
complete.
4. Choose the desired deployment method and follow the deployment
procedure.
5. Log on to the MicroStrategy Mobile Server Administrator Page.
6. From the MicroStrategy Mobile Server Administrator Page, configure
your MicroStrategy Mobile applications to communicate with Mobile
Server and Intelligence Server. For steps on how to define this
configuration, as well as steps to deploy and configure a certificate
server for Mobile Server, see the MicroStrategy Mobile Administration
Help.
7. Start working with the application.

Locating the WAR File

The MicroStrategy JSP applications are packaged within single files for each
application, called a WAR (Web ARchive) file, following J2EE specifications.
You must deploy the WAR file to run the JSP applications in your application
server environment.

The WAR files are placed in the folder you specified when installing
MicroStrategy JSP applications. The default locations are as follows:

Copyright © 2021 All Rights Reserved 474

In st allat io n an d Co n figu r at io n Gu id e

Component and WAR File Name Default WAR File Location

32-bit Windows environments: C:\Program

Files\MicroStrategy\WebJSP

64-bit Windows environments: C:\Program Files

MicroStrategy Web (JSP) (x86)\MicroStrategy\WebJSP

MicroStrategy.war Linux environments: INSTALL_PATH/WebUniversal

Where INSTALL_PATH is the directory you specified

as the MicroStrategy install directory during
installation.

32-bit Windows environments: C:\Program

Files\MicroStrategy\Mobile Server JSP

64-bit Windows environments: C:\Program Files

(x86)\MicroStrategy\Mobile Server JSP
MicroStrategy Mobile Server (JSP)
Linux environments: INSTALL_
MicroStrategyMobile.war
PATH/ Mobile/MobileServer

Where INSTALL_PATH is the directory you specified

as the MicroStrategy install directory during
installation.

32-bit Windows environments: C:\Program

Files\MicroStrategy\Library

64-bit Windows environments: C:\Program Files

(x86)\MicroStrategy\Library

MicroStrategy Library (JSP) Linux environments: INSTALL_

MicroStrategyLibrary.war PATH/LibraryWebMobile

Where INSTALL_PATH is the directory you specified

as the MicroStrategy install directory during
installation.

To deploy the application, you must follow a set of steps that are specific to
the application server you are using. For more details, see the application
server vendor documentation or follow the instructions within this guide.

Copyright © 2021 All Rights Reserved 475

In st allat io n an d Co n figu r at io n Gu id e

After deploying a WAR file, you can view the WEB-INF folder, which contains
a subfolder named log. The log folder retains all the log files. For more
information on the directory structure after deploying the WAR file, see
Directory Structure After Deploying the WAR File, page 477.

Locating the Configuration Files

If you have configured your application server to deploy exploded WAR files,
the sys_defaults and sys_definitions XML configuration files are
located in /WEB-INF/xml in the exploded directory. In Tomcat, these
exploded directories are located in the webapps/ subdirectory of the Tomcat
installation.

l When deploying MicroStrategy Web (JSP), the exploded directory is

named MicroStrategy by default.
l When deploying MicroStrategy Mobile Server (JSP), the exploded
directory is named MicroStrategyMobile by default.

If you have configured your application server to deploy an unexploded WAR

file, the configuration files are created in the system's default temporary file
directory. For Windows systems, the temporary file directory is usually
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 file directory is usually
/tmp/ or /var/tmp/.

l When deploying MicroStrategy Web (JSP), a /microstrategy/web-

Version/ folder is created in the temporary file directory, where
Version is the version number for the MicroStrategy Web (JSP) product.
Within this folder location, various configuration files can be found within
the WEB-INF folder and its subfolders.
l When deploying MicroStrategy Mobile Server (JSP), a
/microstrategy/mobile-Version/ folder is created in the temporary
file directory, where Version is the version number for the MicroStrategy
Mobile Server (JSP) product. Within this folder location, various

Copyright © 2021 All Rights Reserved 476

In st allat io n an d Co n figu r at io n Gu id e

configuration files can be found within the WEB-INF folder and its
subfolders.

Directory Structure After Deploying the WAR File

The following tables show the default directory structure after deploying
MicroStrategy WAR files in your application server.

MicroStrategy Web

Directory Contents

\assets Supporting files

\html Supporting files

\images All image files

\javascript Interface JavaScript files

\jsp Interface JSP code files

\META-INF Configuration files

\plugins Plug-in files for customizations

\resBundles Flash descriptor files

\style Interface style files

\swf Supporting files for widgets

\VisFramework Supporting files for visualizations

Configuration information for MicroStrategy

\WEB-INF
Web

Copyright © 2021 All Rights Reserved 477

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Mobile Server

Directory Contents

\assets Supporting files

\html Supporting files

\images All image files

\javascript Interface JavaScript files

\jsp Interface JSP code files

\META-INF Configuration files

\plugins Plug-in files for customizations

\style Interface style files

\swf Supporting files for widgets

\VisFramework Supporting files for visualizations

Configuration information for MicroStrategy

\WEB-INF
Mobile Server

Deploying with Tomcat (Windows)

This section provides information used to deploy and configure
MicroStrategy JSP applications in a Tomcat-only environment. For
information on how to configure Tomcat to work with IIS, see
iishowto.html (Tomcat 9.0.x) in the Tomcat documentation. You can use
the steps below to deploy MicroStrategy Web (JSP) and MicroStrategy
Mobile Server (JSP):

l Preconfiguration Information, page 479: Configuration that must occur

before you begin deploying MicroStrategy Web (JSP), Mobile Server (JSP)
(JSP).
l Deploying MicroStrategy Web and Mobile Server, page 481: Instructions
for deploying, including step-by-step procedures.

Copyright © 2021 All Rights Reserved 478

In st allat io n an d Co n figu r at io n Gu id e

Preconfiguration Information
This section provides the preconfiguration information necessary to deploy
MicroStrategy JSP applications on Tomcat on your machine.

Installing the JDK

If you have not installed the AdoptOpen JDK yet, download the file from the
website. Be sure to install the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where you
install the JDK. If you install the JDK to a simple folder path such as C:\
setting the system variable is easier and more likely to be correct.

Configuring the JDK

The third-party products discussed below are manufactured by vendors

independent of MicroStrategy, and the steps to configure these products is
subject to change. Refer to the appropriate Microsoft documentation for
steps to access and modify the environment variables.

1. From the Start menu, go to Computer > System properties >

Advanced system settings > Environment Variables > System
Variables.
2. Under , click 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 you
installed the JDK and click OK.

For example, if the fully qualified path to your JDK executable is

C:\jdk1.11.0\bin\java.exe, the value of your JAVA_HOME variable
is C:\jdk1.11.0.

If you have installed JDK under the Program Files folder, type Progra~1
when specifying the folder name in the Variable Value box; otherwise the

Copyright © 2021 All Rights Reserved 479

In st allat io n an d Co n figu r at io n Gu id e

system does not recognize the folder. For example, type

C:\Progra~1\jdk1.11.0 in the Variable Value box.

Configuring Tomcat
This procedure assumes that you have downloaded and installed Tomcat on
your machine. You can download Tomcat from the Apache website;
depending on the version you want to download, you may need to locate the
appropriate file in Apache's Archive area. Instructions for downloading and
installing Tomcat are also available on the Apache website.

To configure Tomcat, a system variable must point to the folder where you
install Tomcat. Installing Tomcat to a simple folder path such as C:\Tomcat
makes it easier to define the system variable.

The third-party products discussed below are manufactured by vendors

independent of MicroStrategy, and the steps to configure these products is
subject to change. Refer to the appropriate Microsoft documentation for
steps to access and modify the environment variables.

1. From the Start menu, go to Computer > System properties >

Advanced system settings > Environment Variables > System
Variables.
2. Click New to create a system variable.
3. In the Variable Name field, type CATALINA_HOME.
4. In the Variable Value field, specify the path of the folder where you
installed Tomcat and click OK. For example, if you installed Tomcat
directly to the C drive, the destination folder is C:\Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1
when specifying the folder in the Variable Value box. Otherwise, the system
does not recognize the folder. For example, type C:\Progra~1\Tomcat in
the Variable Value box.

Copyright © 2021 All Rights Reserved 480

In st allat io n an d Co n figu r at io n Gu id e

Setting the Java heap size

The Java heap size for the Tomcat can be modified by defining the JAVA_
OPTS parameter in the catalina.bat file. For example, you can define this
parameter as follows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modified to reflect the requirements of your

specific environment. Refer to your third-party application server
documentation for information on how to determine a satisfactory Java heap
size for your environment.

Deploying MicroStrategy Web and Mobile Server

Assuming you have made all the necessary configurations described above,
you can begin deploying MicroStrategy Web (JSP), Mobile Server (JSP)
(JSP) with Tomcat.

Deploying using Tomcat as a stand-alone Web container

To deploy MicroStrategy JSP applications using Tomcat as a stand-

alone Web container

1. Locate the WAR file for your MicroStrategy JSP application.

2. Copy the WAR file to the Tomcat\webapps folder.
3. From the Start menu, select Run.
4. Type cmd in the Open drop-down list and click OK.

5. Browse to the Tomcat\bin folder, where Tomcat is the folder in which

you installed Tomcat. For example, in the command prompt, type

cd C:\Tomcat\bin

6. Click Enter. C:\Tomcat\bin> is displayed at the command prompt.

7. Type the required commands to start and stop Tomcat, which depends
on your version of Tomcat. For example, for Tomcat 9, type Tomcat9

Copyright © 2021 All Rights Reserved 481

In st allat io n an d Co n figu r at io n Gu id e

start to start Tomcat and type Tomcat9 stop to stop Tomcat. Refer
to your third-party Apache documentation for information on the
commands to start and stop Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1
when you change folders in the command prompt. Otherwise, the system
does not recognize the folder. For example, type
C:\Progra~1\Tomcat\bin in the command prompt.

Your MicroStrategy JSP application is deployed automatically, based on the

following:

l If you have configured Tomcat to deploy an exploded WAR file, which is

often the default behavior, a folder is created within the Tomcat\webapps
folder:
l When deploying MicroStrategy Web (JSP), the folder is named
MicroStrategy by default.
l When deploying MicroStrategy Mobile Server (JSP), the folder is named
MicroStrategyMobile by default.
l If you have configured Tomcat to deploy an unexploded WAR file, the
configuration files are created within the system's default temporary file
directory. For Windows systems, the temporary file directory is commonly
defined by the TMP environment variable:
l When deploying MicroStrategy Web (JSP), a /microstrategy/web-
Version/ folder is created within the temporary file directory, where
Version is the version number for the MicroStrategy Web (JSP)
product. Within this folder location, various configuration files can be
found within the WEB-INF folder and its subfolders.
l When deploying MicroStrategy Mobile Server (JSP), a
/microstrategy/mobile-Version/ folder is created within the
temporary file directory, where Version is the version number for the
MicroStrategy Mobile Server (JSP) product. Within this folder location,
various configuration files can be found within the WEB-INF folder and
its subfolders.

Copyright © 2021 All Rights Reserved 482

In st allat io n an d Co n figu r at io n Gu id e

Configuring administrative access your MicroStrategy JSP

applications
To allow users authorized to access MicroStrategy Web Administrator,
MicroStrategy Mobile Server Administrator, you must create the users and
assign them the role of admin under the Tomcat user configuration file. The
steps 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 file in a

program that allows you to edit the file, such as Notepad.
2. Add the following tag and save the file:

<user name="administrator" password="administrator"

roles="admin"/>

You can specify any value in the user name and password fields.

3. Stop and start Tomcat from the command line.

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for your
MicroStrategy JSP application.

1. Access the servlet by typing the following URL in a Web browser:

l For Web (JSP):
http://
localhost:8080/MicroStrategy/servlet/mstrWebAdmin
l For Mobile Server (JSP):
http://
localhost
:8080/MicroStrategyMobile/servlet/mstrWebAdmin

Copyright © 2021 All Rights Reserved 483

In st allat io n an d Co n figu r at io n Gu id e

The servlet names at the end of the URL are case-sensitive. Make sure
to use the correct case when typing the servlet name. If the application
server is enabled with security, a dialog box related to the administrator
authentication opens.

If you are using Tomcat integrated with IIS, you do not need to specify
the port number in the URL. However, when using Tomcat as a stand-
alone Web container, you must specify the port number. The default
port for Tomcat is 8080.

2. When prompted for a user name and password, use the same values
you specified in the tomcat-users.xml file.
3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy Web
Administrator page appears. Add and connect to an Intelligence Server.
4. If you are deploying MicroStrategy Mobile Server (JSP), the
MicroStrategy Mobile Server Administrator page appears. Add and
connect to an Intelligence Server. Once connected, click Mobile
Configuration to configure your MicroStrategy Mobile applications to
communicate with Mobile Server and Intelligence Server. For steps on
how to define this configuration, see the MicroStrategy Mobile
Administration Help. Creating a configuration completes the steps
required to deploy Mobile Server (JSP).

Launching the project

In a Web browser, access MicroStrategy Web (JSP) using this URL:

http://localhost:8080/MicroStrategy/servlet/mstrWeb

Deploying with Tomcat (Linux)

This section provides information on how to deploy and configure
MicroStrategy JSP applications with Tomcat in a Linux environment. You
can use the steps below to deploy MicroStrategy Web (JSP) and
MicroStrategy Mobile Server (JSP):

Copyright © 2021 All Rights Reserved 484

In st allat io n an d Co n figu r at io n Gu id e

l Preconfiguration Information, page 485: Configuration that must occur

before you begin deploying MicroStrategy Web (JSP), Mobile Server (JSP)
(JSP).
l Deploying MicroStrategy Web and Mobile Server, page 487: Instructions
for deploying, including detailed steps.

Preconfiguration Information
This section provides the preconfiguration information necessary to deploy
MicroStrategy JSP applications with Tomcat on your Linux machine.

Installing the JDK

If you have not installed the AdoptOpen JDK yet, download the file from the
website. Be sure to install the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where you
install the JDK. If you install the JDK to a simple folder path such as C:\
setting the system variable is easier and more likely to be correct.

From the location in which to install the JDK, run the file you downloaded:

jdk-Version-linux-i586.bin

For example, to install version 1.11.0, type the following:

jdk-1_11_0-linux-i586.bin

Configuring the JDK

1. Open the /etc/profile file using a program that allows you to edit
the file.
2. Add the following line:

export JAVA_HOME=/PathName/jdkVersion;

where PathName is the destination folder where you installed the JDK
and Version is the version, such as 1_11_0, of the JDK.

Copyright © 2021 All Rights Reserved 485

In st allat io n an d Co n figu r at io n Gu id e

Installing Tomcat
This procedure assumes that you have downloaded and installed Tomcat in
a directory named Tomcat on your machine. If you have not installed
Tomcat yet, download the zip file from the following links:

l Tomcat 9.0.x
l Tomcat 8.0.x

Contact your System Administrator or visit the Apache website for

instructions on downloading and installing Tomcat.

Configuring Tomcat
After you install Tomcat, you must configure Tomcat. The Tomcat
configuration includes creating the environment variable CATALINA_HOME
and defining this environment variable to point to the Tomcat directory.

1. Open the etc/profile file in a program that allows you to edit the file.
2. Type the following:

export CATALINA_HOME = /PathName

where PathName is the directory where you have installed Tomcat.

For example,

export CATALINA_HOME = /Tomcat

Setting the Java Heap Size

The Java heap size for the Tomcat can be modified by defining the JAVA_
OPTS parameter in the catalina.sh file. For example, you can define this
parameter as follows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modified to reflect the requirements of your

specific environment. Refer to your third-party application server

Copyright © 2021 All Rights Reserved 486

In st allat io n an d Co n figu r at io n Gu id e

documentation for information on how to determine a satisfactory Java heap

size for your environment.

Deploying MicroStrategy Web and Mobile Server

After you have performed the configurations described above, you can begin
deploying MicroStrategy JSP applications with Tomcat.

Deploying using Tomcat as a standalone Web container

To deploy MicroStrategy JSP applications using Tomcat as a

standalone Web container

1. Locate the WAR file for your MicroStrategy JSP application.

2. Copy the WAR file to the Tomcat/webapps directory.

To st ar t an d st o p To m cat f r o m t h e co m m an d l i n e

Type # $CATALINA_HOME/bin/startup.sh and click Enter to start

Tomcat, which deploys your MicroStrategy JSP applications automatically,
based on the following:

l If you have configured Tomcat to deploy an exploded WAR file, which is

often the default behavior, a folder is created within the Tomcat/webapps
folder:
l When deploying MicroStrategy Web (JSP), the folder is named
MicroStrategy by default.
l When deploying MicroStrategy Mobile Server (JSP), the folder is named
MicroStrategyMobile by default.
l If you have configured Tomcat to deploy an unexploded WAR file, the
configuration files are created within the system's default temporary file
directory. For Linux systems, the temporary file directory is usually /tmp/
or /var/tmp/:
l When deploying MicroStrategy Web (JSP), a /microstrategy/web-
Version/ folder is created within the temporary file directory, where

Copyright © 2021 All Rights Reserved 487

In st allat io n an d Co n figu r at io n Gu id e

Version is the version number for the MicroStrategy Web (JSP)

product. Within this folder location, various configuration files can be
found within the WEB-INF folder and its subfolders.
l When deploying MicroStrategy Mobile Server (JSP), a
/microstrategy/mobile-Version/ folder is created within the
temporary file directory, where Version is the version number for the
MicroStrategy Mobile Server (JSP) product. Within this folder location,
various configuration files can be found within the WEB-INF folder and
its subfolders.

Configuring administrative access to MicroStrategy JSP

applications
To allow users authorized to access MicroStrategy Web Administrator,
MicroStrategy Mobile Server Administrator, you must create the users and
assign them the role of admin under the Tomcat user configuration file. The
steps to configure this access are below.

1. In the Tomcat/conf directory, open the tomcat-users.xml file

using a program that allows you to edit the file.

2. Add the following tags and save the file:

<role rolename="admin"/>

<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 and
Mobile Server Administrator pages. The roles field must be admin.

3. Stop and restart Tomcat.

Now you can access and configure your MicroStrategy JSP application, as
described in Accessing the MicroStrategy JSP application administrative
page, page 489.

Copyright © 2021 All Rights Reserved 488

In st allat io n an d Co n figu r at io n Gu id e

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for your
MicroStrategy JSP application.

1. Access the servlet by typing the following URL in a Web browser:

l For Web (JSP):
http://
localhost:8080/MicroStrategy/servlet/mstrWebAdmin

l For Mobile Server (JSP):

http://
localhost
:8080/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URL are case-sensitive. Make
sure to use the correct case when typing the servlet name. If the
application server is enabled with security, a dialog box related to the
administrator authentication opens.

2. When prompted for a user name and password, use the same values
you specified in the tomcat-users.xml file.
3. After you are authenticated:
l If you are deploying MicroStrategy Web (JSP), the MicroStrategy
Web Administrator page appears. Add and connect to an Intelligence
Server.
l If you are deploying MicroStrategy Mobile Server (JSP), the
MicroStrategy Mobile Server Administrator page appears. Add and
connect to an Intelligence Server. Once connected, click Mobile
Configuration to configure your MicroStrategy Mobile applications to
communicate with Mobile Server and Intelligence Server. For steps
on how to define this configuration, see the MicroStrategy Mobile
Administration Help. Creating a configuration completes the steps
required to deploy Mobile Server (JSP).

Copyright © 2021 All Rights Reserved 489

In st allat io n an d Co n figu r at io n Gu id e

4. If you are deploying MicroStrategy Web (JSP), proceed to launch the

MicroStrategy project. In a Web browser, access MicroStrategy Web
(JSP) using the following URL:

http://localhost:8080/MicroStrategy/servlet/mstrWeb

Deploying with JBoss (Windows)

This chapter provides information used to deploy and configure
MicroStrategy JSP applications in a JBoss environment. You can use the
steps below to deploy MicroStrategy Web (JSP) and MicroStrategy Mobile
Server (JSP):

l Preconfiguration Information, page 490: configuration that must occur

before you begin deploying MicroStrategy Web (JSP), Mobile Server (JSP)
(JSP).
l Deploying MicroStrategy Web and Mobile Server, page 491: instructions
for deploying, including step-by step procedures.

Preconfiguration Information
This section provides the preconfiguration information necessary to deploy
MicroStrategy JSP applications on JBoss on your machine.

Installing the JDK

If you have not installed Oracle JDK yet, download it here. Be sure to install
the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where you
install the JDK. If you install the JDK to a simple folder path such as C:\
then setting the system variable is easier and more likely to be correct.

Copyright © 2021 All Rights Reserved 490

In st allat io n an d Co n figu r at io n Gu id e

Configuring the JDK

1. On your Windows machine, go to Start > Computer > System
properties > Advanced system settings > Environment Variables.

The third-party products discussed below are manufactured by

vendors independent of MicroStrategy, and the steps to configure
these products is subject to change. Refer to the appropriate Microsoft
documentation for steps to access and modify the environment
variables.

2. Under System Variables, click New to create a system variable. The

New System Variable dialog box opens.
3. In the Variable Name box, type JAVA_HOME.
4. In the Variable Value box, specify the destination folder where you
installed the JDK and click OK.

For example, if the fully qualified path to your JDK executable is

C:\jsdk1.11.0\bin\java.exe, the value of your JAVA_HOME
variable is C:\jsdk1.11.0.

If you have installed JDK under the Program Files folder, type Progra~1
in the destination folder; otherwise the system does not recognize the
folder. For example, C:\Progra~1\jsdk1.11.0.

Installing JBoss
You can download and install JBoss here.

Keep track of the location in which you install JBoss, as this location is used
later (referred to as JBOSS_HOME) to configure JBoss with a MicroStrategy
JSP application deployment.

Deploying MicroStrategy Web and Mobile Server

Assuming you have made all the necessary configurations described in
Preconfiguration Information, you can begin deploying MicroStrategy Web

Copyright © 2021 All Rights Reserved 491

In st allat io n an d Co n figu r at io n Gu id e

(JSP) and Mobile Server (JSP) with JBoss.

l Deploying using JBoss as a stand-alone Web container

l Configuring administrative access to MicroStrategy JSP applications
l Accessing the MicroStrategy JSP application administrative page
l Troubleshooting

Deploying using JBoss as a stand-alone Web container

To deploy MicroStrategy JSP applications using JBoss as a stand-alone

Web container

1. Locate the WAR file for your MicroStrategy JSP application.

2. Copy the WAR file to the JBOSS_HOME\server\default\deploy
directory.
3. To start JBoss, browse to JBOSS_HOME\bin. Then run the following
command:
run.bat -b 0.0.0.0

Your MicroStrategy JSP application is deployed automatically, based on the

following:

l If you have configured JBoss to deploy an exploded WAR file, which is

often the default behavior, a folder is created within the JBOSS_
HOME\server\default\deploy directory:
l When deploying MicroStrategy Web (JSP), the folder is named
MicroStrategy by default.
l When deploying MicroStrategy Mobile Server (JSP), the folder is named
MicroStrategyMobile by default.
l If you have configured JBoss to deploy an unexploded WAR file, the
configuration files are created within the system's default temporary file
directory. For Windows systems, the temporary file directory is commonly
defined by the TMP environment variable:

Copyright © 2021 All Rights Reserved 492

In st allat io n an d Co n figu r at io n Gu id e

l When deploying MicroStrategy Web (JSP), a /microstrategy/web-

Version/ folder is created within the temporary file directory, where
Version is the version number for the MicroStrategy Web (JSP)
product. Within this folder location, various configuration files can be
found within the WEB-INF folder and its subfolders.
l When deploying MicroStrategy Mobile Server (JSP), a
/microstrategy/mobile-Version/ folder is created within the
temporary file directory, where Version is the version number for the
MicroStrategy Mobile Server (JSP) product. Within this folder location,
various configuration files can be found within the WEB-INF folder and
its subfolders.

Configuring administrative access to MicroStrategy JSP

applications
To allow users authorized to access MicroStrategy Web Administrator,
MicroStrategy Mobile Server Administrator, you must create the users and
assign them the role of admin under the JBoss user configuration files. The
steps 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 installed JBoss.
2. Create the following two files within this directory:
l users.properties
l roles.properties
3. Open the users.properties file in a text editor.
4. Include one line for each user to grant administrative access to the Web
Administrator and Mobile Server Administrator, using the following
syntax:
user_id=user_password

Copyright © 2021 All Rights Reserved 493

In st allat io n an d Co n figu r at io n Gu id e

For example, you create UserA and UserB with passwords 1234 and
5678 respectively using the following syntax:

UserA=1234

UserB=5678

5. Save your changes and close the users.properties file.

6. Open the roles.properties file in a text editor.
7. Include one line for each user you included in the users.properties
file and grant them administrative access, using the following syntax:
user_id=admin

For example, you define UserA and UserB to have administrative

access using the following syntax:

l UserA=admin
l UserB=admin
8. Save your changes and close the roles.properties file.
9. To start JBoss, browse to JBOSS_HOME\bin. Then run the following
command:
run.bat -b 0.0.0.0

Now you can access and configure your MicroStrategy JSP application, as
described in Accessing the MicroStrategy JSP application administrative
page, page 494.

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for your
MicroStrategy JSP application.

To access the MicroStrategy JSP application administrative page

1. In a Web browser, access the administrative page by specifying the

following URL:

Copyright © 2021 All Rights Reserved 494

In st allat io n an d Co n figu r at io n Gu id e

l For Web (JSP):

http://
localhost:8080/MicroStrategy/servlet/mstrWebAdmin
l For Mobile Server (JSP):
http://
localhost
:8080/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URLs listed above are case-
sensitive. Make sure to use the correct case when typing the servlet
name. If the application server is enabled with security, a dialog box
related to the administrator authentication opens.

2. When prompted for a user name and password, type the user name for
the administrator user you created in the roles.properties file and
the login information in the users.properties file.
3. After you are authenticated:
l If you are deploying MicroStrategy Web (JSP), the MicroStrategy
Web Administrator page appears. Add and connect to an Intelligence
Server.
l If you are deploying MicroStrategy Mobile Server (JSP), the
MicroStrategy Mobile Server Administrator page appears. Add and
connect to an Intelligence Server. Once connected, click Mobile
Configuration to configure your MicroStrategy Mobile applications to
communicate with Mobile Server and Intelligence Server. For steps
on how to define this configuration, see the MicroStrategy Mobile
Administration Help. Creating a configuration completes the steps
required to deploy Mobile Server (JSP).
4. If you are deploying MicroStrategy Web (JSP), proceed to launch the
MicroStrategy Web project page. In a Web browser, access
MicroStrategy Web project using this URL:

http://localhost:8080/MicroStrategy/servlet/mstrWeb

Copyright © 2021 All Rights Reserved 495

In st allat io n an d Co n figu r at io n Gu id e

Troubleshooting
Under certain circumstances, an error in a request involving JSON may
appear:

"Invalid JSON body, Illegal Type

(com.microstrategy.rest.model.filter.viewfilter.BranchExpression) to
deserialize: prevented for security reasons;"

In the Web server logs, a similar warning message may also appear:

WARN [org.jboss.as.jaxrs] (MSC service thread 1-2) WFLYRS0018: Explicit

usage of Jackson annotation in a JAX-RS deployment; the system will disable
JSON-B processing for the current deployment. Consider setting the
'resteasy.preferJacksonOverJsonB' property to 'false' to restore JSON-B.

When this occurs JBoss must be configured to disable Jackson. This can by
done by:

l Starting JBoss server with the following option:

./bin/standalone.sh -Dresteasy.preferJacksonOverJsonB=FALSE

l Or creating an exclusion in tag in the structure xml for the

org.jboss.resteasy.resteasy-json-binding-provider module.

See the JBoss documentation for RESTEasy JAX-RS for more information
about this situation.

Administering Your MicroStrategy Web Deployment

You can configure and manage MicroStrategy Web connections to
Intelligence Servers in the MicroStrategy Web Administrator page.

Enabling Users to Install MicroStrategy Office from Web

This information applies to the legacy MicroStrategy Office add-in, the
add-in for Microsoft Office applications which is no longer actively

Copyright © 2021 All Rights Reserved 496

In st allat io n an d Co n figu r at io n Gu id e

developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

From the MicroStrategy Web Administrator page, you can designate the
installation directory path to MicroStrategy Office, and also determine
whether a link to Office installation information appears in the MicroStrategy
Web interface.

You must install and deploy MicroStrategy Web Services to allow the
installation of MicroStrategy Office from MicroStrategy Web. For information
about deploying MicroStrategy Web Services, see the MicroStrategy for Office
Help.

To specify the path to MicroStrategy Office and determine

whether users can install MicroStrategy Office from Web
1. In Windows, go to Start > Programs > MicroStrategy Tools > ;Web
Administrator.
2. Click Connect.
3. Underneath Web Server on the left, click MicroStrategy Office. The
MicroStrategy Office settings page opens.
4. In the Path to MicroStrategy Office Installation field, type the base
URL 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. For

Copyright © 2021 All Rights Reserved 497

In st allat io n an d Co n figu r at io n Gu id e

example, if the language in MicroStrategy Web is set to English, a

completed URL may appear as follows:

http://localhost/MicroStrategyWS/office/Lang_
1033/officeinstall.htm

5. Test the URL path by clicking Go.

6. Click your browser's Back button to return to the Web Administration -
MicroStrategy Office settings page.
7. To ensure that an Install MicroStrategy Office link is
displayed at the top of users' project selection and login pages in
MicroStrategy Web, select the Show link to installation page for all
users on the Projects and Login pages check box. When users click
the 'Install MicroStrategy Office' link, a page opens with instructions on
how to install MicroStrategy Office on their machine.
8. Click Save.

Using Absolute Paths to Share Configuration Files

By default, absolute paths are not used for the configuration files of your
MicroStrategy Web Mobile deployments. You can modify the
microstrategy.xml file to reference configuration files using absolute
paths. By using absolute paths, you can allow the same configuration files to
be accessed by multiple systems. For example, absolute paths can be used
in a clustered environment in which you want all instances of the web server
to access the same MicroStrategy Web or Mobile configuration files.

Below is an example of some relative paths that are included in the

microstrategy.xml file by default:

<parameter name="serverConfigFilesDefaultLocation" value="/WEB-INF/xml/" />

<parameter name="serverLogFilesDefaultLocation" value="/WEB-INF/log/" />

You can modify these to use absolute paths, as shown in the examples
below:

Copyright © 2021 All Rights Reserved 498

In st allat io n an d Co n figu r at io n Gu id e

<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 Importing

Data
You can use MicroStrategy Web to import data from different data sources,
such as an Excel file, a table in a database, the results of a Freeform SQL
query, or other data sources, into MicroStrategy metadata, with minimum
project design requirements.

To import data from the following data sources, configure a secure

connection between your third-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 Data

Source 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
integrate in MicroStrategy Web. You also need the proper credentials to
perform some of the steps below. For example, you need a Salesforce.com
login with developer credentials to perform some of the steps below.
l You have deployed MicroStrategy Web so that it uses secure, encrypted
communications. For steps to enable secure communications for your
MicroStrategy Web deployment, refer to the System Administration Help.

Copyright © 2021 All Rights Reserved 499

In st allat io n an d Co n figu r at io n Gu id e

l If you are connecting to Salesforce.com, to ensure proper numeric value

integration and formatting when using Data Import, your Salesforce.com
reports must use the English locale. If you use a different locale for your
Salesforce.com reports, you can still integrate this data into MicroStrategy
using Data Import if you connect to Salesforce.com using the MicroStrategy
ODBC Driver for Salesforce. For steps to configure this type of a connection
to Salesforce.com, see MicroStrategy ODBC Driver for Salesforce, page 715.

1. Access the administrative options for your third-party data source.

For example, if you are integrating data from Salesforce.com, log in to

Salesforce.com by accessing https://login.salesforce.com/.

2. Configure MicroStrategy Web as a remote access application for the

third-party data source. For the steps to define remote access
applications in your third-party data source, refer to your third-party
documentation.

When configuring MicroStrategy Web as a remote access application,

you must define the callback URL as the URL to access MicroStrategy
Web, including the event 3172. Depending on how you deployed
MicroStrategy Web, the syntax for this URL can take one of the
following forms:

The Twitter connector does not allow you to add query parameters in
the Twitter app setting. Beginning MicroStrategy 2019 Update 1, you
do not need 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, you

cannot connect to Twitter without query parameters. Upgrade to
MicroStrategy 2019 Update 1 or later to use the Twitter connector.

l For MicroStrategy Web (ASP.NET) deployments:

https://WebServer/WebApplicationName/asp/Main.aspx?e
vt=3172&src=Main.aspx.3172

Copyright © 2021 All Rights Reserved 500

In st allat io n an d Co n figu r at io n Gu id e

l For MicroStrategy Web (JSP) deployments:

https://WebServer:PortNumber/WebApplicationName/serv
let/mstrWeb?evt=3172&src=mstrWeb.3172

In the example URLs above:

WebServer is the full domain name of your web server that is hosting
MicroStrategy Web. Ensure that you use the full domain name rather
than using an IP address, as using an IP address can require re-
authentication when making the connection.

PortNumber is the port number of your web server.

WebApplicationName is the name of the MicroStrategy Web

application. The default name for the MicroStrategy Web application
is MicroStrategy.

3. Save MicroStrategy Web as a remote access application. Your third-

party data source provides a Client ID and a Client Secret. Save these
two values as they are required later to configure the connection.
4. Restart the web server that hosts MicroStrategy Web. The next time
you log in to Web and use Data Import, the data source is now an
available option.

5. When connecting to your data source using Data Import in

MicroStrategy Web, enter the Client ID and Client Secret provided by
the data source.

Additionally, the callback URL is the MicroStrategy Web URL you used
above to configure MicroStrategy Web as a remote access application
for your data source. The Client ID, Client Secret, and Callback URL
are all defined as OAuth parameters of the connection to your data
source using Data Import.

For the Twitter connector, add the event 3172 to the callback URL in
MicroStrategy Web. For an example of connecting the Twitter

Copyright © 2021 All Rights Reserved 501

In st allat io n an d Co n figu r at io n Gu id e

connector, see KB440974.

Configuring your MicroStrategy Installation

After completing the steps to deploy MicroStrategy Web and Mobile Server,
you can continue your setup and configuration. To help guide the rest of
your installation and configuration steps, refer to the section Installation and
Configuration Checklists, page 139 in Chapter 1, Planning Your Installation,
for installation and configuration checklists.

Copyright © 2021 All Rights Reserved 502

In st allat io n an d Co n figu r at io n Gu id e

SETTIN G U P D OCUM EN TS
AN D HTM L D OCUM EN TS

Copyright © 2021 All Rights Reserved 503

In st allat io n an d Co n figu r at io n Gu id e

This section explains the setup required for Intelligence Server to execute
HTML documents and Report Services documents on Linux platforms.

Prerequisites 504

Executing Documents and HTML Documents in Linux 504

Configuring your MicroStrategy Installation 512

Prerequisites
This section assumes the following:

l You are familiar with MicroStrategy Developer and MicroStrategy

Intelligence Server.
l You are familiar with MicroStrategy HTML documents and Report Services
documents.
l You have a Report Services product license if you are using Report
Services documents. HTML documents do not require a Report Services
product license.
l You have installed MicroStrategy Developer on a Windows machine.
l You have installed MicroStrategy Intelligence Server on a Linux machine.

Some of the steps described in this document may require root access
permissions.

You must perform extra configuration steps to allow Report Services

documents to support non-Western European fonts on a UNIX system. For
more information, see Graph and Document Support of Non-Western
European Fonts, page 834 of Appendix B, Troubleshooting.

Executing Documents and HTML Documents in Linux

A MicroStrategy Report Services document contains objects representing
data coming from one or more reports, as well as positioning and formatting

Copyright © 2021 All Rights Reserved 504

In st allat io n an d Co n figu r at io n Gu id e

information. Report Services documents help format data from multiple

reports in a single display and can be used for presentations. When you
create a document, you can specify the data that appears, control the layout,
formatting, grouping, and subtotaling of data and specify the position of
page breaks. In addition, you can insert pictures and draw borders in the
document.

In this section, the term document signifies a Report Services document.

For additional information on Report Services documents, refer to the
Document Creation Help.

An HTML document is a container for formatting, displaying, and distributing

multiple reports on the same page, or at the same time within a project. You
can create dossiers and scorecards to display a group of reports within the
MicroStrategy platform.

HTML documents are created using MicroStrategy Developer. Before

creating or executing HTML documents, you must specify the HTML
document directory using the Project Configuration dialog box in
MicroStrategy Developer. The HTML document directory stores HTML
templates that are required by the MicroStrategy Intelligence Server for
executing HTML documents. You can store the HTML document directory on
a Linux platform, but you must share the directory with the Windows platform
that includes MicroStrategy Developer. For more information on setting up
the HTML document directory on a Linux platform, see Setup for Creating
and Executing HTML Documents, page 505.

For additional information on HTML documents, see the HTML Documents

chapter in the Advanced Reporting Help.

Setup for Creating and Executing HTML Documents

HTML documents can only be created with MicroStrategy Developer on a
Windows platform, but they can be stored and executed from a directory
within a Linux platform. The directory that stores the HTML documents must

Copyright © 2021 All Rights Reserved 505

In st allat io n an d Co n figu r at io n Gu id e

be accessible on the computer with Intelligence Server and the Windows

computer with Developer.

Using the Project Configuration dialog box in MicroStrategy Developer, you

must specify the location of the HTML document directory as an absolute
path. This document directory can be on a local machine or on a remote
machine. Users require appropriate read and write permissions to access
this directory. When MicroStrategy Intelligence Server executes HTML
documents, it requires read permission to the HTML document directory to
access the HTML files.

For the procedure of setting up an HTML document directory between

Windows and Linux computers below, the following assumptions are made:

l You have installed MicroStrategy Developer on a Windows computer and

installed MicroStrategy Intelligence Server on a Linux computer.

Developer can only be installed on a Windows computer.

l MicroStrategy Developer users have at least read permissions to the

HTML document directory for executing existing HTML documents. Write
permissions to the directory are required for MicroStrategy Developer
users to create new HTML documents.
l For the file paths described in the procedure below, machine-name is
used to represent the name of the machine you store the HTML document
directory on. For example, if you store the directory on a machine named
UNIX1, machine-name should be replaced with UNIX1. This machine
must have Samba installed to provide access to the folder on a Windows
computer.
l You must have root permissions on any Linux computer used to set up the
HTML document directory. This includes the computer that stores the
HTML document directory as well as any computer that must be setup to
access the directory.

Copyright © 2021 All Rights Reserved 506

In st allat io n an d Co n figu r at io n Gu id e

To set up the HTML document directory

1. Create a directory to hold the HTML document directory on the desired

Linux computer. This procedure assumes that the path of the HTML
document directory is machine-name:/share/htmldocuments. This
is the machine that is referenced as machine-name in the steps below.
To create this directory, enter the commands below:
# cd /

# mkdir share

# cd share

# mkdir htmldocuments

2. Install Samba software on the Linux computer that you created the
HTML documents directory in the step above. With this software, the
HTML documents directory is accessible to the Windows computer with
MicroStrategy Developer installed. You can get the latest version of
Samba 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 incorrect
website.

3. Share the directory machine-name:/share across the network

through NFS. For example, you must share UNIX1:/share. Make sure
read and write permissions are set for the share. This step allows other
Linux computers to access the directory.
4. Create a Samba share, named "share", with read and write permissions
that points to the directory machine-name:/share. For example, you
must share UNIX1:/share.This step allows Windows computers to
access the directory.

Copyright © 2021 All Rights Reserved 507

In st allat io n an d Co n figu r at io n Gu id e

The Samba share is created in the Samba smb.conf file. For specific
instructions on how to setup a Samba share, refer to the Samba
website athttp://www.samba.org.

5. Restart Samba.
6. Mount the HTML document directory on the computer that has the
Intelligence Server installed on it. Root privileges are required for this.

On the computer with Intelligence Server, type the command su and the
root password at the command prompt to log in as a superuser, or log in
as root. The command prompt changes to the pound sign (#). Perform
the commands below:

In the commands below, machine-name refers to the machine name

of the computer where you stored the HTML documents directory and
created an NFS and Samba share. This may be a different name than
the computer that you are mounting the directory on. The final mount
command 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 directory
from the Windows computer so that you are not prompted for

Copyright © 2021 All Rights Reserved 508

In st allat io n an d Co n figu r at io n Gu id e

authentication each time the directory is accessed:

a. From the Windows computer that has MicroStrategy Developer
installed, click Start, and select Run. The Run dialog box opens.
b. Type \\machine-name\share\htmldocuments,and click OK to
open the top-level shared HTML documents directory. For
example, type \\UNIX1\share\htmldocuments.

This must be performed every time you restart the computer.

8. Using the Project Configuration dialog box in MicroStrategy Developer,

set the HTML document directory as an absolute path by following the
steps below:
a. In Developer, right-click the project associated with the HTML
documents and select Project Configuration. The Project
Configuration dialog box opens.
b. Expand Project definition and click Advanced. The Project
Configuration - 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. Click OK to accept the changes.
9. Create a directory named xsls under the HTML document directory and
copy the XSL files you require for creating HTML documents to the xsls
directory, /machine-name/share/htmldocuments/xsls. If you
stored XSL files in a different directory or did not copy them from their
original default directory, you must copy them into the new xsls
directory. For example, the default HTML document directory for the
Tutorial project is Program Files\MicroStrategy\Tutorial
Reporting.
10. If you want to insert images into the HTML document, create a directory
named images under the HTML document directory, and copy the

Copyright © 2021 All Rights Reserved 509

In st allat io n an d Co n figu r at io n Gu id e

images to the directory /machine-

name/share/htmldocuments/images.

You are now ready to create and execute your HTML documents. Remember
to create your HTML documents in the HTML document directory, otherwise,
Intelligence Server cannot execute the HTML documents correctly.

Setup for Executing Existing HTML Documents

If you have created HTML documents prior to establishing a connection
between the HTML document directory on the Linux machine with
MicroStrategy Intelligence Server and the Windows machine with
MicroStrategy Developer, you must make sure that all the files used for an
HTML document are copied to the shared HTML document directory. After
the connection is established, you should always create the HTML
documents in the shared HTML document directory. Once the existing files
are copied, you can execute the HTML documents using Intelligence Server.

In the procedure of setting up existing HTML documents, the following

assumptions are made:

l You have completed all the steps listed in the section Setup for Creating
and Executing HTML Documents, page 505.
l The location of the HTML document directory is /machine-
name/share/htmldocuments. For the file paths described in the
procedure below, machine-name is used to represent the name of the
machine on which you store the HTML document directory. For example, if
you store the directory on a machine named UNIX1, machine-name
should be replaced with UNIX1.

To set up existing HTML documents for execution

1. Copy the HTML file for any existing HTML document to /machine-
name/share/htmldocuments.
2. View the source code of each HTML file and copy the XSL file used by
each HTML document in an appropriate directory under /machine-

Copyright © 2021 All Rights Reserved 510

In st allat io n an d Co n figu r at io n Gu id e

name/share/htmldocuments.

For example, if the location of the XSL file in the source code is
xsl="\xsls\myxsl.xsl, then copy myxsl.xsl to /machine-
name/share/htmldocuments/xsls. If the location of the XSL file in
the source code is xsl="\myxsl.xsl, then copy myxsl.xsl to
/machine-name/share/htmldocuments.

3. View the source code for the images used by each HTML document in
an appropriate directory under /machine-
name/share/htmldocuments.

For example, if the location of the image file in the source code is
\images\myimage.gif, then copy myimage.gif to /machine-
name/share/htmldocuments/images. If the location of the XSL file
in the source code is \myimage.gif, then copy myimage.gif to
/machine-name/share/htmldocuments.

You are now ready to execute your HTML documents.

Setup for Executing Report Services Documents

A MicroStrategy Report Services document is used to format data from
multiple reports. These documents can be exported to PDF format. To
execute documents and export them to PDF format using MicroStrategy
Intelligence Server in a Linux environment, you must perform some
additional setup tasks.

When Intelligence Server is running on a Linux platform, all fonts are

converted 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

Copyright © 2021 All Rights Reserved 511

In st allat io n an d Co n figu r at io n Gu id e

This occurs because the fonts required by the PDF component are missing
from Linux machines running Intelligence Server. The missing fonts may
include Microsoft True Type fonts.

MicroStrategy does not distribute or license Microsoft fonts, and therefore

cannot package Microsoft fonts with Intelligence Server.

To resolve this issue, you must install the font files in the
PDFGeneratorFiles folder within the MicroStrategy installation path on
the Linux machine, as described below.

To copy fonts to your Linux machine

1. Log in to your Linux machine that hosts Intelligence Server.

2. Install the Microsoft True Type fonts. Refer to the following resources
for information on licensing requirements for and installing Microsoft
True Type fonts:
l http://www.microsoft.com/typography/RedistributionFAQ.mspx
l http://www.ascendercorp.com/msfonts/msfonts_main.html
l http://corefonts.sourceforge.net/
3. Copy the font files into the INSTALL_PATH/PDFGeneratorFiles
directory, where INSTALL_PATH is the directory you specified as the
MicroStrategy install directory during installation.
4. To update the list of fonts available, you must restart the Intelligence
Server.

Configuring your MicroStrategy Installation

After completing the steps to set up documents and HTML documents for
Linux, you can continue your setup and configuration. To help guide the rest
of your installation and configuration steps, refer to the section Installation
and Configuration Checklists, page 139 in Chapter 1, Planning Your
Installation, for installation and configuration checklists.

Copyright © 2021 All Rights Reserved 512

In st allat io n an d Co n figu r at io n Gu id e

A UTOM ATED
I N STALLATION ON
W IN D OWS

Copyright © 2021 All Rights Reserved 513

In st allat io n an d Co n figu r at io n Gu id e

This section explains the various possibilities for performing fully automated
and unattended installations within the MicroStrategy platform. This includes
customizations to the installation routines available with the product. It
explains the different resources you can use to deploy MicroStrategy
products through various scenarios including:

l Deploying the MicroStrategy platform across the network through the

Microsoft System Management Server (SMS) or its equivalent (for
example, IBM Tivoli)
l Embedding the MicroStrategy platform within third party custom
applications and other installation routines
l Customizing the MicroStrategy installation to meet the various
environment-specific requirements for a given site

This section provides the following information:

Installation Log File 514

Methods of Installation 516

Configuring your MicroStrategy Installation 574

Automated and silent installations require advanced techniques such as

creating and running response.ini files. Therefore, automated and silent
installations should be handled by system administrators with full
knowledge of the environment and the desired MicroStrategy installation.

Before installing MicroStrategy products, you should refer to Chapter 1,

Planning Your Installation for important pre-installation information.

Installation Log File

Before you begin to learn about automated installation options, it is
important to know about the installation log file. The setup program
generates a log file in text format. This log file contains records of all actions
performed by the setup program and by other executable files related to

Copyright © 2021 All Rights Reserved 514

In st allat io n an d Co n figu r at io n Gu id e

installation. The installation log file can be particularly helpful if you

encounter errors during the installation process. For example, the log can
tell you if a registry key or path was not added or if a critical file was not
registered successfully. The setup.exe file writes to this log file.

The log file data includes:

l Update dates
l Machine specifications
l User selections
l List of files to be registered
l List of files that do not require registration
l List of registry entries
l Identification of files that fail during registration
l Installation activity such as performance counter loading and DSN
creation
l Reboot time file registration results

The default location for the install.log file is:

l 32-bit Windows environments: Program Files\Common

Files\MicroStrategy
l 64-bit Windows environments: Program Files (x86)\Common
Files\MicroStrategy

Both the location and the name can be changed. You can specify the log file
name and location in the following places:

l Command line, reading the parameter LogFile. For example:

setup.exe --LogFile="C:\install.log"

l Response file in [LogFile]. See Configuring a response.ini File to

Install MicroStrategy, page 516 for more information.

Copyright © 2021 All Rights Reserved 515

In st allat io n an d Co n figu r at io n Gu id e

Methods of Installation
The installation methods discussed in this section are:

Installing and Configuring with a response.ini File

The response.ini file can facilitate the installation and setup of
MicroStrategy products by allowing you to progress through the installation
and project creation processes with a single keystroke. A response.ini
file is an initialization file that is used to send parameters or selections to
the MicroStrategy Installation Wizard. This allows you to run it silently as all
the options are pre-selected in that file. This section describes how to create
and use response.ini for the following tasks:

Configuring a response.ini File to Install MicroStrategy

The response.ini file for installation allows you to automate certain
aspects of the installation by modifying a Windows ini-like response file.

This option is typically implemented by the following:

l OEM applications that embed MicroStrategy installations within other

products
l IT departments who want to have more control over desktop installations

The response.ini file specifies all the selections you want to make during
the installation in the MicroStrategy Installation Wizard. You can either run it
with all the MicroStrategy Installation Wizard options that are pre-selected
or run it without having to use the wizard at all.

The response.ini file should not be confused with the setup.iss file,
which is used by the MicroStrategy Installation Wizard to perform silent
installation. When both response.ini and setup.iss are included in the
setup, response.ini overrides setup.iss. For details on the
setup.iss file, see Silent Installation, page 563.

Copyright © 2021 All Rights Reserved 516

In st allat io n an d Co n figu r at io n Gu id e

Com ponent Dependencies

When you use a response.ini file to install MicroStrategy products, there

are some key dependencies among separate components you should be
aware of.

The products listed below require either pre-installed software or certain

MicroStrategy components to be selected to successfully install the products
with a response.ini file:

l MicroStrategy Enterprise Manager requires MicroStrategy Command

Manager to be included in the installation.
l MicroStrategy Delivery Engine, MicroStrategy Subscription Portal,
MicroStrategy Tutorial – Delivery Installation and MicroStrategy Tutorial –
Delivery Configuration require MicroStrategy Narrowcast Administrator
and SequeLink ODBC Socket Server to be included in the installation.
l MicroStrategy Narrowcast Server Administrator requires SequeLink ODBC
Socket Server to be included in the installation.
l MicroStrategy Narrowcast Server Subscription Portal requires SequeLink
ODBC Socket Server to be included in the installation.
l MicroStrategy Function Plug-in Wizard requires Microsoft Visual C++ to be
installed before running your response.ini file.
l MicroStrategy Analytic Modules requires MicroStrategy Developer or a
combination of MicroStrategy Analyst and MicroStrategy Architect to be
included in the installation.
l Platform Analytics requires MicroStrategy Intelligence Server,
MicroStrategy Telemetry, and Command Manager to be included in the
installation.

Creating a response.ini File

Create the file in any text editor and save it as response.ini in the
desired folder.

You must save the file with ANSI encoding.

Copyright © 2021 All Rights Reserved 517

In st allat io n an d Co n figu r at io n Gu id e

The following tables describe the parameters and options for the all the
sections, such as Installer, Paths, and so on in the response.ini file. It is
followed by sample response.ini files for your reference.

The options are case-sensitive, therefore they must be entered as indicated

in the tables below.

In st al l er

Options Description

[Installer] Section that begins the installation.

TRUE or False. Indicates whether the installation uses

ExpressMode
Express Install or Custom Install.

TRUE or FALSE. Set to TRUE to create new properties files.

PropertiesFilesOverw These files are related to the Tutorial Delivery component.
rite The default is FALSE, which uses the current version of the
properties files. The default is FALSE.

TRUE or FALSE. Set this option to trace the setup process in

a log file that is saved in the Temp folder. The log file
EnableTracing
records errors that are encountered during the installation.
The default is FALSE.

TRUE or FALSE. Indicates whether the installation uses all

HideAllDialogs default values. FALSE displays all the dialog boxes and you
must browse using the Next buttons. The default is FALSE.

TRUE or FALSE. TRUE reboots the machine after the

ForceReboot
installation is done. The default is FALSE.

TRUE or FALSE. TRUE prevents the machine from rebooting

after installation is done. Note the following conditions:

• If both ForceReboot = TRUE and PreventReboot =

PreventReboot
TRUE, then PreventReboot applies first.

• If both ForceReboot and PreventReboot are FALSE

and HideDialog for [Finish] is set to TRUE, then the

Copyright © 2021 All Rights Reserved 518

In st allat io n an d Co n figu r at io n Gu id e

Options Description

machine reboots only if it is required.

The default is FALSE.

TRUE or FALSE. Set to TRUE to check that the TCP/IP

CheckTCPI network protocol is active. If set to FALSE, the setup doesn't
check for it. The default is TRUE.

TRUE or FALSE. Set to TRUE to check for Internet

CheckII
Information Services. The default is TRUE.

TRUE or FALSE. TRUE creates the shortcuts for

CreateShortcuts MicroStrategy products, tools, and documentation. The
default is TRUE.

TRUE or FALSE. In some instances, as a result of a previous

installation or an uninstall, certain files may be missing or
irreplaceable during installation. Therefore, you are
prompted to do one of the following:

• Reboot at the beginning of installation to replace this file.

CheckRenameOperations
It is recommended that you select this option.

• Continue with the installation at the risk of the software

not functioning properly.

If you enter FALSE, the prompt does not display. The default
is TRUE.

TRUE or FALSE. This option overwrites the Analytics

AnalyticsOverwrite
Modules from a previous install. The default is FALSE.

TRUE or FALSE. Set this option to overwrite the Delivery

TutDeliveryOverwrite
Tutorial from a previous installation. The default is FALSE.

TRUE or FALSE. If you set the value to TRUE, it creates a

backup of the following files:

BackupFiles • *.pds

• *.xsl

• *.asp

Copyright © 2021 All Rights Reserved 519

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• *.css

• *.js

• *.sql

The default is FALSE.

TRUE or FALSE. When using silent install, set to FALSE to

RunConfigWizard prevent the Configuration Wizard from coming up after
reboot.The default is TRUE.

TRUE or FALSE. Set to TRUE to stop all services required to

be stopped to complete a MicroStrategy installation. If set to
StopAllServices
FALSE, the user is prompted if services need to be stopped.
The default is TRUE.

TRUE or FALSE. Set this option to stop Internet Information

StopIIS
Services (IIS) during installation. The default is FALSE.

TRUE or FALSE. Set this option to enable the ASP

EnableASPServices MicroStrategy Web Services extensions that IIS Admin
requires. The default is FALSE.

TRUE or FALSE. Set this option to enable the ASP.NET

EnableASPNETServices MicroStrategy Web Services extensions that IIS Admin
requires. The default is FALSE.

TRUE or FALSE. Set to TRUE to display the Welcome screen

ShowWelcomeScreen after reboot. The Welcome screen is displayed only once
after reboot. The default is TRUE.

TRUE or FALSE. If you select FALSE, the warehouse and

metadata files are not updated but the rest of the files for
EnterpriseManagerOve
Enterprise Manager are updated. This prompt only impacts
rwrite
the files in the Microsoft Access database. The default is
FALSE.

Specify the name of the response file for the Configuration

ConfigWizardResponseF
Wizard; otherwise, it takes the default name of
ile
response.ini.

Copyright © 2021 All Rights Reserved 520

In st allat io n an d Co n figu r at io n Gu id e

Options Description

For more details on configuring the response.ini file for

the Configuration Wizard, see Configuring your Installation
with a response.ini File, page 561.

Location where the install.log file is generated. If left

empty, it takes the default location and file name of:

• 32-bit Windows environments:

C:\Program Files\Common Files\MicroStrategy
LogFile
\install.log.

• 64-bit Windows environments: C:\Program Files 

(x86)\Common Files\MicroStrategy\install.lo
g.

Wel co m e Di al o g

Options Description

[Welcome] Section for configuring the Welcome dialog box.

HideDialog TRUE or FALSE. FALSE displays the dialog box. The default is FALSE.

TRUE or FALSE. This option is for the uninstall process only. Setting it
to TRUE removes all MicroStrategy products during the uninstall
RemoveAll process. The default is FALSE.

For an example of a response file used to uninstall all MicroStrategy

products, see Uninstalling with a response.ini File, page 561.

Cu st o m er In f o r m at i o n Di al o g

Options Description

[UserRegistration] Section for specifying the customer information.

TRUE or FALSE. FALSE displays the dialog box. The default is

HideDialog
FALSE.

Copyright © 2021 All Rights Reserved 521

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Indicates the user name of the currently logged user or a user

UserFirstName who is already registered. If no information is provided, you
cannot proceed to the next page.

Indicates the user name of the currently logged user or a user

UserLastName who is already registered. If no information is provided, you
cannot proceed to the next page.

Indicates the email of the currently logged user, or a user who

UserEmail is already registered. If no information is provided, you cannot
proceed.

The name of the company for which the software is registered.

CompanyName
The default is the company name in the registry.

Specify the license key for the software. If you do not specify
the license key, the MicroStrategy Installation Wizard will ask
LicenseKey
for it when it reaches that step. By default, it is blank for a
fresh install or displays the license key from a previous install.

Li cen se Det ai l

Options Description

[LicenseDetail] Section that displays license details.

TRUE or False. FALSE displays the dialog box. The default is

HideDialog
FALSE.

Set u p Exp r ess In st al l

Options Description

[SetupExpress] Section that begins the installation.

TRUE or False. Indicates whether the installation uses Express

HideDialog
Install or Custom Install.

Copyright © 2021 All Rights Reserved 522

In st allat io n an d Co n figu r at io n Gu id e

Ch o o se Dest i n at i o n Lo cat i o n Di al o g

Options Description

Section specifying the name of the target directory from where

[SuiteTarget]
you can run the MicroStrategy products.

TRUE or FALSE. FALSE displays the dialog box. The default is

HideDialog
FALSE.

Location of the root directory for the Program Files. The default is
set to:

• 32-bit Windows environment:

TargetDirectory
C:\Program Files\MicroStrategy

• 64-bit Windows environment: C:\Program Files 

(x86)\MicroStrategy

Pat h s

Options Description

Section for specifying the path for the products that you select to
[InitialPaths]
install.

Location where the common files like response.ini,

install.log, and so on will be installed. If left empty, it takes the
default location of:

COMMONFILES • 32-bit Windows environments:

C:\Program Files\Common Files\MicroStrategy

• 64-bit Windows environments: C:\Program Files 

(x86)\Common Files\MicroStrategy

Location where Developer will be installed. If left empty, it takes

the default location of:

Developer • 32-bit Windows environments:

C:\Program Files\MicroStrategy\Desktop

• 64-bit Windows environments: C:\Program Files 

Copyright © 2021 All Rights Reserved 523

In st allat io n an d Co n figu r at io n Gu id e

Options Description

(x86)\MicroStrategy\Desktop

Location where Object Manager will be installed. If left empty, it

takes the default location of:

• 32-bit Windows environments:

ObjectManager
C:\Program Files\MicroStrategy\Object Manager

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Object Manager

Location where Command Manager will be installed. If left empty,

it takes the default location of:

• 32-bit Windows environments:

CommandManager
C:\Program Files\MicroStrategy\Command Manager

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Command Manager

Location where Enterprise Manager will be installed. If left empty,

it takes the default location of:

• 32-bit Windows environments:

EnterpriseManage
C:\Program Files\MicroStrategy\Enterprise Manage
r
r

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Enterprise Manager

Location where the MicroStrategy Intelligence Server will be

installed. If left empty, it takes the default location of:
Server
• 64-bit Windows environments: C:\Program Files 
(x86)\MicroStrategy\Intelligence Server

Location where MicroStrategy Web will be installed. If left empty, it

takes the default location of:

Web • 32-bit Windows environments:

C:\Program Files\MicroStrategy\Web ASPx

• 64-bit Windows environments: C:\Program Files 

Copyright © 2021 All Rights Reserved 524

In st allat io n an d Co n figu r at io n Gu id e

Options Description

(x86)\MicroStrategy\Web ASPx

Location where MicroStrategy Web will be installed. If left empty, it

takes the default location of:

• 32-bit Windows environments:

WebUniversal
C:\Program Files\MicroStrategy\Web JSP

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Web JSP

Location where MicroStrategy Web Services will be installed. If left

empty, it takes the default location of:

• 32-bit Windows environments:

WebServices
C:\Program Files\MicroStrategy\Web Services

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Web Services

Location where MicroStrategy Web Services will be installed. If left

empty, it takes the default location of:

WebServicesUnive • 32-bit Windows environments:

rsal C:\Program Files\MicroStrategy\Web Services JSP

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Web Services JSP

Location where MicroStrategy Office will be installed. If left empty,

it takes the default location of:

• 32-bit Windows environments:

Office
C:\Program Files\MicroStrategy\Office

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Office

Location where MicroStrategy Tutorial - Reporting will be installed.

TutorialReportin If left empty, it takes the default location of:
g • 32-bit Windows environments:
C:\Program Files\MicroStrategy\Tutorial Reportin

Copyright © 2021 All Rights Reserved 525

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Tutorial Reporting

Location where the Analytics Modules will be installed. If left

empty, it takes the default location of:

• 32-bit Windows environments:

AnalyticsModules
C:\Program Files\MicroStrategy\Analytics Modules

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Analytics Modules

Location where the Narrowcast Server Delivery Engine will be

installed. If left empty, it takes the default location of:

• 32-bit Windows environments:

NCSAdminDelivery C:\Program Files\MicroStrategy\Narrowcast Server
Engine \Delivery Engine

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Narrowcast Server\Delivery E
ngine

Location where the Subscription Portal will be installed. If left

empty, it takes the default location of:

• 32-bit Windows environments:

SubscriptionPort C:\Program Files\MicroStrategy\Narrowcast Server
al \Subscription Portal

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Narrowcast Server\Subscripti
on Portal

Location where MicroStrategy Tutorial - Delivery will be installed.

If left empty, it takes the default location of:
TutorialDelivery • 32-bit Windows environments:
C:\Program Files\MicroStrategy\Narrowcast Server
\Tutorial

Copyright © 2021 All Rights Reserved 526

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Narrowcast Server\Tutorial

Location where MicroStrategy Integrity Manager will be installed. If

left empty, it takes the default location of:

• 32-bit Windows environments:

IntegrityManager
C:\Program Files\MicroStrategy\Integrity Manager

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Integrity Manager

Location where MicroStrategy Mobile will be installed. If left

empty, it takes the default location of:

• 32-bit Windows environments:

Mobile
C:\Program Files\MicroStrategy\Mobile Clients

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Mobile Clients

Location where MicroStrategy Mobile Server ASP.NET will be

installed. If left empty, it takes the default location of:

• 32-bit Windows environments:

MobileASPPath C:\Program Files\MicroStrategy\Mobile Server ASP
x

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Mobile Server ASPx

Location where MicroStrategy Mobile Server JSP will be installed.

If left empty, it takes the default location of:

• 32-bit Windows environments:

MobileJSPPath
C:\Program Files\MicroStrategy\Mobile Server JSP

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Mobile Server JSP

Location where MicroStrategy Portlets will be installed. If left

Portlets
empty, it takes the default location of:

Copyright © 2021 All Rights Reserved 527

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• 32-bit Windows environments:

C:\Program Files\MicroStrategy\Portlets

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\Portlets

Location where the MicroStrategy MDX Cube Provider will be

installed. If left empty, it takes the default location of:

• 32-bit Windows environments:

MDXCubeProvider
C:\Program Files\MicroStrategy\MDX Cube Provider

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\MDX Cube Provider

Location where the MicroStrategy GIS Connectors will be installed.

If left empty, it takes the default location of:

• 32-bit Windows environments:

GISConnectors
C:\Program Files\MicroStrategy\GISConnectors

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\GISConnectors

Location where the MicroStrategy System Manager will be

installed. If left empty, it takes the default location of:

• 32-bit Windows environments:

SystemManager
C:\Program Files\MicroStrategy\SystemManager

• 64-bit Windows environments: C:\Program Files 

(x86)\MicroStrategy\SystemManager

Sel ect Co m p o n en t s Di al o g - Pr o d u ct Vi si b i l i t y St at e

In the MicroStrategy Installation Wizard, the Select Components dialog box

contains checkboxes to select or clear for products to be installed. The
[ComponentSelection] options specify whether you want the following
products to be visible to the user. In addition, you can set the default
selection for each product.

Copyright © 2021 All Rights Reserved 528

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Equivalent to the Select

Components dialog box that you
see during installation. For the
Visible option, you can either
enter TRUE to show a product or
FALSE to hide it. If you do not
[ComponentSelection] specify a TRUE or FALSE value for
each product, TRUE is used for all
products. For the Select option,
you can enter TRUE to select the
checkbox next to a product. If you
enter FALSE, the checkbox next to
the product is not selected.

TRUE or FALSE. FALSE displays

HideDialog the dialog box. The default is
FALSE.

AnalyticsModulesVisible MicroStrategy Analytics Modules

ArchitectVisible MicroStrategy Architect

CommandManagerVisible MicroStrategy Command Manager

DeliveryEngineVisible MicroStrategy Delivery Engine

DeveloperVisible MicroStrategy Developer

AnalystVisible MicroStrategy Analyst

EnterpriseManagerVisible MicroStrategy Enterprise Manager

MicroStrategy Function Plug-In

FunctionPluginVisible
Wizard

GISConnectorsVisible MicroStrategy GIS Connectors

IntegrityManagerVisible MicroStrategy Integrity Manager

MicroStrategy Distribution
IntelligenceDistributionServicesVisible
Services

Copyright © 2021 All Rights Reserved 529

In st allat io n an d Co n figu r at io n Gu id e

Options Description

IntelligenceOLAPServicesVisible MicroStrategy OLAP Services

IntelligenceReportServicesVisible MicroStrategy Report Services

MicroStrategy Transaction
IntelligenceTransactionServicesVisible
Services

IntelligenceVisible MicroStrategy Intelligence Server

MicroStrategy Mobile Server

MobileServerASPVisible
(ASP.NET)

MicroStrategy Mobile Server

MobileServerJSPVisible
(JSP)

MobileVisible MicroStrategy Mobile

MobileClientVisible MicroStrategy Mobile Client

MicroStrategy Narrowcast
NCSAdminVisible
Administrator

ObjectManagerVisible MicroStrategy Object Manager

OfficeVisible MicroStrategy Office

PortletsVisible MicroStrategy Portlets

SequeLinkVisible SequeLink ODBC Socket Server

MicroStrategy Server
ServerAdminVisible
Administrator

SubscriptionPortalVisible MicroStrategy Subscription Portal

SystemManagerVisible MicroStrategy System Manager

MDXCubeProviderVisible MicroStrategy MDX Cube Provider

MicroStrategy Tutorial - Delivery

TutorialDeliveryConfigureVisible
Configuration

TutorialDeliveryInstallVisible MicroStrategy Tutorial - Delivery

Copyright © 2021 All Rights Reserved 530

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Installation

WebAnalystVisible MicroStrategy Web Analyst

WebProfessionalVisible MicroStrategy Web Professional

WebReporterVisible MicroStrategy Web Reporter

MicroStrategy Web Server

WebServerASPNETVisible
(ASP.NET)

WebServerJSPVisible MicroStrategy Web Server (JSP)

MicroStrategy Web Services

WebServicesASPNETVisible
(ASP.NET)

MicroStrategy Web Services

WebServicesJSPVisible
(JSP)

TelemetryServerVisible MicroStrategy Telemetry

TomcatVisible Apache Tomcat

MySQLVisible MySQL

MicroStrategy Library Web and

LibraryWebMobileVisible
Mobile

CollaborationVisible Collaboration Server

DataServerVisible Data Server

CommunityConnectorsVisible Community Connectors

PlatformAnalyticsVisible Platform Analytics

CertificateStoreVisible Certificate Store

Sel ect Co m p o n en t s Di al o g - Pr o d u ct Sel ect i o n St at e

During the installation process in the MicroStrategy Installation Wizard, the

Select Components dialog box contains checkboxes to select or clear for
products to be installed. You can either specify TRUE to install a product or

Copyright © 2021 All Rights Reserved 531

In st allat io n an d Co n figu r at io n Gu id e

FALSE to uninstall it. If you do not specify a TRUE or FALSE value for each
product, the installation always uses the most recent selection from a
previous install.

This means that if you have a product installed and you do not specify a
TRUE or FALSE value, the product is upgraded.

If you specify TRUE, the product checkbox is selected. The

[ComponentSelection] options specify whether the checkbox for each
product will be selected or cleared.

Options Description

AnalyticsModulesSelect MicroStrategy Analytics Modules

ArchitectSelect MicroStrategy Architect

CommandManagerSelect MicroStrategy Command Manager

DeliveryEngineSelect MicroStrategy Delivery Engine

DeveloperSelect MicroStrategy Developer

AnalystSelect MicroStrategy Analyst

EnterpriseManagerSelect MicroStrategy Enterprise Manager

MicroStrategy Function Plug-In

FunctionPluginSelect
Wizard

GISConnectorsSelect MicroStrategy GIS Connectors

IntegrityManagerSelect MicroStrategy Integrity Manager

IntelligenceDistributionServicesSelect MicroStrategy Distribution Services

IntelligenceOLAPServicesSelect MicroStrategy OLAP Services

IntelligenceReportServicesSelect MicroStrategy Report Services

IntelligenceSelect MicroStrategy Intelligence Server

IntelligenceTransactionServicesSelect MicroStrategy Transaction Services

Copyright © 2021 All Rights Reserved 532

In st allat io n an d Co n figu r at io n Gu id e

Options Description

MobileClientSelect MicroStrategy Mobile Client

MobileSelect MicroStrategy Mobile

MicroStrategy Mobile Server

MobileServerASPSelect
(ASP.NET)

MobileServerJSPSelect MicroStrategy Mobile Server (JSP)

MicroStrategy Narrowcast
NCSAdminSelect
Administrator

ObjectManagerSelect MicroStrategy Object Manager

OfficeSelect MicroStrategy Office

PortletsSelect MicroStrategy Portlets

SequeLinkSelect SequeLink ODBC Socket Server

ServerAdminSelect MicroStrategy Server Administrator

SubscriptionPortalSelect MicroStrategy Subscription Portal

SystemManagerSelect MicroStrategy System Manager

MDXCubeProviderSelect MicroStrategy MDX Cube Provider

MicroStrategy Tutorial - Delivery

TutorialDeliveryConfigureSelect
Configuration

MicroStrategy Tutorial - Delivery

TutorialDeliveryInstallSelect
Installation

WebAnalystSelect MicroStrategy Web Analyst

WebProfessionalSelect MicroStrategy Web Professional

WebReporterSelect MicroStrategy Web Reporter

MicroStrategy Web Server

WebServerASPNETSelect
(ASP.NET)

Copyright © 2021 All Rights Reserved 533

In st allat io n an d Co n figu r at io n Gu id e

Options Description

WebServerJSPSelect MicroStrategy Web Server JSP

MicroStrategy Web Services

WebServicesASPNETSelect
(ASP.NET)

WebServicesJSPSelect MicroStrategy Web Services (JSP)

TelemetryServerSelect MicroStrategy Telemetry

TomcatSelect Apache Tomcat

MicroStrategy Library Web and

LibraryWebMobileSelect
Mobile

CollaborationSelect Collaboration Server

DataServerSelect Data Server

CommunityConnectorsSelect Community Connectors

PlatformAnalyticsSelect Platform Analytics

CertificateStoreSelect Certificate Store

In st al l at i o n Fi l es

Options Description

Section specifying the location of the files required to install

the MicroStrategy components you have selected for
installation. Specifying the location of the installation files is
only required if you have downloaded only a subset of the
[IODSourceLocation]
MicroStrategy installation files and stored some of the files
in another location. For steps to determine the files required
for your installation, see Creating Custom Installation
Packages, page 133.

Determines whether the required installation files are

Style provided in a folder or at a URL. You must define this
parameter with one of the following values:

Copyright © 2021 All Rights Reserved 534

In st allat io n an d Co n figu r at io n Gu id e

Options Description

• FILESERVER: Type this value if the required installation

files are stored in a folder on the local machine or a server
machine. You must also provide the location of the files
using the SourceLocation parameter.

• HTTP: Type this value if the required installation files are

stored at an unsecured URL. You must also provide the
location of the files using the URL parameter.

• HTTPS: Type this value if the required installation files are

stored at a secured URL. You must also provide the
location of the files using the URL parameter, as well as
the user name and password to access the URL using the
UserName and Password parameters.

Location of the folder that stores any required installation

files. Type the location of the local file path. If you store the
SourceLocation
files in a local folder, do not provide a location in the URL
parameter.

Location of the URL for the HTTP or HTTPS location that

stores any required installation files. Type the URL for the
URL location that stores any required installation files. If you
store the files at an HTTP or HTTPS location, do not provide
a location in the SourceLocation parameter.

If you retrieve the installation files from a URL location, type

a user name that has access to the URL location. If there is
UserName
no login required to the URL or you retrieve the installation
files from a local folder, you can leave this field blank.

If you retrieve the installation files from a URL location, type

a password for the user name. If there is no login required to
Password
the URL or you retrieve the installation files from a local
folder, you can leave this field blank.

Copyright © 2021 All Rights Reserved 535

In st allat io n an d Co n figu r at io n Gu id e

To p o l o gy Co n f i gu r at i o n

Options Description

[ServicesRegConfig] Section that specifies the services registration configuration.

TRUE or FALSE. FALSE displays the dialog box. The default

HideDialog
is FALSE.

TRUE or FALSE. FALSE sets this machine as a server node

MultipleMachine
in the environment. Otherwise, specify the server nodes in
Environment
the ServersInCluster option.

Provide the services registration server hostnames,

separated by semicolons. The input must to be identical for
all configured machines in this environment. It is
ServersInCluster
recommended to configure an odd number of servers in a
cluster. Example: server1.domain.com;
server2.domain.com; server3.domain.com.

Pl at f o r m An al yt i cs Co n f i gu r at i o n

Options Description

Section that specifies the configuration for

[PlatformAnalyticsConfig]
Platform Analytics.

TRUE or FALSE. FALSE displays the dialog box.

HideDialog
The default is FALSE.

TRUE or FALSE. For non-upgrades,

TRUE specifies a custom MySQL database to
PlatformAnalyticsUseCustomDB
store Platform Analytics data. For upgrades,
TRUE specifies a new MySQL database location.

PlatformAnalyticsDBHost The hostname for the MySQL database.

PlatformAnalyticsDBPort The port for the MySQL database.

The username for accessing the MySQL

PlatformAnalyticsDBUser
database.

Copyright © 2021 All Rights Reserved 536

In st allat io n an d Co n figu r at io n Gu id e

Options Description

The user's password for accessing the MySQL

PlatformAnalyticsDBPassword
database.

M i cr o St r at egy Tel em et r y Cl u st er Co n f i gu r at i o n

Options Description

TelemetryServerConfig Section that configures MicroStrategy Telemetry.

TRUE or FALSE. FALSE displays the dialog box.

HideDialog
The default is FALSE.

TRUE or FALSE.TRUE enables MicroStrategy

TelemetryServerCluster
Telemetry. The default is FALSE.

TelemetryServerLocalNode Enter the local node's hostname.

Enter a semicolon separated list of the remote

TelemetryServerRemoteNodes
node's hostnames.

In t el l i gen ce Ser ver Def i n i t i o n Set t i n g

Options Description

Section specifying whether MicroStrategy

[ServerDefinitionSetting] Intelligence Server will use the server definition
included with the Tutorial.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

TRUE or FALSE. This option relates to the Tutorial.

Set this option to overwrite existing MicroStrategy
OverwriteServerDefinition
Intelligence Server definitions from a previous
install. The default is FALSE.

Copyright © 2021 All Rights Reserved 537

In st allat io n an d Co n figu r at io n Gu id e

An al yt i cs M o d u l e

Options Description

Section that specifies the DSN used to connect to the

[AnalyticsSetting]
MicroStrategy Analytics Modules.

TRUE or FALSE. FALSE displays the dialog box. The default is

HideDialog
FALSE.

TRUE or FALSE. Set this option to overwrite an existing DSN

with the same name. The data source names are as follows:

• Analytics_Metadata

• CAM_WH_AC

• FRAM_WH_AC
OverwriteDSN
• HRAM_WH_AC

• MicroStrategy_Tutorial_Data

• SAM_WH_AC

• SDAM_WH_AC

The default is FALSE.

M i cr o St r at egy Web Vi r t u al Di r ect o r y

Options Description

Section that specifies the virtual directory to be used for

[WebVirtualDirectory]
the MicroStrategy Web application.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

Enter a name for the virtual directory. The default is

VirtualDirectory
MicroStrategy.

YES or NO. This option is for the uninstall only. Set this
RemoveVD option to remove an existing MicroStrategy Web virtual
directory from a previous installation. The default is NO.

Copyright © 2021 All Rights Reserved 538

In st allat io n an d Co n figu r at io n Gu id e

M i cr o St r at egy M o b i l e Ser ver Vi r t u al Di r ect o r y

Options Description

Section that specifies the virtual directory to be

[MobileVirtualDirectory] used for the MicroStrategy Mobile Server
applications.

TRUE or FALSE. FALSE displays the dialog box.

HideDialog
The default is FALSE.

Enter a name for the virtual directory. The default

VirtualDirectory
is MicroStrategyMobile.

TRUE or False. This option is relevant to

upgrading MicroStrategy from a pre-9.0.1m
version. TRUE replaces the virtual directory used to
ReconfigureVirtualDirectory support MicroStrategy Mobile for BlackBerry with
the new virtual directory specified for
MicroStrategy Mobile Server. For more information
on upgrade installations, see the Upgrade Help.

YES or NO. This option is for the uninstall only. Set

this option to remove an existing MicroStrategy
RemoveVD
Mobile Server virtual directory from a previous
installation. The default is NO.

M i cr o St r at egy M DX Cu b e Pr o vi d er Vi r t u al Di r ect o r y

Options Description

Section that specifies the virtual directory

[MDXCubeProviderVirtualDirectory] to be used for the MicroStrategy MDX
Cube Provider.

TRUE or FALSE. FALSE displays the

HideDialog
dialog box. The default is FALSE.

Enter a name for the virtual directory. The

VirtualDirectory
default is MicroStrategyMDX.

Copyright © 2021 All Rights Reserved 539

In st allat io n an d Co n figu r at io n Gu id e

Options Description

TRUE or FALSE. Set this option to TRUE if

the virtual directory for the MicroStrategy
ReconfigureVirtualDirectory MDX Cube Provider should be
reconfigured to support a new virtual
directory.

YES or NO. This option is for the uninstall

only. Set this option to remove an existing
RemoveVD MicroStrategy MDX Cube Provider virtual
directory from a previous installation. The
default is NO.

Su b scr i p t i o n Po r t al Vi r t u al Di r ect o r y

Options Description

Section that specifies the virtual directory to be used

[PortalVirtualDirectory]
for MicroStrategy Subscription Portal.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

Enter a name for the virtual directory. The default is

VirtualDirectory
NarrowcastServer.

YES or NO. This option is for the uninstall only. Set this
option to remove an existing MicroStrategy
RemoveVD
Subscription Portal virtual directory from a previous
installation. The default is NO.

M i cr o St r at egy Web Ser vi ces Vi r t u al Di r ect o r y

Options Description

Section that specifies the virtual directory to be used for

[WebServicesDirectory]
MicroStrategy Web Services.

Copyright © 2021 All Rights Reserved 540

In st allat io n an d Co n figu r at io n Gu id e

Options Description

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

Enter a name for the virtual directory. The default is

VirtualDirectory
MicroStrategyWS.

YES or NO. This option is for the uninstall only. Set this
option to remove an existing MicroStrategy Subscription
RemoveVD
Portal virtual directory from a previous installation. The
default is NO.

M i cr o St r at egy Of f i ce Web Ser vi ces URL

This information applies to the legacy MicroStrategy Office add-in, the

add-in for Microsoft Office applications which is no longer actively
developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

Options Description

Section specifying the URL for MicroStrategy Web

[OfficeWebServicesURL]
Services and Web Services.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

TRUE or FALSE. Specify whether to allow a blank URL.

The installation routine validates the provided URL. If no
AllowBlankURL
URL is provided, the user is informed that it has been left
blank and needs to be configured with the MicroStrategy

Copyright © 2021 All Rights Reserved 541

In st allat io n an d Co n figu r at io n Gu id e

Options Description

Office Configuration Tool. If this is set to TRUE, the user

message is not displayed if the URL is left blank. The
default is FALSE.

Enter a URL pointing to a valid MicroStrategy Web

URL Services installation, for example,
http://localhost/MicroStrategyWS/MSTRWS.asmx

M i cr o St r at egy Of f i ce Set t i n g

This information applies to the legacy MicroStrategy Office add-in, the

add-in for Microsoft Office applications which is no longer actively
developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

Options Description

Section specifying the options that determine if the

[MSOfficeLoadOptions] MicroStrategy Office toolbar is loaded in the installed
Microsoft Office applications.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

TRUE or FALSE. Specify to load the MicroStrategy Office

toolbar by default when the Microsoft Excel application
ConfigureExcel
runs. This applies only if Excel is installed in the target
machine. The default is TRUE.

ConfigureWord TRUE or FALSE. Specify to load the MicroStrategy Office

Copyright © 2021 All Rights Reserved 542

In st allat io n an d Co n figu r at io n Gu id e

Options Description

toolbar by default when the Microsoft Word application

runs. This applies only if Word is installed on the target
machine. The default is TRUE.

TRUE or FALSE. Specify to load the MicroStrategy Office

toolbar by default when the Microsoft PowerPoint
ConfigurePowerpoint
application runs. This applies only if PowerPoint is
installed on the target machine. The default is TRUE.

In t el l i gen ce Ser ver Ser vi ce Acco u n t

Options Description

Section specifying the Windows account for the

MicroStrategy Intelligence Server service. You
have two options:
[IntelligenceServiceAccount]
• bypass entering the account information

• enter the account information

TRUE or FALSE. FALSE displays the dialog box.

HideDialog
The default is FALSE.

TRUE or FALSE. Set TRUE to bypass the service

account setting in the MicroStrategy Intelligence
Server Setting dialog box. If you bypass it, then
SkipAccountSetting
the service runs with the local system account
that is installing the products. The default is
FALSE.

Domain Enter the domain where the account is located.

Login Enter the user name of the account to use.

Password Enter the password for the account.

AUTO or MANUAL. Select to set the Intelligence

ServiceStartup Server service startup to be automatic or
manual. The default is AUTO.

Copyright © 2021 All Rights Reserved 543

In st allat io n an d Co n figu r at io n Gu id e

N ar r o w cast Ser ver Ser vi ce Acco u n t

Options Description

Section specifying the Windows account from which

[NarrowcastServiceAccount] the MicroStrategy Narrowcast Server service will
run.

TRUE or FALSE. FALSE displays the dialog box. The

HideDialog
default is FALSE.

TRUE or FALSE.

If you specify this value as FALSE, the service

account settings are not skipped and the

SkipAccountSetting MicroStrategy Narrowcast Server setting dialog box

is displayed. Specify the details of the Windows
account that the MicroStrategy Narrowcast Server
services will use to log on and click Next to
proceed with the installation process.

Domain Enter the domain where the account is located.

Login Enter the user name of the account to use.

Password Enter the password for the account.

St ar t Co p yi n g Fi l es Di al o g

Options Description

Section that specifies the installation summary in the Start Copying Files
[Summary]
dialog box.

HideDialog TRUE or FALSE. FALSE displays the dialog box. The default is FALSE.

Copyright © 2021 All Rights Reserved 544

In st allat io n an d Co n figu r at io n Gu id e

M i cr o St r at egy In st al l at i o n Wi zar d Co m p l et e Di al o g

Options Description

Section that specifies the MicroStrategy Installation Wizard Complete

[Finish]
dialog box.

HideDialog TRUE or FALSE. FALSE displays the dialog box. The default is FALSE.

Exam ple of a response.ini File for Custom Installation to Install All

Com ponents

Starting from 10.4, you can find the sample_custom.ini in the same
location as the installation setup.exe. Replace any text between the
angled brackets <> with your own specific information.

Your license key determines which MicroStrategy components will be

available for your installation. For example, if your license key does not
include MicroStrategy OLAP Services, then you cannot use
IntelligenceOLAPServicesSelect=TRUE and
IntelligenceOLAPServicesVisible=TRUE to install these
components.

Click here to see an example response.ini file for custom installation to

install all components.

######################################
## MicroStrategy 11.3 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.pd
f.

Copyright © 2021 All Rights Reserved 545

In st allat io n an d Co n figu r at io n Gu id e

#
# 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%20Enter
prise%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

Copyright © 2021 All Rights Reserved 546

In st allat io n an d Co n figu r at io n Gu id e

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

Copyright © 2021 All Rights Reserved 547

In st allat io n an d Co n figu r at io n Gu id e

#
# Please specify your first name, last name, email address, the name of the
company
# for which you work and the license key.
#

[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

Copyright © 2021 All Rights Reserved 548

In st allat io n an d Co n figu r at io n Gu id e

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

Copyright © 2021 All Rights Reserved 549

In st allat io n an d Co n figu r at io n Gu id e

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
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.5
TelemetryServerVisible=TRUE
TomcatVisible=TRUE
# New in 10.9
LibraryWebMobileVisible=TRUE

Copyright © 2021 All Rights Reserved 550

In st allat io n an d Co n figu r at io n Gu id e

CollaborationVisible=TRUE
# New in 11.0
CommunityConnectorsVisible=TRUE
PlatformAnalyticsVisible=TRUE
CertificateStoreVisible=TRUE
# New in 11.2
ExportVisible=TRUE

# New in 11.3
MicroStrategyRepositoryVisible=TRUE
CloudConnectorVisible=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

Copyright © 2021 All Rights Reserved 551

In st allat io n an d Co n figu r at io n Gu id e

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
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.5
TelemetryServerSelect=TRUE
TomcatSelect=TRUE
# New in 10.9
LibraryWebMobileSelect=TRUE
CollaborationSelect=TRUE
# New in 11.0

Copyright © 2021 All Rights Reserved 552

In st allat io n an d Co n figu r at io n Gu id e

CommunityConnectorsSelect=TRUE
PlatformAnalyticsSelect=TRUE
CertificateStoreSelect=TRUE
# New in 11.2
ExportSelect=TRUE

# New in 11.3
MicroStrategyRepositorySelect=TRUE
CloudConnectorSelect=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
# Topology Configuration
# The Workstation Topology helps administrators to monitor and manage
services
# in a MicroStrategy environment. Choose your configuration below.

[ServicesRegConfig]
HideDialog=TRUE

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
# Remote Repository Configuration

[RemoteRepositoryConfig]
HideDialog=TRUE
RemoteRepositoryHostname=
RemoteRepositoryPort=
RemoteRepositoryUsername=
RemoteRepositoryPassword=
OverrideExistingRepositoryPA=FALSE
OverrideExistingRepositoryCollab=FALSE

# 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

Copyright © 2021 All Rights Reserved 553

In st allat io n an d Co n figu r at io n Gu id e

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=

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
# 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=

[ServerDefinitionSetting]
HideDialog=TRUE
OverwriteServerDefinition=FALSE

[AnalyticsSetting]
HideDialog=TRUE
OverwriteDSN=FALSE

[WebVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategy
ReconfigureVirtualDirectory=TRUE

[MobileVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategyMobile
ReconfigureVirtualDirectory=TRUE

[PortalVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=NarrowcastServer
ReconfigureVirtualDirectory=TRUE

Copyright © 2021 All Rights Reserved 554

In st allat io n an d Co n figu r at io n Gu id e

[WebServicesVirtualDirectory]
HideDialog=TRUE
VirtualDirectory=MicroStrategyWS
ReconfigureVirtualDirectory=TRUE

[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

Copyright © 2021 All Rights Reserved 555

In st allat io n an d Co n figu r at io n Gu id e

Exam ple of a response.ini File for Express Installation

Starting from 10.4 you can find the sample_express.ini in the same
location as the installation setup.exe. Replace any text between angled
brackets <> with your own specific information.

Click here to see an example response.ini file for express installation.

######################################
## MicroStrategy 11.3 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.pd
f.
# 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.
#
# 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%20Enter
prise%20-%20Windows%20-%20U092?tabset-215d6=1
#
######################################
## Usage ##
######################################
#
# In an Administrator Command Line window (Windows Button > CMD, Right
Click and Run As Administrator)
#

Copyright © 2021 All Rights Reserved 556

In st allat io n an d Co n figu r at io n Gu id e

# 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
RunConfigWizard=FALSE
StopAllServices=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=

Copyright © 2021 All Rights Reserved 557

In st allat io n an d Co n figu r at io n Gu id e

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# 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 =

[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.
#
# 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>

Copyright © 2021 All Rights Reserved 558

In st allat io n an d Co n figu r at io n Gu id e

# 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

# New in 10.8
[Summary]
HideDialog=TRUE

[Finish]
HideDialog=TRUE

Using the response.ini File

The setup program supports several command-line parameters. The

following applies to this function:

l Parameters using double dashes, such as --auto, are defined by

MicroStrategy. For example, you can use the --auto parameter as
follows:

Path\setup.exe --Auto=TRUE --LogFile="C:\install.log"

l The command line is not case-sensitive.

The following parameters are supported by the setup program:

Copyright © 2021 All Rights Reserved 559

In st allat io n an d Co n figu r at io n Gu id e

l Auto: instructs the setup program to use the response file and default
values to enable a one-click installation. If a component, such as serial
key or disk space has an invalid value, the setup program automatically
reverts to multiple-click mode, and all dialog boxes are displayed.
l ResponseFile: contains responses to installation questions and
redefines default parameters. The path and file name must be in double
quotes (" "). If you use this parameter, do not use any other parameters.
l ConfigFile: used by the Configuration Wizard to set up a repository, a
server, or a client. The path and file name must be in double quotes (" ").
l LogFile: used to specify an alternative location and/or name (other than
install.log) for the log file in the Common Files directory. If only the
file name is entered, the default location remains the Common Files
directory. Once specified, the alternative file becomes the default.

To Use the response.ini File to Install MicroStrategy Components

1. Save your response.ini file to the directory C:\. You can save to
a different directory, but the example command provided in these steps
assumes the response file is saved to the directory location C:\.

2. From the Windows Start menu, select Programs, then select

Accessories, and then right-click Command Prompt and select Run
as Administrator. The User Account Control dialog box opens.

The steps to open a Windows command prompt with administrator

privileges may be different depending on your version of Windows.

3. Click Yes to open the command prompt with administrator privileges.

The command prompt is displayed.
4. Type the following command in the Windows command line:

<Path>\setup.exe --ResponseFile="C:\response.ini"

Where <Path> is the directory where the setup.exe file is stored.

Copyright © 2021 All Rights Reserved 560

In st allat io n an d Co n figu r at io n Gu id e

5. Click Enter.

Configuring your Installation with a response.ini File

The Configuration Wizard walks you through the process of setting up the
environment for the MicroStrategy products installed in your system. It is
possible to configure server definition, project source names, and the
metadata repository using a response.ini file. The steps required to
create a response.ini file to configure MicroStrategy are provided in
Configuring MicroStrategy with a Response File, page 417.

Uninstalling with a response.ini File

You can uninstall all MicroStrategy products at once using a response.ini
file. You must create a response file with the RemoveAll parameter set to
TRUE in the Welcome section. This is also known as a silent uninstallation.

You must save the file as ANSI encoding.

Before uninstallation begins, the MicroStrategy application:

l Checks for user privileges. If they are not valid, uninstallation stops.
l Checks for running components. If one is found, uninstallation stops.
l Stops and deletes the MicroStrategy Intelligence Server service.
l Deletes application created files.

Exam ple of a response.ini file to uninstall MicroStrategy

You can use the following response file to remove all MicroStrategy
products:

[Installer]
PropertiesFilesOverwrite=FALSE
EnableTracing=FALSE
HideAllDialogs=TRUE
ForceReboot=TRUE
PreventReboot=FALSE
CheckTCPIP=TRUE

Copyright © 2021 All Rights Reserved 561

In st allat io n an d Co n figu r at io n Gu id e

CheckIIS=TRUE
CheckSP=TRUE
CreateShortcuts=TRUE
CheckRenameOperations=TRUE
AnalyticsOverwrite=FALSE
TutDeliveryOverwrite=FALSE
BackupFiles=FALSE
RunConfigWizard=FALSE
StopAllServices=TRUE
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 details on creating a response.ini file, see Creating a response.ini

File, page 517.

Copyright © 2021 All Rights Reserved 562

In st allat io n an d Co n figu r at io n Gu id e

After you have created a response.ini file, open a Windows command

prompt to uninstall all MicroStrategy products. From the Windows Start
menu, select Programs, then select Accessories, and then right-click
Command Prompt and select Run as Administrator. The User Account
Control dialog box opens.

The steps to open a Windows command prompt with administrator privileges

may be different depending on your version of Windows.

Click Yes to open the command prompt with administrator privileges. The
command prompt is displayed. Type the following script at the command
prompt to uninstall all MicroStrategy products:

Path1\setup.exe --ResponseFile= "Path2\response.ini"

Where the Path1 for setup.exe must be the path to the original
setup.exe used to install MicroStrategy products. The Path2 for the
response file is the path where you saved your response.ini file.

Silent Installation
A silent, or unattended, installation is one that presents no user interface.
Silent installations are useful for system administrators who do not want
users to interfere with the installation. They are typically implemented by IT
departments that perform package-based installations across the network.

You can use silent installation to easily embed MicroStrategy products with
other applications. This can be done to develop an OEM application that
includes MicroStrategy functionality. For information on deploying a silent
installation for OEM applications, see OEM Silent Installations, page 627.

Silent Installation File Generator

Silent, or unattended installation, is the best way to automate your
MicroStrategy deployment. Based on your selections, the file generator will
create a fully configured response.ini file for Windows installations. This
allows administrators to bypass modifying and editing files manually,

Copyright © 2021 All Rights Reserved 563

In st allat io n an d Co n figu r at io n Gu id e

providing quick turn-around for creating different MicroStrategy

configurations that are required with large-scale enterprise deployments.

Silent installation files generated are only supported for installations of

MicroStrategy 2020 or later.

Creating the Installation File

From the Silent Installation Generator home page:

1. Review and accept the Legal Notices and Terms of Use statement.

2. Select Windows from the Operating System drop-down.

3. Select the MicroStrategy Version to install.

4. Select a Custom or Express installation.
5. Click Next.
6. Complete the customer information and enter the license key for your
installation.
7. Modify the installation directories if desired.
8. Click Next.
9. Select the components to be installed and Click Next.
10. Step through the wizard to configure your installation. Steps will vary
based on operating system and components selected.
11. Click Download File to retrieve your silent installation file.

Silent Installation Output

The system verifies compliance with installation prerequisites and places
related messages in a file created for that purpose. The following applies to
the generation and storage of output messages during silent installation:

l The MSTRInst.log file is created and placed in the Temp folder.

l The MSTRInst.log file is maintained during the entire setup.

Copyright © 2021 All Rights Reserved 564

In st allat io n an d Co n figu r at io n Gu id e

l All system-generated messages, including messages containing reasons

for pre-installation termination, are stored in the MSTRInst.log file.

If there are installation termination messages in subsequent installation

instances that use the same dialog flow, they are also stored in the
MSTRInst.log.

The table below identifies the information that the MSTRInst.log file
includes:

Line Description

Function [F] Identifies the function calls in the setup script.

Information
Logs information about the setup that is running.
[I]

Includes feedback that you must verify related to the setup. For example, in
normal mode, when MicroStrategy applications are running on a machine
Warning [W] where the setup is being run, you are prompted to close all MicroStrategy
applications before proceeding. In silent mode, you are not prompted, and
instead the setup terminates.

Includes fatal problems that prevent the setup from proceeding. For
Severe [S] example, the Intelligence Server Service cannot be created and setup fails
as a result.

A typical line in the MSTRInst.log file includes source file name, function
name, source line number, and time. It appears as follows:

[Z:\InstallMaster\Setup\Script Files\MALicense.rul][UseDLL][l:
28][1318179ms][W] Le file C:\WINDOWS\TEMP\{84D0D5E2-719A-11D7-
847C-000C293B5019}\{B339F3B3-E78C-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.

Copyright © 2021 All Rights Reserved 565

In st allat io n an d Co n figu r at io n Gu id e

Activating a Silent Installation

After the silent installation is complete, you must activate the MicroStrategy
installation within 30 days. To activate the installation you can follow the
instructions provided in Chapter 4, Activating Your Installation.

Silent Installation of an Update

An update is a file or a collection of files that you can apply to MicroStrategy
products installed on your computer to correct a specific problem. Updates
are packaged in a self-installing .exe file. When you install an update, files
are backed up automatically so that you can remove the update later.

You can apply an update to MicroStrategy products using silent installation.

For information on installing the update of MicroStrategy Office, see Silent
Installation of MicroStrategy Office, page 571.

You must obtain and unzip the MicroStrategy update files. These files include
response.ini and setup.iss. The rest of this procedure assumes you have
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 since MicroStrategy 2019 Update 2 installing an update requires

that you obtain a new license key, different from your license key for
MicroStrategy 2019. Both keys can be retrieved using the "Generate Keys"
tile on the MicroStrategy download page.

To Perform a Silent Installation of an Update

If you are installing an update of MicroStrategy Office, see Silent

Installation of MicroStrategy Office, page 571.

1. From the Windows Start menu, go to Programs > Accessories, and

then right-click Command Prompt > Run as Administrator. The User
Account Control dialog box opens.

Copyright © 2021 All Rights Reserved 566

In st allat io n an d Co n figu r at io n Gu id e

The steps to open a Windows command prompt with administrator

privileges may be different depending on your version of Windows.

2. Click Yes to open the command prompt with administrator privileges.

3. Access the disk drive through the command prompt.

4. Run the silent installation with the following command:

<InstallPath>\setup.exe -L<LanguageValue> --
ResponseFile="C:\response.ini" -s -f1"C:\setup.iss" -f2"C:\setup.log"

In the command listed above, you must supply the following

information:

l <InstallPath>: The location in which to install the MicroStrategy update.

l <LanguageValue>: Determines the language for the installation.

Refer to Language Settings for Silent Installations, page 631, for an

explanation of the LanguageValue parameter.

For example, to select English, the command is as follows:

<InstallPath>\setup.exe -L0009 --ResponseFile="C:\response.ini" -s -

f1"C:\setup.iss" -f2"C:\setup.log"

You can check the status of the silent installation in Windows Task Manager.
After applying the update, you can view it in the Add or Remove Programs
window.

Silent Install of Workstation on Windows

This topic applies to MicroStrategy Workstation versions 10.9 and later.

1. Gather the required response.ini and setup.iss files.

For a sample response.ini file in Windows, click here.

Copyright © 2021 All Rights Reserved 567

In st allat io n an d Co n figu r at io n Gu id e

The KeepMySettingsOnMaintenance flag is used for uninstallation.

This flag keeps the user data and Workstation settings in Windows
under the user directory folder. The path is
<UserDirectory>\AppData\Local\Microstrategy_Inc\.

[Installer]
HideAllDialogs=TRUE
CreateDesktopShortcuts=TRUE
CreateStartMenuShortcuts=TRUE

[InitialPaths]
MicroStrategyWorkstation=C:\Program Files\MicroStrategy

[Welcome]
RemoveAll=FALSE

[Finish]
LaunchWorkstationAfterInstall=FALSE

For a sample setup.iss file in Windows, click here.

[InstallShield Silent] 
Version=v7.00
File=Response File 

[Application] 
Name=InstallShield 
Version=11.3.0
Company=MicroStrategy

2. Place the response.ini and setup.iss files in the C: drive or your

selected drive.
3. Open a command prompt.

4. Run the WindowsWorkstation.exe file in silent mode in the

Workstation path with the following script:

"path-to-WindowsWorkstation.exe" -s --
ResponseFile="c:\TMP\Wrkst\response.ini" -f1"c:\TMP\Wrkst\setup.iss" -
f2"c:\TMP\Wrkst\setup.log"

Where:

Copyright © 2021 All Rights Reserved 568

In st allat io n an d Co n figu r at io n Gu id e

l path-to-WindowsWorkstation.exe: Specifies the path and name

to the installation executable. Can be a local or remote file. In this
case, path-to-WindowsWorkstation.exe is
<InstallationPackage>\resources\unpacked\WindowsWork
station.exe. If you access the WindowsWorkstation.exe over a
network path, make sure you can access it in Windows File Explorer.
l --ResponseFile: The response.ini file is the MicroStrategy
silent install configuration file.
l -s: When used, the installation will be run silently.
l -f1: Specifies the path and name for the InstallShield launcher's log
file. Do not include a space between the -f1 and the value
l -f2: Specifies the path and name for the installation output log file.
Do not include a space between the -f1 and the value

Silent Uninstall of Workstation on Windows

This topic applies to MicroStrategy Workstation versions 10.9 and later.

1. Gather the required response.ini and setup.iss files.

For a sample response.ini file in Windows, click here.

The KeepMySettingsOnMaintenance flag is used for uninstallation.

This flag keeps the user data and Workstation settings in Windows
under the user directory folder. The path is
<UserDirectory>\AppData\Local\Microstrategy_Inc\.

[Installer]
HideAllDialogs=TRUE
CreateDesktopShortcuts=FALSE
CreateStartMenuShortcuts=FALSE

[InitialPaths]
MicroStrategyWorkstation=C:\Program Files\MicroStrategy\Workstation

[Welcome]

Copyright © 2021 All Rights Reserved 569

In st allat io n an d Co n figu r at io n Gu id e

RemoveAll=TRUE

[Finish]LaunchWorkstationAfterInstall=FALSE
KeepMySettingsOnMaintenance=FALSE

For a sample setup.iss file in Windows, click here.

[InstallShield Silent] 
Version=v7.00
File=Response File

[Application] 
Name=InstallShield 
Version=11.3.0
Company=MicroStrategy

2. Place the response.ini and setup.iss files in the C: drive or your

selected drive.
3. Open a command prompt.

4. Run the WindowsWorkstation.exe file in silent mode in the

Workstation path with the following script:

<path-to-WindowsWorkstation.exe>\WindowsWorkstation.exe -s --
ResponseFile="C:\response.ini" -f1"C:\setup.iss" -f2"c:\setup.log"

Where:

l path-to-WindowsWorkstation.exe: Specifies the path and name

to the installation executable. Can be a local or remote file. If you
access the WindowsWorkstation.exe over a network path, make
sure you can access it in Windows File Explorer.

l --ResponseFile: The response.ini file is the MicroStrategy

silent install configuration file.

l -s: When used, the installation will be run silently.

l -f1: Specifies the path and name for the InstallShield launcher's log
file. Do not include a space between the -f1 and the value

Copyright © 2021 All Rights Reserved 570

In st allat io n an d Co n figu r at io n Gu id e

l -f2: Specifies the path and name for the installation output log file.
Do not include a space between the -f1 and the value

Silent Installation of MicroStrategy Office

This information applies to the legacy MicroStrategy Office add-in, the

add-in for Microsoft Office applications which is no longer actively
developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

You can also install MicroStrategy Office as its own stand-alone installation,
which lets you install only MicroStrategy Office. The stand-alone installation
of MicroStrategy Office can also be used to install updates of the
MicroStrategy Office product.

To perform a silent installation of MicroStrategy Office as a stand-alone

installation, 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 are provided in the MicroStrategy for Office Help.

l You must have Microsoft .NET Framework and Microsoft Web Services
Enhancement Runtime to install and support MicroStrategy Office. For the
required 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.

Copyright © 2021 All Rights Reserved 571

In st allat io n an d Co n figu r at io n Gu id e

To perform a silent installation of MicroStrategy for Office

1. Download the MicroStrategy Office stand-alone installation files. You

can retrieve these from the MicroStrategy installation disk, or from the
MicroStrategy download site. The MicroStrategy Office stand-alone
installation files include files named MicroStrategyOffice.msi and
MicroStrategyOffice64.msi. These .msi files are for installing
MicroStrategy Office on 32-bit and 64-bit versions of Microsoft Office,
respectively.
2. From the Windows Start menu, go to Programs > Accessories, and
then right-click Command Prompt and select Run as Administrator.
The User Account Control dialog box opens.

The steps to open a Windows command prompt with administrator

privileges may be different depending on your version of Windows.

3. Click Yes to open the command prompt with administrator privileges.

The command prompt is displayed.
4. From a command prompt, navigate to the MicroStrategy Office update
installation folder.
5. To view information on the options to run the silent install command,
enter the following command:
msiexec.msi /?

This includes information on options to log the installation details to a

log file.

6. To run the silent installation using installation options defined by the

current MicroStrategy Office configuration, enter one of the following
commands:
l To install on 32-bit versions of Microsoft Office:

msiexec.exe /i MicroStrategyOffice.msi /qn

Copyright © 2021 All Rights Reserved 572

In st allat io n an d Co n figu r at io n Gu id e

l To install on 64-bit versions of Microsoft Office:

msiexec.exe /i MicroStrategyOffice64.msi /qn

You can also use additional parameters as part of the silent

installation command, including the following:

l INSTALLDIR: Defines the directory in which MicroStrategy Office will

be installed. For example, you can define this parameter as
INSTALLDIR="C:\Program Files\MicroStrategy\Office".
l WSURL: Defines the URL for MicroStrategy Web Services. For
example, you can define this parameter as
WSURL="http://localhost/MicroStrategyWS/MSTRWS.asmx".
l LW: Specify whether to load the MicroStrategy Office toolbar by
default when the Microsoft Word application runs. This applies only if
Word is installed in the target machine. The default is 3, which loads
the toolbar. You can set this option to 2 to not load the toolbar for
Microsoft Word.
l LE: Specify whether to load the MicroStrategy Office toolbar by
default when the Microsoft Excel application runs. This applies only if
Excel is installed in the target machine. The default is 3, which loads
the toolbar. You can set this option to 2 to not load the toolbar for
Microsoft Excel.
l LP: Specify whether to load the MicroStrategy Office toolbar by
default when the Microsoft PowerPoint application runs. This applies
only if PowerPoint is installed in the target machine. The default is 3,
which loads the toolbar. You can set this option to 2 to not load the
toolbar for Microsoft PowerPoint.
l OFFICECREATESHORTCUTS: Specify whether to create a shortcut for
MicroStrategy Office in the Windows Start menu. The default is 1,
which creates the shortcut. You can set this option to 0 to exclude the
creation of this shortcut.

Copyright © 2021 All Rights Reserved 573

In st allat io n an d Co n figu r at io n Gu id e

Troubleshooting Silent Installations

Silent installation may not work if you are installing in a different
environment than the one you recorded. This is the case because any dialog
box that was not recorded previously is not recognized, such as a prompt to
stop your Intelligence Server or your IIS Web server. If this happens, verify:

l The version of Intelligence Server to ensure that you have the right one for
the products you are installing
l You do not have any MicroStrategy applications running
l The setup.log file to see if the ResultCode=0
l The install.log for any recorded errors during installation and the
MSTRInst.log file for any possible errors. The most common errors are:
n -8, which is an invalid path to the MicroStrategy Installation Wizard
silent response .iss file.
n -12, which is dialog boxes out of order. This occurs because an
unrecorded screen opened when running the silent install.

It is recommended that you create a silent install that can be used with a
response.ini file. For more information, see OEM Silent Installations,
page 627. This way you can change the settings in the response.ini file
without having to generate a new .iss file.

Configuring your MicroStrategy Installation

After completing the steps to install Intelligence Server, you can continue
the set up and configuration of your installation. To help guide the rest of
your installation and configuration steps, refer to the section Installation and
Configuration Checklists, page 139 in Chapter 1, Planning Your Installation,
for installation and configuration checklists.

Copyright © 2021 All Rights Reserved 574

In st allat io n an d Co n figu r at io n Gu id e

A UTOM ATED
I N STALLATION ON L IN UX

Copyright © 2021 All Rights Reserved 575

In st allat io n an d Co n figu r at io n Gu id e

This section explains the various methods of performing a fully automated

and unattended installation within the MicroStrategy platform when you do
not have access to a Linux graphical user interface (GUI).

Intelligence Server configurations possible through the command line on

Linux are covered in Chapter 11, Configuring MicroStrategy Using
Command Line Tools.

Before installing MicroStrategy products, see Chapter 1, Planning Your

Installation for important preinstallation information.

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

Silent installation files generated are only supported for installations of

MicroStrategy 2020 or later.

SSH is required to start and stop services in the Workstation Topology view.

Silent Installation File Generator

Silent, or unattended installation, is the best way to automate your
MicroStrategy deployment. Based on your selections, the file generator will
create a fully configured options.txt file for installation on Linux systems.
This allows administrators to bypass modifying and editing files manually,
providing quick turn-around for creating different MicroStrategy
configurations that are required with large-scale enterprise deployments.

Copyright © 2021 All Rights Reserved 576

In st allat io n an d Co n figu r at io n Gu id e

Silent installation files generated are only supported for installations of

MicroStrategy 2020 or later.

Creating the Installation File

From the Silent Installation Generator home page:

1. Review and accept the Legal Notices and Terms of Use statement.

2. Select Linux from the Operating System drop-down.

3. Select the MicroStrategy Version to install.

4. Click Next.
5. Complete the customer information and enter the license key for your
installation.
6. Modify the installation directories if desired.
7. Click Next.
8. Select the components to be installed and Click Next.
9. Step through the wizard to configure your installation. Steps will vary
based on operating system and components selected.
10. Click Download File to retrieve your silent installation file.

Completing a Silent Installation

To run silent installation, you must create an options file and then run it with
the MicroStrategy Installation Wizard. Save the options file as
options.txt. An example of an options.txt file is provided in Example
of an Options File, page 578 below. You can use the example as a template
and replace italicized text with your own information.

This options file or response file is used with the command line argument -
options to modify the wizard settings. The settings that can be specified
for the wizard are listed in the next section, Parameters for a Silent
Installation, page 599.

Copyright © 2021 All Rights Reserved 577

In st allat io n an d Co n figu r at io n Gu id e

1. Log on to the computer where you are installing one or more

MicroStrategy products.
2. You can access the installation files by asking your system
administrator to share the files in a network location.
3. Browse to the
MicroStrategyInstallation/QueryReportingAnalysis_Linux
directory.
4. Open options.txt in a text editor.
5. Specify a value for a setting by replacing the character's Value. For
detailed information on the parameters and values that can be supplied
with the options.txt file for a silent installation, see Parameters for a
Silent Installation, page 599.
6. Save the changes to the options.txt file.

7. To use the options file on a silent installation, specify -silent -

options <FileName> as a command line argument to the wizard,
where <FileName> is the name of this options file, for example,
options.txt.

For example, type the command:

./setup.sh -silent -options <path of the options.txt

file>

Example of an Options File

Copy and paste this example to create an options.txt file. Make sure you
check for correct spaces and new lines in all file paths.

For descriptions of each of the options listed in this example, see

Parameters for a Silent Installation, page 599.

The example below assumes you are using the full set of installation files to
support the MicroStrategy installation. If you have downloaded only a

Copyright © 2021 All Rights Reserved 578

In st allat io n an d Co n figu r at io n Gu id e

subset of the .tzp files that are required for the MicroStrategy installation,
you must define where these files are stored, using the parameters
described in Install on Demand Options, page 617.

Click here to see an example options.txt file.

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# Options File Template
#
# This file is a 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
#
#
# We are working to improve our Silent and Automated installation use-
cases. Feedback on
# Silent or Automated installations is welcomed via the MicroStrategy

Copyright © 2021 All Rights Reserved 579

In st allat io n an d Co n figu r at io n Gu id e

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
platform deployment:
#
https://success.microstrategy.com/s/topic/0TO44000000FlkIGAS/Secure%20Enter
prise%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

Copyright © 2021 All Rights Reserved 580

In st allat io n an d Co n figu r at io n Gu id e

# 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>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# Customer Information
#
# Please specify your name, the name of the company for which you work and

Copyright © 2021 All Rights Reserved 581

In st allat io n an d Co n figu r at io n Gu id e

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
#

Copyright © 2021 All Rights Reserved 582

In st allat io n an d Co n figu r at io n Gu id e

# 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
# REMOVE_UPDATE - Indicates a update 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.

Copyright © 2021 All Rights Reserved 583

In st allat io n an d Co n figu r at io n Gu id e

### 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
#
# The default value for Selection state settings is "true".
#
# 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:

Copyright © 2021 All Rights Reserved 584

In st allat io n an d Co n figu r at io n Gu id e

# "MicroStrategy Report Services Universal",

# "MicroStrategy OLAP Services Universal"
# "MicroStrategy Distribution Services"
# "MicroStrategy Transaction Services"

# MicroStrategy Intelligence Universal Edition

### 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

Copyright © 2021 All Rights Reserved 585

In st allat io n an d Co n figu r at io n Gu id e

### 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>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##

Copyright © 2021 All Rights Reserved 586

In st allat io n an d Co n figu r at io n Gu id e

#
# 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>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

Copyright © 2021 All Rights Reserved 587

In st allat io n an d Co n figu r at io n Gu id e

## ##
#
# 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>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# New in 11.2
# MicroStrategy Export

Copyright © 2021 All Rights Reserved 588

In st allat io n an d Co n figu r at io n Gu id e

### Export.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# New in 11.2
# MicroStrategy Repository

### Repository.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# New in 11.3
# MicroStrategy Cloud Object Connector

### CloudObjectConnector.active=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# Product Install Location.
# 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>

# MicroStrategy Portlets
### Portlets.installDirectory=<value>

# MicroStrategy GIS Connectors

### GISConnectors.installDirectory=<value>

Copyright © 2021 All Rights Reserved 589

In st allat io n an d Co n figu r at io n Gu id e

# MicroStrategy Community Data Connectors

### CommunityConnectors.installDirectory=<value>

# MicroStrategy Web Services J2EE

### WebServices.installDirectory=<value>

# MicroStrategy Mobile Server JSP

### MobileServer.installDirectory=<value>

# MicroStrategy Command Manager

### CommandManager.installDirectory=<value>

# MicroStrategy System Manager Install Location

### SystemManager.installDirectory=<value>

# MicroStrategy Platform Analytics Install Location

### PlatformAnalytics.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:
#

Copyright © 2021 All Rights Reserved 590

In st allat io n an d Co n figu r at io n Gu id e

# cpuCount.number=maximum
#
# The default value for this setting is "maximum"

### cpuCount.number=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# Remote Repository Connection
#
# A repository is required for the following components:
# Collaboration Server
# Platform Analytics
#
# To use a remote repository, provide the connectivity information to be
used.
# https://www2.microstrategy.com/producthelp/2021/InstallConfig/en-
us/Content/repository_overview.htm

### RemoteRepository.DBHost=<value>
### RemoteRepository.DBPort=<value>
### RemoteRepository.DBUser=<value>
### RemoteRepository.DBPassword=<value>

# For new installations use this option to indicate if platform_analytics_

wh
# should be dropped or preserved if it exists.
# true - Drop the schema and create a fresh configuration.
# false - Preserve the schema and upgrade it if necessary.
# The default value is false.
### PlatformAnalytics.overrideDb=<value>

# For new installations use this option to indicate if mstr_collab

# should be dropped or preserved.
# true - Drop the schema and create a fresh configuration.

Copyright © 2021 All Rights Reserved 591

In st allat io n an d Co n figu r at io n Gu id e

# false - Preserve the schema and upgrade it if necessary.

# The default value is false.
### Collaboration.overrideDb=<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

Copyright © 2021 All Rights Reserved 592

In st allat io n an d Co n figu r at io n Gu id e

# installed or will install. Separate the Fully Qualified Name using

semicolons.
# For example: node.mydomain.com; othernode.mydomain.com
### TelemetryServer.cluster.remotenodes=<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 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/La
ng_1033/Content/topology_install.htm
#
# Note: This machine must be able to communicate with other machines in

Copyright © 2021 All Rights Reserved 593

In st allat io n an d Co n figu r at io n Gu id e

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>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
# Registering as a service
#
# Use this user to start the services (optional)

### RegisterServices.user=<value>
### RegisterServices.group=<value>

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
## ##
#
# Hide Select Components dialog box
#
# Use this option to completely hide the product selection dialog during
the

Copyright © 2021 All Rights Reserved 594

In st allat io n an d Co n figu r at io n Gu id e

# 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
#
# The default value for Selection state settings is "true".
#
# 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).

Copyright © 2021 All Rights Reserved 595

In st allat io n an d Co n figu r at io n Gu id e

# MicroStrategy Intelligence Universal Edition

### 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>

# MicroStrategy Portlets
### Portlets.visible=<value>

# MicroStrategy GIS Connectors

### GISConnectors.visible=<value>

# MicroStrategy Web Services J2EE

### WebServices.visible=<value>

# MicroStrategy Mobile Server JSP

### MobileServer.visible=<value>

# MicroStrategy Community Data Connectors

Copyright © 2021 All Rights Reserved 596

In st allat io n an d Co n figu r at io n Gu id e

### CommunityConnectors.visible=<value>

# MicroStrategy Command Manager

### 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>

# 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>

# New in 11.2
# MicroStrategy Export
### Export.visible=<value>

# New in 11.2
# MicroStrategy Repository
### Repository.visible=<value>

Copyright © 2021 All Rights Reserved 597

In st allat io n an d Co n figu r at io n Gu id e

# New in 11.3
# MicroStrategy Cloud Object Connector
### CloudObjectConnector.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>

Copyright © 2021 All Rights Reserved 598

In st allat io n an d Co n figu r at io n Gu id e

# Configuration and Deployment Guide:

http://www2.microstrategy.com/producthelp/2020/InstallConfig/en-
us/Content/configuration_and_deployment.htm

Parameters for a Silent Installation

The following parameters define how a silent installation is performed.

The settings follow their descriptions, in the format:

settingname=<Value>

License Agreement
Define whether the license agreement is accepted by default:

licenseAgreement.accept=<Value>

You can define this parameter with one of the following values:

l true: The MicroStrategy license agreement is accepted by default. If you

perform the installation as a silent installation that does not display the
MicroStrategy Installation Wizard, you must use this value to install
MicroStrategy successfully.
l false: The MicroStrategy license agreement is not accepted by default.
The user that installs MicroStrategy must select to accept the license
agreement to continue with the MicroStrategy installation.

Customer Information
Your name, the name of the company for which you work, and the license
key:

l User:

userRegistration.user=<Value>

Copyright © 2021 All Rights Reserved 599

In st allat io n an d Co n figu r at io n Gu id e

l Company:

userRegistration.company=<Value>

l License key:

userRegistration.cdKey=<Value>

MicroStrategy Installation Instance

You can either install a new instance of MicroStrategy, or modify an existing
MicroStrategy installation:

l To install a new instance of MicroStrategy:

install.Instance=new

l To modify an existing MicroStrategy installation:

install.Instance=InstallPath

MicroStrategy Operations
In addition to installing MicroStrategy, you can also modify, repair, uninstall,
and upgrade existing MicroStrategy installations:

l To install a new instance of MicroStrategy:

install.Operation=FRESH_INSTALL

l To modify an existing MicroStrategy installation:

install.Operation=MODIFY

l To repair an existing MicroStrategy installation by performing the previous

installation attempt:

install.Operation=REPAIR

Copyright © 2021 All Rights Reserved 600

In st allat io n an d Co n figu r at io n Gu id e

l To uninstall an existing MicroStrategy installation:

install.Operation=UNINSTALL

l To upgrade an existing MicroStrategy installation:

install.Operation=UPGRADE

l To install a MicroStrategy Update installation:

install.Operation=HOTFIX_INSTALL

l To uninstall an existing MicroStrategy Update installation:

install.Operation=HOTFIX_UNINSTALL

MicroStrategy Install Locations

The install locations of the product. Specify valid directories where the
product should be installed. For additional requirements when choosing
directories, see Installing with the MicroStrategy Installation Wizard for
Linux, page 187.

l Home directory: The location where the MicroStrategy configuration files

and application launchers are to be installed.

suite.homeDirectory=<Path>

l Install directory: The location where the MicroStrategy products are to be

installed.

suite.installDirectory=<Path>

l Log directory: The location where the MicroStrategy application logs are to
be created.

silent.logDirectory=<Path>

Copyright © 2021 All Rights Reserved 601

In st allat io n an d Co n figu r at io n Gu id e

Product Features
When you install products using an options file, the following two values may
be specified for each product:

l A visible option, which can use one of the following values:

l true: Indicates that the feature is displayed in the MicroStrategy
Installation Wizard as available for installation.

l false: Indicates that the feature is not displayed in the MicroStrategy

Installation Wizard as available for installation. If you define a product's
visible option as false, it cannot be installed.

If no value is specified, the default is true for all products. You can also
define the visible option for all products using the parameter
SelectComponents.visible. You can exclude these visible options for
each product if you are using the options file as part of a completely silent
installation where no user interface is displayed to the user.

l An active option, which can use one of the following values:

l true: Indicates that the feature is selected for installation.
l false: Indicates that the feature is not selected for installation, or the
product is to be uninstalled as part of an installation that modifies or
uninstalls previously installed MicroStrategy software.

To review a description of each MicroStrategy project, see MicroStrategy

Products and Components, page 10.

MicroStrategy Intelligence
l The state of whether MicroStrategy Intelligence is displayed in the
MicroStrategy Installation Wizard:

Intelligence.visible=<Value>

l The selection state of MicroStrategy Intelligence.

Copyright © 2021 All Rights Reserved 602

In st allat io n an d Co n figu r at io n Gu id e

Intelligence.active=<Value>

To select MicroStrategy Intelligence Server for installation, use:

l Intelligence.visible=true

l Intelligence.active=true

MicroStrategy Intelligence Server is installed if you choose to install any of

the following MicroStrategy products:

l MicroStrategy Report Services, page 603

l MicroStrategy OLAP Services, page 604
l MicroStrategy Distribution Services, page 604
l MicroStrategy Transaction Services, page 605

MicroStrategy Report Services

l The state of whether MicroStrategy Report Services is displayed in the
MicroStrategy Installation Wizard:

ReportServices.visible=<Value>

l The selection state of MicroStrategy Report Services.

ReportServices.active=<Value>

l For example, to select MicroStrategy Report Services for installation, use:

ReportServices.visible=true

ReportServices.active=true

Copyright © 2021 All Rights Reserved 603

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy OLAP Services

l The state of whether MicroStrategy OLAP Services is displayed in the
MicroStrategy Installation Wizard:

OLAPServices.visible=<Value>

l The selection state of MicroStrategy OLAP Services.

OLAPServices.active=<Value>

l For example, to select MicroStrategy OLAP Services for installation, use:

OLAPServices.visible=true

OLAPServices.active=true

MicroStrategy Distribution Services

l The state of whether MicroStrategy Distribution Services is displayed in
the MicroStrategy Installation Wizard:

DistributionServices.visible=<Value>

l The selection state of MicroStrategy Distribution Services.

DistributionServices.active=<Value>

l For example, to select MicroStrategy Distribution Services for installation,

use:

DistributionServices.visible=true

DistributionServices.active=true

Copyright © 2021 All Rights Reserved 604

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Transaction Services

l The state of whether MicroStrategy Transaction Services is displayed in
the MicroStrategy Installation Wizard:

TransactionServices.visible=<Value>

l The selection state of MicroStrategy Transaction Services.

TransactionServices.active=<Value>

l For example, to select MicroStrategy Transaction Services for installation,

use:

TransactionServices.visible=true

TransactionServices.active=true

MicroStrategy Web Reporter

l The state of whether MicroStrategy Web Reporter is displayed in the
MicroStrategy Installation Wizard:

WebReporter.visible=<Value>

l The selection state of MicroStrategy Web Reporter.

WebReporter.active=<Value>

l For example, to select MicroStrategy Web Reporter for installation, use:

WebReporter.visible=true

WebReporter.active=true

Copyright © 2021 All Rights Reserved 605

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Web Analyst

l The state of whether MicroStrategy Web Analyst is displayed in the
MicroStrategy Installation Wizard:

WebAnalyst.visible=<Value>

l The selection state of MicroStrategy Web Analyst.

WebAnalyst.active=<Value>

l For example, to select MicroStrategy Web Analyst for installation, use:

WebAnalyst.visible=true

WebAnalyst.active=true

MicroStrategy Web Professional

l The state of whether MicroStrategy Web Professional is displayed in the
MicroStrategy Installation Wizard:

WebProfessional.visible=<Value>

l The selection state of MicroStrategy Web Professional.

WebProfessional.active=<Value>

l For example, to select MicroStrategy Web Professional for installation,

use:

WebProfessional.visible=true

WebProfessional.active=true

Copyright © 2021 All Rights Reserved 606

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Portlets
l The state of whether MicroStrategy Portlets is displayed in the
MicroStrategy Installation Wizard:

Portlets.visible=<Value>

l The selection state of MicroStrategy Portlets.

Portlets.active=<Value>

l For example, to select MicroStrategy Portlets for installation, use:

Portlets.visible=true

Portlets.active=true

MicroStrategy GIS Connectors

l The state of whether MicroStrategy GIS Connectors is displayed in the
MicroStrategy Installation Wizard:

GISConnectors.visible=<Value>

l The selection state of MicroStrategy GIS Connectors.

GISConnectors.active=<Value>

l For example, to select MicroStrategy GIS Connectors for installation, use:

GISConnectors.visible=true

GISConnectors.active=true

MicroStrategy Web Services J2EE

l The state of whether MicroStrategy Web Services J2EE is displayed in the
MicroStrategy Installation Wizard:

Copyright © 2021 All Rights Reserved 607

In st allat io n an d Co n figu r at io n Gu id e

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 installation,

use:

WebServices.visible=true

WebServices.active=true

MicroStrategy Mobile Server JSP

l The state of whether MicroStrategy Mobile Server JSP is displayed in the
MicroStrategy Installation Wizard:

MobileServer.visible=<Value>

l The selection state of Mobile Server JSP.

MobileServer.active=<Value>

l For example, to select MicroStrategy Mobile Server JSP for installation,

use:

MobileServer.visible=true

MobileServer.active=true

MicroStrategy Com m unity Connectors

l The state of whether MicroStrategy Community Connectors is displayed in
the MicroStrategy Installation Wizard:

CommunityConnectors.active=<Value>

Copyright © 2021 All Rights Reserved 608

In st allat io n an d Co n figu r at io n Gu id e

l For example, to select MicroStrategy Community Connectors for

installation, use:

CommunityConnectors.visible=true

CommunityConnectors.active=true

MicroStrategy Com m and Manager

l The state of whether MicroStrategy Command Manager is displayed in the
MicroStrategy Installation Wizard:

CommandManager.visible=<Value>

l The selection state of MicroStrategy Command Manager.

CommandManager.active=<Value>

l For example, to select MicroStrategy Command Manager for installation,

use:

CommandManager.visible=true

CommandManager.active=true

MicroStrategy System Manager

l The state of whether MicroStrategy System Manager is displayed in the
MicroStrategy Installation Wizard:

SystemManager.visible=<Value>

l The selection state of MicroStrategy System Manager.

SystemManager.active=<Value>

l For example, to select MicroStrategy System Manager for installation,

use:

Copyright © 2021 All Rights Reserved 609

In st allat io n an d Co n figu r at io n Gu id e

SystemManager.visible=true

SystemManager.active=true

MicroStrategy Platform Analytics

l The state of whether MicroStrategy Platform Analytics is displayed in the
MicroStrategy Installation Wizard:

PlatformAnalytics.visible=<Value>

l The selection state of MicroStrategy Platform Analytics.

PlatformAnalytics.active=<Value>

l For example, to select MicroStrategy Platform Analytics for installation,

use:

PlatformAnalytics.visible=true

PlatformAnalytics.active=true

MicroStrategy Enterprise Manager

l The state of whether MicroStrategy Enterprise Manager is displayed in the
MicroStrategy Installation Wizard:

EnterpriseManager.visible=<Value>

l The selection state of MicroStrategy Enterprise Manager.

EnterpriseManager.active=<Value>

l For example, to select MicroStrategy Enterprise Manager for installation,

use:

EnterpriseManager.visible=true

Copyright © 2021 All Rights Reserved 610

In st allat io n an d Co n figu r at io n Gu id e

EnterpriseManager.active=true

MicroStrategy Integrity Manager

l The state of whether MicroStrategy Integrity Manager is displayed in the
MicroStrategy Installation Wizard:

IntegrityManager.visible=<Value>

l The selection state of MicroStrategy Integrity Manager.

IntegrityManager.active=<Value>

l For example, to select MicroStrategy Integrity Manager for installation,

use:

IntegrityManager.visible=true

IntegrityManager.active=true

MicroStrategy Telem etry Server

l The state of whether MicroStrategy Telemetry Server is displayed in the
MicroStrategy Installation Wizard:

TelemetryServer.visible=<Value>

l The selection state of MicroStrategy Telemetry Server.

TelemetryServer.active=<Value>

l For example, to select MicroStrategy Telemetry Server for installation,

use:

TelemetryServer.visible=true

TelemetryServer.active=true

Copyright © 2021 All Rights Reserved 611

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Library (Web and Mobile)

l The state of whether MicroStrategy Library is displayed in the
MicroStrategy Installation Wizard:

LibraryWebMobile.visible=<Value>

l The selection state of MicroStrategy Library.

LibraryWebMobile.active=<Value>

l For example, to select MicroStrategy Library for installation, use:

LibraryWebMobile.visible=true

LibraryWebMobile.active=true

MicroStrategy Collaboration
l The state of whether MicroStrategy Collaboration is displayed in the
MicroStrategy Installation Wizard:

Collaboration.visible=<Value>

l The selection state of MicroStrategy Collaboration.

Collaboration.active=<Value>

l For example, to select MicroStrategy Collaboration for installation, use:

Collaboration.visible=true

Collaboration.active=true

Copyright © 2021 All Rights Reserved 612

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy Certificate Store

l The selection state of MicroStrategy Certificate Store.

CertificateStore.active=<Value>

l For example, to select MicroStrategy Certificate Store for installation, use:

CertificateStore.visible=true

CertificateStore.active=true

MicroStrategy Product and Component Installation Locations

You can define the installation locations for the following products and
components:

l MicroStrategy Web Universal Install Location:

WebUniversal.deployDirectory=<Value>

l MicroStrategy Portlets Install Location:

Portlets.installDirectory=<Value>

l MicroStrategy GIS Connectors Install Location:

GISConnectors.installDirectory=<Value>

l MicroStrategy Community Data Connectors

CommunityConnectors.installDirectory=<Value>

l MicroStrategy Web Services J2EE Install Location:

WebServices.installDirectory=<Value>

l MicroStrategy Mobile Server JSP Install Location:

MobileServer.installDirectory=<Value>

Copyright © 2021 All Rights Reserved 613

In st allat io n an d Co n figu r at io n Gu id e

l MicroStrategy Command Manager Install Location:

CommandManager.installDirectory=<Value>

l MicroStrategy System Manager Install Location:

SystemManager.installDirectory=<Value>

l Platform Analytics Install Location:

PlatformAnalytics.installDirectory=<Value>

CPU License Information

This value should be specified when the license being used for
MicroStrategy Intelligence Server is based on CPUs. Legal values are
integers between 1 and either the number of CPUs allowed by the license or
the number of CPUs in the machine, whichever is lower.

cpuCount.number=<Value>

By default, the maximum number of CPUs is allowed. This is represented

with the following value for this parameter:

cpuCount.number=maximum

MicroStrategy Platform Analytics Configuration

Enter your connection parameters for the MySQL database where the
Platform Analytics database was created. You must have a MySQL
warehouse to use Platform Analytics. For more information on prerequisites
for using Platform Analytics, see Prerequisites.

Enter the following information:

Copyright © 2021 All Rights Reserved 614

In st allat io n an d Co n figu r at io n Gu id e

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 reliability, scalability and performance of Platform
Analytics. To cluster the Telemetry Server, set the property
TelemetryServer.cluster.enable to True and provide the hostname
of at least 3 Telemetry Server nodes. One in the
TelemetryServer.cluster.localnode property and the rest in a
comma separated list in TelemetryServer.cluster.remotenodes.

TelemetryServer.cluster.enable=<Value>

TelemetryServer.cluster.localnode=<Value>

TelemetryServer.cluster.remotenodes=<Value>, Value

MicroStrategy Platform Analytics

Connection Parameters to configure the database installed to store system
telemetry:

Copyright © 2021 All Rights Reserved 615

In st allat io n an d Co n figu r at io n Gu id e

l
PlatformAnalytics.DBHost=<Value>

l
PlatformAnalytics.DBPort=<Value>

l
PlatformAnalytics.DBUser=<Value>

l
PlatformAnalytics.DBPassword=<Value>

Topology Configuration
Workstation Topology helps administrators monitor and manage services in
a MicroStrategy environment.

l Indicate a cluster environment. Define this parameter as SINGLE or

MULTIPLE to indicate a single or multiple machine environment. The
default value for this setting is SINGLE.

ServicesRegistration.machine.environment=<Value>

l Provide all Services Registration server host names, separated by

semicolon

ServicesRegistration.serverHosts=<Value>;<Value>

l Load balancer addresses:

Example: http://localhost/MicroStrategyMobile

WebServer.loadBalancer=<Value>

MobileServer.loadBalancer=<Value>

LibraryWebMobile.loadBalancer=<Value>

CollaborationServer.loadBalancer=<Value>

Copyright © 2021 All Rights Reserved 616

In st allat io n an d Co n figu r at io n Gu id e

Registering MicroStrategy Processes as a Service

This setting registers MicroStrategy processes as a service to enable
automatic 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 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.

SelectComponents.visible=<Value>

Install on Demand Options

You can reduce the amount of data that has to be downloaded for the
installation by excluding some of the .tzp files, located in the DataFiles
folder, from the download. You can use this technique to download only the
files required to complete your MicroStrategy installation, which can then
also be used to reduce the amount of data packaged and downloaded for
other MicroStrategy installations.

If you are performing a MicroStrategy installation, you must include all of

the files provided as part of the Update installation in their default location.
This means that you cannot use the options below to point to the location of
the Update installation files.

To reduce the amount of data required for MicroStrategy installations, you

first need to determine the files required to support your installation of

Copyright © 2021 All Rights Reserved 617

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy, as described in Creating Custom Installation Packages, page

133. Once you determine and collect the .tzp files required to support your
MicroStrategy installation, you can specify the location of these files using
the following 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 folder on
the local machine or a server machine. You must also provide the location of the files
using the InstallOnDemand.sourceLocation parameter.
l HTTP: Type this value if the required installation files are stored at an unsecured
URL. You must also provide the location of the files using the
InstallOnDemand.url parameter.
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.url
parameter, as well as the user name and password to access the URL using the
InstallOnDemand.username and InstallOnDemand.password
parameters.
l InstallOnDemand.sourceLocation=<Value>Location of the folder that stores
any required installation files. Type the location of the local file path. If you store the files
in a local folder, do not provide a location for the InstallOnDemand.url parameter.
l InstallOnDemand.url=<Value>Location of the URL for the HTTP or HTTPS
location that stores any required installation files. Type the URL for the location that
stores any required installation files. If you store the files at an HTTP or HTTPS
location, do not provide a location for the InstallOnDemand.sourceLocation
parameter.
l InstallOnDemand.bypassCertificateChecking=<Value>If you retrieve the
installation files from a URL location using HTTPS, you can use this setting to skip any
certificate checking by defining this option to true. To maintain certificate checking,
define this option as false.

Copyright © 2021 All Rights Reserved 618

In st allat io n an d Co n figu r at io n Gu id e

l InstallOnDemand.username=<Value>If you retrieve the installation files from a

URL location, type a user name that has access to the URL location. If there is no login
required to the URL or you retrieve the installation files from a local folder, you do not
need to define a value for this parameter.
l InstallOnDemand.password=<Value>If you retrieve the installation files from a
URL location, type a password for the user name. If there is no login required to the
URL or you retrieve the installation files from a local folder, you do not need to define a
value for this parameter.

Unique Post-Installation Configurations

MicroStrategy supports many different Linux environments with various
system configurations. There are a few cases in which you must perform
some manual configurations to support the use of MicroStrategy on your
system. For more information, see Unique Post-Installation Configurations,
page 210 in Chapter 3, Installing MicroStrategy on Linux.

Silent Installation Output

The installation returns 0 if the installation is successful, and any other
value if it is not. The install.log file in the LogPath directory provides
more information on possible errors. For more information on the
install.log file, see Installation Log File, page 514 in Chapter 2,
Installing MicroStrategy on Windows.

If the installation fails on any of the steps before it starts copying the files, it
does not give any feedback other than the return value different from 0.

Activating a Silent Installation

After the silent installation is complete, you must activate the MicroStrategy
installation within 30 days. To activate the installation you can follow the
instructions provided in Chapter 4, Activating Your Installation.

Copyright © 2021 All Rights Reserved 619

In st allat io n an d Co n figu r at io n Gu id e

Configuring MicroStrategy in Command Line Mode

The MicroStrategy Configuration Wizard is provided in command line mode
so that you can use the Configuration Wizard through the operating system
console if you do not have access to the GUI. Running the Configuration
Wizard in command line mode to configure MicroStrategy on Linux machines
is covered in the Configuring MicroStrategy with a response.ini file, page
642 section in Chapter 11, Configuring MicroStrategy Using Command Line
Tools.

Configuring your MicroStrategy Installation

After completing the steps to install MicroStrategy products, you can set up
and configure your installation. To help guide the rest of your installation
and configuration steps, see Installing and Configuring MicroStrategy on
Linux, page 141 in Chapter 1, Planning Your Installation, for an installation
and configuration checklist.

Copyright © 2021 All Rights Reserved 620

In st allat io n an d Co n figu r at io n Gu id e

D EPLOYIN G OEM
A PPLICATION S

Copyright © 2021 All Rights Reserved 621

In st allat io n an d Co n figu r at io n Gu id e

This chapter explains the common workflow for deploying the MicroStrategy
platform as an Original Equipment Manufacturer (OEM) application.

The MicroStrategy platform can be deployed as an OEM application in

various ways:

l MicroStrategy can be deployed as a software as a service model through

the use of MicroStrategy Web. In this scenario MicroStrategy is installed
and configured at a centralized location using the standard process, and
the customized application is deployed as an OEM application using
MicroStrategy Web. For information on deploying MicroStrategy Web, see
Chapter 6, Deploying MicroStrategy Web and Mobile Server. For
information on customizing MicroStrategy Web, see Customizing
MicroStrategy Web, page 626.
l MicroStrategy can be deployed as part of an OEM software bundle directly
to a customer environment. This chapter focuses on the development and
deployment of this type of OEM application.

The following is a list of best practices on how to deploy MicroStrategy as an

OEM application. Additionally, you can use MicroStrategy System Manager.
System Manager allows you to define multiple configurations for your
MicroStrategy environment that can be executed in a single workflow. For
steps to use System Manager to deploy MicroStrategy configurations, see
the System Administration Help.

l Install MicroStrategy on an OEM environment. For installation information,

see:
l Chapter 2, Installing MicroStrategy on Windows
l Chapter 3, Installing MicroStrategy on Linux
l Create data source connections using the Connectivity Wizard, as
described in Creating DSNs for OEM Environments, page 623.
l Configure MicroStrategy Intelligence Server using the Configuration
Wizard. This tool allows you to save configurations as response files that
can be used to automate the configuration for the OEM deployment. This

Copyright © 2021 All Rights Reserved 622

In st allat io n an d Co n figu r at io n Gu id e

allows you to re-use all the configurations performed when developing an

embedded application for the deployment process as well, as described in
Configuring a MicroStrategy Installation, page 625.
l Design projects and a reporting environment. You can use the various
MicroStrategy products and relevant documentation to create the required
MicroStrategy environment. For additional best practices when designing
a reporting environment, see Designing a Project and Reporting
Environment, page 625.
l Customize MicroStrategy Web through the use of the MicroStrategy SDK,
as described in Customizing MicroStrategy Web, page 626.
l Deploy a MicroStrategy OEM application on an OEM's customer
environment, as described in Deploying a MicroStrategy OEM Application,
page 627.
l Create data source connections on your customer environment as
necessary, as described in Creating DSNs for OEM Environments, page
623.
l Configure and tune an embedded deployment through the use of various
MicroStrategy tools, as described in Tuning an OEM Deployment, page
633.
l If you are modifying a project that has already been deployed as an OEM
application, see Updating OEM Applications, page 634 for best practices
on how to incorporate any custom reports or objects that may have been
created for the deployed application.

Creating DSNs for OEM Environments

Establishing communication between MicroStrategy and your databases or
other data sources is an essential first step in configuring MicroStrategy
products for reporting and analysis of your data. These data sources are
used to store the data warehouse and the MicroStrategy metadata, which
are both required to support a MicroStrategy reporting environment.

Copyright © 2021 All Rights Reserved 623

In st allat io n an d Co n figu r at io n Gu id e

To create a connection to these data sources you need an ODBC driver as

well as a data source name (DSN). MicroStrategy comes packaged with
ODBC drivers to support connecting to various data sources. For more
information on ODBC drivers, see Communicating with Databases, page
373.

When setting up your OEM environment, you must create a separate DSN to
connect to the main data source and the metadata repository. This
requirement is true even if the data source and metadata repository are
stored in the same database or other data source. The main data source and
the metadata are described below:

l A data source stores the data that users of the system can analyze
through BI capabilities offered by MicroStrategy products.
l Metadata is a repository whose data associates the tables and columns of
a data warehouse with user-defined attributes and facts to enable the
mapping of business views, terms, and needs to the underlying database
structure. Metadata can reside on the same server as the data warehouse
or on a different server. It can be also be stored in a different relational
database than your data warehouse. A metadata can be created using the
Configuration Wizard, as described in Configuring a MicroStrategy
Installation, page 625.

A DSN can be created using the MicroStrategy Connectivity Wizard, as

described in Defining DSNs, page 379.

Creating DSNs as Part of an OEM Deployment

As part of the deployment of an OEM application, the Connectivity Wizard
can run unattended to create DSNs on Linux environments. This allows you
to perform this configuration automatically using scripts. For information on
creating ODBC DSNs using the command line version of the Connectivity
Wizard, see Creating a DSN for a Data Source, page 638.

For OEM deployments on Windows machines, use the Connectivity Wizard

interface to create ODBC DSNs, as described in Defining DSNs, page 379.

Copyright © 2021 All Rights Reserved 624

In st allat io n an d Co n figu r at io n Gu id e

Configuring a MicroStrategy Installation

After installing MicroStrategy, you can use the MicroStrategy Configuration
Wizard to configure the metadata repository, statistics tables, History List
tables, MicroStrategy Intelligence Server, and multiple project sources.

The Configuration Wizard interface guides you through each of these

configurations, as described in Initial MicroStrategy configuration, page 385.

In addition, all configurations that are performed using the Configuration

Wizard can be saved as response files. These files can then be used later to
automate much of the initial configuration of MicroStrategy when deploying it
as an OEM application. This allows you to re-use all the configurations
performed when developing an OEM application. For information on
configuring MicroStrategy using a response file, see Configuring
MicroStrategy with a Response File, page 417.

Designing a Project and Reporting Environment

You can use the various MicroStrategy products and relevant documentation
to create the required MicroStrategy reporting environment for your OEM
application. The following best practices can be helpful when creating this
reporting environment:

l It is common to define objects such as reports, documents, attributes,

metrics, and filters that are created for the OEM application so that they
cannot be modified once it is deployed. You can modify the object security
of each object so that it does not allow write access. This ensures that the
reports provided out of the box with the OEM application are not modified
and overwritten. Users can still use Save As to save their own personal
copies of any objects to make any required changes.
l You can modify the folder permissions in MicroStrategy to determine
where reports and objects can be created. Limiting the folders that allow
write access can require users to create reports in their My Reports folder.

Copyright © 2021 All Rights Reserved 625

In st allat io n an d Co n figu r at io n Gu id e

l If you are modifying a project that has already been deployed as an OEM
application, see Updating OEM Applications, page 634 for best practices
on how to incorporate any custom reports or objects that may have been
created for the deployed application.

Customizing MicroStrategy Web

MicroStrategy Web provides users with a highly interactive environment and
a low-maintenance interface for reporting and analysis. Using the
MicroStrategy Web interface, users can access, analyze, and share
corporate data through any web browser on any operating system.

With the MicroStrategy SDK, you can customize, embed, or extend

MicroStrategy Web into your application, or modify the standard interface or
functionality. Common customizations for OEM deployments include:

l Customizing the look and feel of the MicroStrategy Web interface. This
can include changing the color scheme, adding or removing content, using
customized logos, and many other customizations.
l Integrating MicroStrategy Web with third-party applications such as:
l Portals
l External security and user management systems
l Advanced data visualizations
l Extending functionality to support composite applications includes such
things as writeback capabilities and other custom features.

To customize MicroStrategy Web using the MicroStrategy SDK, refer to the

MicroStrategy Developer Library (MSDL). The MSDL contains details about
the architecture, object models, customization scenarios, code samples, and
so on that are useful for building a sophisticated and highly functional,
customized application.

The MicroStrategy SDK and MicroStrategy Developer Library (MSDL) are

not included in the MicroStrategy installation. You can download the

Copyright © 2021 All Rights Reserved 626

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy SDK from the MicroStrategy support site

https://resource.microstrategy.com/msdz/default.asp. Alternately, you can
access the MicroStrategy Developer Library from the MicroStrategy support
site.

Deploying a MicroStrategy OEM Application

After an OEM application is developed, it then must be deployed to the
customer's environment. Steps to deploy an embedded installation include:

1. Installing the required MicroStrategy products on the customer's

environment. This can be automated using silent installation
techniques, as described in OEM Silent Installations, page 627. To use
the Installation Wizard to install MicroStrategy products, see:
l Chapter 2, Installing MicroStrategy on Windows
l Chapter 3, Installing MicroStrategy on Linux
2. Additional configurations are required, as described in Configuring an
OEM deployment installation, page 632.

OEM Silent Installations

You can use silent installation to easily embed MicroStrategy products with
other applications. The steps below show you how to use a silent installation
to deploy an OEM application on a Windows environment. For additional
information on silent installations, see Chapter 8, Automated Installation on
Windows.

You can follow the steps below to perform a silent installation on a Windows
environment. To perform a silent installation on a Linux environment, see
Silent Installation, page 576.

Ensure that the MicroStrategy installation files are accessible on the machine
in which the installation is being performed. If a required installation file is not
accessible, the installation can fail, often providing a warning about missing
requirements.

Copyright © 2021 All Rights Reserved 627

In st allat io n an d Co n figu r at io n Gu id e

To Perform an OEM Silent Installation

When MicroStrategy products are installed as software bundled with another
product, the following procedure is strongly recommended:

1. Create an installation response file (response.ini) for the

MicroStrategy products to install. The table that follows shows which
sections of the file are mandatory and which are optional.

For detailed information regarding the contents of the response.ini

file, see Configuring a response.ini File to Install MicroStrategy, page
516.

Response File Section Selection

[Installer] Required

HideAllDialogs = Required

PreventReboot = Optional

StopAllServices = Optional

StopIIS = Optional

CheckRenameOperations = Optional

[UserRegistration] Required

[ComponentSelection] Required

EnterpriseManagerSelect = Required

[InitialPaths] Required

EnterpriseManager = Required

Setting HideAllDialogs = TRUE causes the script for the response

file to:
l Use default values as specified in the response.ini file.
l Not require user input.

Copyright © 2021 All Rights Reserved 628

In st allat io n an d Co n figu r at io n Gu id e

l Keep the dialog flow consistent from one instance to the next.
Consistency in the response file script from one instance to the next
is necessary; if setup.iss detects an inconsistency in the dialog
flow, installation is terminated and a log file for the failure is created.

The only dialog flow modifications pertinent to silent installation are

specific to file location. Therefore, the only portion of the
response.ini that may need to be modified is the [InitialPaths]
section.

The rest of this procedure assumes you have saved the response.ini
file to the file path C:\. If you save it to another file path, replace
C:\response.ini with the file path of your response.ini file.

You must save the response.ini file as ANSI encoding.

2. Create the setup.iss file to use in conjunction with the

response.ini file for the silent installation. Use a text editor to create
the setup.iss file with the following information:
[InstallShield Silent]
Version=v7.00
File=ResponseFile
[File Transfer]
OverwrittenReadOnly=NoToAll
[Application]
Name=MicroStrategy
Version=x.y.z
#x.y.z represent the version of the MicroStrategy platform
Company=MicroStrategy
Lang=LanguageValue
[{8CCF3F6C-55B7-4A27-8C68-ADF21D0585A2}-DlgOrder]
Count=0

You must save the setup.iss file as ANSI encoding.

The version in the setup.iss file must match the MicroStrategy

version you are installing exactly. For example, if you are installing

Copyright © 2021 All Rights Reserved 629

In st allat io n an d Co n figu r at io n Gu id e

version 10.7.0 you must enter Version=10.7.0. Entering a version

as Version=10 or Version=10.7.x causes an error when trying to
perform a silent installation of version 9.3.0.

For an explanation of the LanguageValue parameter within the line

Lang=LanguageValue, see Language Settings for Silent
Installations, page 631.

3. From the Windows Start menu, select Programs, then select

Accessories, and then right-click Command Prompt and select Run
as Administrator. The User Account Control dialog box opens.

The steps to open a Windows command prompt with administrator

privileges may be different depending on your version of Windows.

4. Click Yes to open the command prompt with administrator privileges.

The command prompt is displayed.

5. Run the silent install with the response.ini file in conjunction with
the setup.iss file as follows:

For an explanation of the LanguageValue parameter, see Language

Settings for Silent Installations, page 631

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 the

installation is to be completely silent. If the -s parameter is not
included in the command, then an interface is displayed during the
installation that shows the progress of the installation.

If the setup program encounters an invalid value for an installation

requirement, the setup terminates and the silent installation is ended.
You can review any errors in the setup.log file.

Copyright © 2021 All Rights Reserved 630

In st allat io n an d Co n figu r at io n Gu id e

6. If a restart is required after the installation is complete, a restart of the

machine is automatically triggered. Power the machine back on to allow
for the completion of any configurations that are required after the
restart of the machine.
7. After the installation is complete, you can check the result of the
installation process. If the silent installation is successful, the resulting
code value is zero (ResultCode=0) in the setup.log file. This is the
only indication of the installation being completed if the installation is
completely silent and a restart of the machine is not required.

Language Settings for Silent Installations

In the final steps of the procedure to run an OEM silent installation:

l You can set MicroStrategy Developer language settings by setting the

language value in the setup.iss file.
l You can bypass the language prompt by running setup.exe with the
command line option for the language.

The following table lists the values for the different languages that
MicroStrategy supports:

Language Value

Danish 0006

Dutch 0019

English 0009

French 0012

German 0007

Italian 0016

Japanese 0017

Copyright © 2021 All Rights Reserved 631

In st allat io n an d Co n figu r at io n Gu id e

Language Value

Korean 0018

Portuguese 0022

Simplified Chinese 2052

Spanish 0010

Swedish 0029

Traditional Chinese 1028

For example, to select English as the language:

l For the setup.iss file, change Lang=LanguageValue to:

Lang=0009

l To run the silent install, use the command line option as follows:

Path\setup.exe -L0009

For the command line option, you must type -L in front of the language code
to signify that you are entering a language.

Configuring an OEM deployment installation

Once MicroStrategy has been installed on the customer's environment, the
following additional steps must be taken to prepare the initial configuration
of MicroStrategy software:

l Provide the MicroStrategy metadata that was developed for the managed
application.
l Create separate DSNs to connect to the data warehouse and the
metadata, as described in Creating DSNs for OEM Environments, page
623.

Copyright © 2021 All Rights Reserved 632

In st allat io n an d Co n figu r at io n Gu id e

l Use the Configuration Wizard to configure metadata, Intelligence Server,

and project sources. If you saved your configurations as response files,
these configurations can be re-used for automated configuration. For
information on using the Configuration Wizard, see Configuring a
MicroStrategy Installation, page 625.
l Configure and tune an OEM deployment through the use of various
MicroStrategy tools, as described in Tuning an OEM Deployment, page
633.

Tuning an OEM Deployment

A MicroStrategy OEM deployment requires additional tuning and
configuration, both during deployment and throughout the life cycle of the
OEM application. Various ways to perform these configurations are
described below:

Tuning with Command Manager

MicroStrategy Command Manager lets you perform various administrative
and application development tasks by using text commands that can be
saved as scripts. You can manage configuration settings within the
MicroStrategy platform, for either project sources or Narrowcast Server
metadatas. With Command Manager, you can change multiple configuration
settings all at once, without using the MicroStrategy Developer or
Narrowcast Administrator interface.

Developers of OEM applications that use embedded MicroStrategy projects

may find that they need flexibility in configuring their environment.
Command Manager Runtime is a slimmed-down version of the Command
Manager command-line executable for use with these OEM applications. For
information about obtaining Command Manager Runtime, contact your
MicroStrategy sales representative.

OEM application deployments typically required on-premises configuration

of environment-specific settings such as database user and password,

Copyright © 2021 All Rights Reserved 633

In st allat io n an d Co n figu r at io n Gu id e

governing options, caching options, and other tuning requirements.

Command Manager Runtime scripts enable OEMs to automate a number of
such configuration settings.

Command Manager Runtime uses a subset of the commands available for

the full version of Command Manager. If you try to execute a script with
statements that are not available in Command Manager Runtime, the script
fails with the message "You are not licensed to run this command." For a list
of the commands available in Command Manager Runtime, with syntax and
examples for each command, refer to the [System Administration Help].

Configuring MicroStrategy in Command Line Mode

The MicroStrategy Configuration Wizard is provided in command line mode
so that you can use the Configuration Wizard through the operating system
console if you do not have access to the GUI. Running the Configuration
Wizard in command line mode to configure MicroStrategy on Linux machines
is covered in Configuring MicroStrategy with a response.ini file, page 642.

Updating OEM Applications

The lifecycle of an OEM application often requires the OEM application to be
updated with new reports and other enhancements. These enhancements
can be developed within the OEM application and then the customer's
existing application can be updated.

For more information on updating OEM applications, see:

Modifying Deployed OEM Applications

If you are modifying a project that has already been deployed as an OEM
application, you must update the application in a way that does not disrupt
any current customer development, as described below:

l Retrieve the customer's metadata so that custom reports or other objects

that have been created can also be included in the OEM application

Copyright © 2021 All Rights Reserved 634

In st allat io n an d Co n figu r at io n Gu id e

update.
l Any new objects deployed as part of the OEM application update should
be tested to ensure that they do not negatively affect the objects provided
with the previous deployment of the OEM application. MicroStrategy
Integrity Manager can be used to automate the testing of including new
objects in an OEM application. For information on Integrity Manager, refer
to the System Administration Help.

Deploying an OEM Application Update

Once updates for an OEM application are complete, the application changes
must then be deployed. There are two ways in which the update can be
deployed, as described below.

Replacing the entire MicroStrategy project in the existing system

Once updates for an OEM application are complete, the project can be
replaced in an OEM application. This is commonly done by duplicating the
updated OEM project, and then merging that project into the production OEM
application.

These tasks can be achieved using the MicroStrategy Project Duplication

Wizard and Project Merge Wizard. Both of these tools can perform their
tasks from the command line, which can allow the project duplication and
replacement process to be automated. The steps to use these tools to
duplicate and replace a project are provided in the System Administration
Help.

Merging modified objects into a project in an OEM application

Once updates for an OEM application are complete, the updates to the
project can be deployed through the use of update packages. An update
package is a file containing a set of object definitions and conflict resolution
rules. When you create an update package, you first add objects, and then
specify how any conflicts involving the objects are resolved.

Copyright © 2021 All Rights Reserved 635

In st allat io n an d Co n figu r at io n Gu id e

These update packages can be developed using Object Manager. Once the
package is ready for deployment, it can be deployed using the graphical
interface with Object Manager or using the unattended execution with
Command Manager Runtime. For information on creating and deploying an
update package with Object Manager, refer to the information on managing
projects provided in the System Administration Help. For information on
Command Manager Runtime, refer to the System Administration Guide.

Copyright © 2021 All Rights Reserved 636

In st allat io n an d Co n figu r at io n Gu id e

CON FIGURIN G
M ICRO STRATEGY U SIN G
COM M AN D L IN E TOOLS

Copyright © 2021 All Rights Reserved 637

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy tools are provided in command line mode on Linux so that you
can perform various configuration tasks through the operating system
console. This enables you to perform your required configurations even if
you do not have access to the MicroStrategy interface.

On a Windows machine, it is recommended to use the appropriate

MicroStrategy interfaces to perform the configurations described in this
chapter.

When you perform MicroStrategy configuration tasks through a Linux

operating system console, you must make sure reserved words and
characters are not mistakenly included in your commands. To avoid issues
caused by reserved words and characters, see Supporting Reserved Words
and Characters, page 668.

This section covers the configurations listed below:

Creating a DSN for a Data Source

After you install an ODBC driver (see Appendix A, Connecting to Databases
and Data Sources), you can define one or more data sources for it. The DSN
should provide a unique description of the data, for example, Payroll_
Project_Metadata or Payroll_Warehouse.

The DSN is the name for a pointer used by a client application (in this case
MicroStrategy) to find and connect to a data source. Multiple DSNs can point
to the same data source and one DSN can be used by different applications.

MicroStrategy provides a one-line command line version of the

MicroStrategy Connectivity Wizard to create DSNs on Linux.

You can create DSNs using the MicroStrategy Connectivity Wizard on

Windows and Linux machines, as described in Communicating with
Databases, page 373.

Copyright © 2021 All Rights Reserved 638

In st allat io n an d Co n figu r at io n Gu id e

To create a DSN on Linux from the command line

1. From a Linux console window, browse to HOME_PATH, where HOME_

PATH is the directory that you specified as the home directory during
installation.
2. Browse to the folder bin.
3. Type mstrconnectwiz -h, and then click Enter to display command
line syntax and examples for different database platforms.

4. Create your command based on the syntax and examples displayed.

For example, the command below creates a DSN for an Oracle
database and tests login credentials:

mstrconnectwiz ORCLW MyOracleDSN 12.34.56.78 orcl 1521 -u:OracleUser -

p:OracleUserPasword

Testing ODBC connectivity

ODBC connectivity is one of two layers of connectivity that are listed in the
next table, along with the associated connectivity testing programs.
Connectivity should be tested from the bottom up—the network layer first
and then the ODBC layer.

Layer Test with

Test ODBC
ODBC driver
mstrtestodbc or mstrtodbcx

Network Simple Network Layer Testing Tool

TCP/IP Ping, PING.EXE , for TCP/IP

The test method described above reflects the situation when the ODBC
driver and the database network software are bundled. If they are not

Copyright © 2021 All Rights Reserved 639

In st allat io n an d Co n figu r at io n Gu id e

bundled, they must be configured and tested separately, using database-

specific tools.

Using the DB Query Tool

The MicroStrategy DB Query Tool is available in Windows, and Linux
Intelligence Server installations. It is used to test and troubleshoot
connectivity to databases, create and execute SQL commands through
ODBC, and run scripts.

Before you use the DB Query Tool, test the network layer with the network
layer utility, PING.EXE. Consult your operating system or network system
documentation for details.

To use the DB Query Tool

1. To use the DB Query Tool:

l On Windows using the DB Query Tool interface, perform the following
step:

From the Windows Start menu, go to Programs > MicroStrategy

Tools > DB Query Tool.

l On Windows from the command line, perform the following steps:

1. From the Windows Start menu, select Run.
2. In the Open drop-down list, type cmd and click OK. A command
prompt opens.
3. Type todbcx.exe and click Enter. Prompts guide you through
testing your ODBC connection from the command line and
should be used in place of the steps below. For detailed steps on
how to use the command line version of this tool, see Testing
ODBC connectivity in Chapter 11, Configuring MicroStrategy
Using Command Line Tools.

Copyright © 2021 All Rights Reserved 640

In st allat io n an d Co n figu r at io n Gu id e

l On Linux using the DB Query Tool interface, perform the following

steps:
1. In a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory
during installation.
2. Browse to the folder bin and type ./mstrdbquerytool, then
click Enter.
l On Linux from the command line, perform the following steps:
1. In a Linux console window, browse to HOME_PATH, where HOME_
PATH is the directory that you specified as the home directory
during installation.
2. Browse to the folder bin and type ./mstrtodbcx, then click
Enter. Prompts guide you through testing your ODBC connection
from the command line and should be used in place of the steps
below. For detailed steps on how to use the command line
version of this tool, see Testing ODBC connectivity in Chapter
11, Configuring MicroStrategy Using Command Line Tools.
2. From the Session menu, select Open Connection, or click the
Connect icon on the toolbar. The Connect dialog box opens. The
connection interface varies depending on the destination database.
3. Select the DSN for a data source.
4. Enter the appropriate user name and password.
5. Click Connect. After your connection is opened, the connection string
is displayed in the MicroStrategy DB Query Tool at the bottom. Your
cursor is inserted automatically in the SQL Statement window.
6. In the SQL Statement window, type a SQL query such as:
select count (*) from Table
where Table is a system-defined table, such as SYSOBJECTS for
Microsoft SQL Server or a MicroStrategy-created table such as
DSSMDSYSPROP in the MicroStrategy metadata.

Copyright © 2021 All Rights Reserved 641

In st allat io n an d Co n figu r at io n Gu id e

7. From the Queries menu, select Execute Query. A table of data from
the database is displayed in the Query Result window.
8. From the Session menu, select Close Connection to close the
database connection.
9. From the File menu, select Exit.

Configuring MicroStrategy with a response.ini file

The MicroStrategy Configuration Wizard is provided in command line mode
so that you can use the Configuration Wizard even if you do not have access
to a GUI. You can perform the following configurations with the
Configuration Wizard in command line mode:

l Create metadata, statistics, and History List tables

l Create new MicroStrategy Intelligence Server definitions in the metadata,
assign an existing server definition for Intelligence Server, and delete
existing server definitions
l Create MicroStrategy project sources in a server (three-tier) mode

Direct (two-tier) data sources are available only on the Windows operating
system.

Using the Configuration Wizard in command line mode creates a

response.ini file. This file can then be used from the command line to
configure MicroStrategy without stepping through the pages of the
Configuration Wizard. You can also distribute a response.ini file to other
users and machines to perform multiple configurations without stepping
through the Configuration Wizard for each configuration.

This section covers the following procedures and information related to

configuring MicroStrategy from the command line on a Linux machine using
a response.ini file:

Copyright © 2021 All Rights Reserved 642

In st allat io n an d Co n figu r at io n Gu id e

l Creating a response.ini File, page 643

l Using the response.ini file to Configure MicroStrategy, page 664
l Parameters and Options in the response.ini File, page 664

You can also configure MicroStrategy using the Configuration Wizard in

command line mode on a Windows machine. However, on a Windows
machine, it is recommended to use the Configuration Wizard graphical user
interface to create and use a response file, which is described in
Configuring MicroStrategy with a Response File, page 417.

Before you can configure MicroStrategy with the Configuration Wizard in

command line mode, you must ensure that you meet the prerequisites listed
in Configuration Wizard Prerequisites, page 386.

Creating a response.ini File

This section describes how to configure MicroStrategy using the command
line mode. Performing the steps in this section creates a response.ini file
that can be used to configure MicroStrategy installations on Linux machines.

To Configure MicroStrategy Using the Command Line Mode

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Browse to the bin directory.
3. At the command prompt, type mstrcfgwiz-editor, then click Enter.
The Configuration Wizard opens in command line mode.
The sections or pages of the wizard displayed depend on your
selections.

4. Click Enter.
5. You can select to use a response.ini file to configure MicroStrategy,
or create a new response.ini file to support a new configuration, as
described below:

Copyright © 2021 All Rights Reserved 643

In st allat io n an d Co n figu r at io n Gu id e

l Type 1, and then click Enter to use a response.ini file to configure

MicroStrategy. For steps to use a response.ini file in command
line mode, see Using the response.ini file to Configure MicroStrategy,
page 664.
l Type 2, and then click Enter to create a new response.ini file.
6. You can support the configuration tasks described in the sections listed
below:
l Type 1 and click Enter to create metadata, History List, and statistics
tables. Refer to Creating Metadata, History List, and Statistics
Tables, page 645 for steps to create metadata tables, History List
tables, and statistics tables.
l Type 2 and click Enter to configure a MicroStrategy Intelligence
Server definition. Refer to To Set Up the MicroStrategy Intelligence
Server, page 653 for steps to configure an Intelligence Server
definition.
l Enter 3 and click Enter to create a Platform Analytics project. Refer
to Creating a Platform Analytics Project for steps to create a Platform
Analytics project.
l Type 4 and click Enter to create project sources. Refer to Creating a
Project Source, page 662 for steps to create project sources.
l Type 5 and click Enter to upgrade your existing environment to
MicroStrategy Analytics Enterprise. View your Intelligence Server
components, Statistics & Enterprise Manager repository, or your
History List repository. You can also upgrade your Enterprise
Manager project or Platform Analytics project. Refer to To Update a
Platform Analytics Project for instructions to update your project.

Copyright © 2021 All Rights Reserved 644

In st allat io n an d Co n figu r at io n Gu id e

Creating Metadata, History List, and Statistics Tables

Creating Metadata, History List, and Statistics tables

If you selected option 1 in Creating a response.ini File, page 643, you can
create metadata tables, History List tables, and statistics tables.

Cr eat i n g M et ad at a Tab l es

If metadata tables already exist in the location you plan to store your
metadata tables in and you do not want to overwrite the current metadata
tables, you should use the option described below.

This procedure assumes you have already opened the Configuration Wizard in
command line mode and selected to create metadata and statistics tables, as
described in Creating a response.ini File.

To Create Metadata Tables

1. In the prompt asking whether to create metadata tables, type Y and

click Enter. You are then prompted for ODBC data source information.
2. Type the number corresponding to the ODBC DSN for the database to
store your metadata tables and click Enter.

If you do not have a DSN defined on your Linux machine, see Creating
a DSN for a Data Source, page 638.

3. If the Configuration Wizard detects an existing metadata repository in

the database location you specified, a message is displayed on whether
to re-create the metadata tables. If you type Y and press Enter, all
information in the existing metadata repository is overwritten when the
response file is executed at a later time.
4. Enter a login and password to your DSN and click Enter.

Copyright © 2021 All Rights Reserved 645

In st allat io n an d Co n figu r at io n Gu id e

5. Enter characters to use as a prefix for the names of your metadata

tables or use no prefix and click Enter.

The next steps depend on your ODBC data source details.

To Configure DB2 MVS Database Options

6. Enter the database name to use or use the default name and click
Enter.
7. Enter characters to use as a table space name for your metadata tables
or use the default table space name and click Enter.

To Select a Metadata Script

8. Select the script used to create the metadata tables or use the default
script and click Enter
9. Type Y and click Enter to create History List tables.
10. Type N and click Enter to skip History List table creation.
11. Type Y and click Enter to create statistics tables.
12. Type N and click Enter to skip statistics tables creation.
13. By default, the configuration is saved as Response.ini in the /HOME_
PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name, and then click Enter.
The response.ini file is generated, and you are prompted whether to
run the configuration immediately.
14. Type Y and click Enter.
15. Type N and click Enter to quit without running the configuration.

Cr eat i n g Hi st o r y Li st Tab l es

This procedure assumes you have already opened the Configuration Wizard in
command line mode and selected to create metadata, History List, and

Copyright © 2021 All Rights Reserved 646

In st allat io n an d Co n figu r at io n Gu id e

statistics tables, as described in Creating a response.ini File, page 643.

1. After you create metadata tables (see To Create Metadata Tables, page
645) or skip the creation of metadata tables, you are prompted to create
History List tables.

To create History List tables, type Y and click Enter.

2. You can supply ODBC DSN information in various ways described

below, which depend on whether you previously created metadata
tables as part of the configuration process:
l If you did not create metadata tables as part of the configuration
process, you are prompted to enter ODBC DSN information. The
steps to enter this information is described in the To Provide ODBC
DSN Information, page 647 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 ODBC
DSN information for your History List tables. You have the following
options:
l Type Y and click Enter to create History List tables with the same
ODBC DSN information entered for your metadata tables. You are
then prompted to select a History List script to create the History
List tables, which is described in the To Select a History List Script,
page 649 section within this procedure.
l Type N and click Enter to provide different ODBC DSN information,
which is described in the To Provide ODBC DSN Information, page
647 section within this procedure.

To Provide ODBC DSN Information

1. Type the number corresponding to the ODBC DSN for a database to

create your History List tables in, and then click Enter.

Copyright © 2021 All Rights Reserved 647

In st allat io n an d Co n figu r at io n Gu id e

If you do not have a DSN defined on your Linux machine, see Creating
a DSN for a Data Source, page 638.

2. Depending on your database type, you may be prompted to provide a

login and password to your DSN:
l Type a login name for your database to create your History List tables
in and click Enter.
l Type a password for the login name provided and click Enter.
3. The next configuration displayed depends on your ODBC data source
details:
l If the data source points to a DB2 MVS database, steps to configure a
DB2 MVS database are displayed. These are described in the To
Configure DB2 MVS Database Options, page 648 section within this
procedure.
l If the data source does not point to a DB2 MVS database, the step to
select a statistics script to create statistics tables is displayed. This
step is described in the To Select a History List Script, page 649
section within this procedure.

To Configure DB2 MVS Database Options

1. You can enter the database name to use or use the default name, as
described below:
l Type the database name to use and click Enter.
l Leave the prompt blank and click Enter to use the default 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 your
metadata tables or use the default table space name, as described
below:
l Type the required table space name characters and click Enter.
l Leave the prompt blank and click Enter to use the default table space
name.

Copyright © 2021 All Rights Reserved 648

In st allat io n an d Co n figu r at io n Gu id e

You are then prompted to select a statistics script to create statistics

tables.

To Select a History List Script

You can select the script used to create the History List tables or use the
default script, as described below:

l Enter a valid path to a script file and click Enter.

l Leave the field blank and click Enter to use the default script for your
database type.

To Create Statistics Tables

l Type Y and click Enter to create statistics tables. Creating statistics tables
is described in Creating Statistics Tables, page 650.
l Type N and click Enter to skip statistics tables creation. You are then
prompted to provide a name for the response.ini file, as described in the
To Generate a response.ini File, page 649 section within this procedure.

To Generate a response.ini File

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name and click Enter. The
response.ini file is generated, and you are prompted whether to run
the configuration immediately.
2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

Copyright © 2021 All Rights Reserved 649

In st allat io n an d Co n figu r at io n Gu id e

l You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.
l Type N and click Enter to quit without running the configuration. You
can use the response.ini file created for future configurations, as
described in Using the response.ini file to Configure MicroStrategy,
page 664.

Cr eat i n g St at i st i cs Tab l es

This procedure assumes you have already opened the Configuration Wizard in
command line mode and selected to create metadata, History List, and
statistics tables, as described in Creating a response.ini File, page 643.

To Create Statistics Tables

1. After you create metadata tables (see To Create Metadata Tables, page
645), create History List tables (Creating History List Tables, page
646), or skip both of these procedures, you are prompted to create
statistics tables.

To create statistics tables, type Y and click Enter.

2. You can supply ODBC DSN information in various ways described

below, which depend on whether you previously created metadata
tables as part of the configuration process:
l If you did not create metadata tables as part of the configuration
process, you are prompted to enter ODBC DSN information. The
steps to enter this information is described in the To Provide ODBC
DSN Information, page 651 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 ODBC
DSN information for your statistics tables. You have the following
options:

Copyright © 2021 All Rights Reserved 650

In st allat io n an d Co n figu r at io n Gu id e

l Type Y and click Enter to create statistics tables with the same
ODBC DSN information entered for your metadata tables. You are
then prompted to select a statistics script to create the statistics
tables, which is described in the To Select a Statistics Script, page
652 section within this procedure.
l Type N and click Enter to provide different ODBC DSN information,
which is described in the To Provide ODBC DSN Information, page
651 section within this procedure.

To Provide ODBC DSN Information

1. Type a valid ODBC DSN for a database to create your statistics tables
in and click Enter. You are then prompted to provide a login to your
DSN.
2. Type a login name for your database to create your statistics tables in
and click Enter. You are then prompted to provide a password for the
login name.
3. Type a password for the login name provided and click Enter.

The next configuration displayed depends on your ODBC data source

details:

l If the data source points to a DB2 MVS database, steps to configure a

DB2 MVS database are displayed. These are described in the To
Configure DB2 MVS Database Options, page 652 section within this
procedure.
l If the data source does not point to a DB2 MVS database, the step to
select a statistics script to create statistics tables is displayed. This
step is described in the To Select a Statistics Script, page 652
section within this procedure.

Copyright © 2021 All Rights Reserved 651

In st allat io n an d Co n figu r at io n Gu id e

To Configure DB2 MVS Database Options

1. You can enter the database name to use or use the default name, as
described below:
l Type the database name to use and click Enter.
l Leave the prompt blank and click Enter to use the default 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 your
metadata tables or use the default table space name, as described
below:
l Type the required table space name characters and click Enter.
l Leave the prompt blank and click Enter to use the default table space
name.

You are then prompted to select a statistics script to create statistics

tables.

To Select a Statistics Script

You can select the script used to create the statistics tables or use the
default script, as described below:

l Enter a valid path to a script file and click Enter.

l Leave the field blank and click Enter to use the default script for your
database type.

You are then prompted to provide a name for the response.ini file.

To Generate a response.ini File

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name and click Enter. The

Copyright © 2021 All Rights Reserved 652

In st allat io n an d Co n figu r at io n Gu id e

response.ini file is generated, and you are prompted whether to run

the configuration immediately.
2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.
l You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.
l Type N and click Enter to quit without running the configuration. You
can use the response.ini file created for future configurations, as
described in Using the response.ini file to Configure MicroStrategy,
page 664.

Setting Up the MicroStrategy Intelligence Server

If you selected option 2 in Creating a response.ini File, page 643, you can
set up MicroStrategy Intelligence Server to create, use, or delete server
definitions. To begin setting up your server definition, you must enter
information 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 to
connect Intelligence Server to. This should be the data source that
stores your metadata. Click Enter. You are then prompted to provide a
login to your DSN.
2. Type a login name for your database to create your statistics tables in
and click Enter. You are then prompted to provide a password for the
login name.
3. Type a password for the login name provided and click Enter. You are
then prompted to provide a metadata prefix.

Copyright © 2021 All Rights Reserved 653

In st allat io n an d Co n figu r at io n Gu id e

4. You can enter characters to use as a prefix for the names of your
metadata tables or use no prefix, as described below:
l Type the required prefix characters and click Enter.

l Leave the prompt blank and click Enter to provide no metadata prefix.

You are then prompted to provide a temp table prefix.

5. You can enter characters to use as a prefix for the names of temp
tables or use no prefix, as described below:
l Type the required prefix characters and click Enter.
l Leave the prompt blank and click Enter to provide no temp table
prefix.

You are then prompted to provide a MicroStrategy user login.

6. Type a valid MicroStrategy user login that has administrator privileges

and click Enter.You are then prompted to provide a password for the
login name.

The default administrator account is Administrator with a blank

password. This should be changed after you initial configuration.

7. Type a password for the MicroStrategy user login provided and click
Enter. You are then prompted to choose the type of Intelligence Server
configuration to complete.
8. You can perform one of the Intelligence Server configuration tasks,
which are described in the sections below:
l Type 1 and click Enter to create a new server definition. Refer to
Creating and Using a Server Definition, page 655 for steps to create a
new server definition.
l Type 2 and click Enter to use an exiting server definition. This
configuration follows the same steps for creating a new server
definition, which are described in Creating and Using a Server
Definition, page 655.

Copyright © 2021 All Rights Reserved 654

In st allat io n an d Co n figu r at io n Gu id e

l Type 3 and click Enter to delete a server definition. Refer to Deleting

a Server Definition, page 657 for steps to delete a server definition.
l Type 4 and click Enter to create a new server definition and use it as
the default server definition. This configuration follows the same
steps for creating a new server definition, which are described in
Creating and Using a Server Definition, page 655.

Cr eat i n g an d Usi n g a Ser ver Def i n i t i o n

You perform the same steps to complete the following actions:

l Create a new server definition

l Create a new server definition and use it as the default server definition
l Use an existing server definition.

The action taken depends on what action you selected to complete in the
procedure Setting Up the MicroStrategy Intelligence Server, page 653.

This procedure assumes you have already opened the Configuration Wizard in
command line mode and entered configuration information for your Intelligence
Server, as described in To Set Up the MicroStrategy Intelligence Server, page
653.

To Create and Use a Server Definition

1. In the prompt that asks for a server definition name, type the name that
distinguishes the server definition and click Enter. You can click Enter
without entering any information to use the default server definition.
You are then prompted to choose the projects to load for the server
definition.
2. Type the names of projects to load when the server definition starts and
click Enter. Separate the project names with the \ character. You are
then prompted to choose projects to not load for the server definition.

Copyright © 2021 All Rights Reserved 655

In st allat io n an d Co n figu r at io n Gu id e

3. Type the names of projects to not load when the server definition starts
and click Enter. Separate the project names with the \ character. You
are then prompted to provide a TCP port to use for Intelligence Server.
4. You can use the default port number or enter a different port number for
Intelligence Server, as described below:
l Leave the prompt blank and click Enter to use the default port
number.
l Type a port number and click Enter.
You are then prompted whether to register Intelligence Server as a
service.

5. You can choose whether to register Intelligence Server as a service, as

described below:
l Type Y and click Enter to register Intelligence Server as a service. To
perform this configuration, you must be logged into your Linux
machine with an account that has root level access and permissions.
l Type N and click Enter to not register Intelligence Server as a
service.

You are then prompted whether to start Intelligence Server when

finished

6. Type Y and click Enter to start Intelligence Server after the response
file is executed. You are then prompted to provide a name for the
response.ini file.

To Generate a Response.ini File

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name, and then click Enter.
The response.ini file is generated, and you are prompted whether to
run the configuration immediately.

Copyright © 2021 All Rights Reserved 656

In st allat io n an d Co n figu r at io n Gu id e

2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

l Type N and click Enter to quit without running the configuration. You
can use the response.ini file created for future configurations, as
described in Using the response.ini file to Configure MicroStrategy,
page 664.

Del et i n g a Ser ver Def i n i t i o n

This procedure assumes you have already opened the Configuration Wizard in
command line mode and entered configuration information for your Intelligence
Server, as described in To Set Up the MicroStrategy Intelligence Server, page
653.

In the prompt that asks for server definitions to be removed, type the name
that distinguishes the server definition and click Enter. You can list multiple
server definitions to be deleted, separating server definition names with the
\ character. You are then prompted to provide a name for the
response.ini file.

1. Type the name that distinguishes the server definition in the prompt
that asks for server definitions to be removed. Click Enter.

You can list multiple server definitions to be deleted, separating server

definition names with the \ character.

2. Name the response.ini file.

Copyright © 2021 All Rights Reserved 657

In st allat io n an d Co n figu r at io n Gu id e

To Generate a response.ini File

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name and click Enter. The
response.ini file is generated, and you are prompted whether to run
the configuration immediately.
2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

l Type N and click Enter to quit without running the configuration.

You can use the response.ini file created for future

configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

Creating a Platform Analytics Project

If you selected option 3 in Creating a response.ini File, you can Create a
Platform Analytics Project.

If you choose Create a Platform Analytics Project when a project already

exists, a message appears indicating the project exists and asks if you'd
like to upgrade your Platform Analytics project. Enter y to continue or enter
n to exit. If you choose Upgrade existing environment to MicroStrategy
Analytics Enterprise when a project does not exist, a message appears
indicating the project does not exists and asks if you want to create a new
Platform Analytics project. Enter y to continue or n to exit.

Copyright © 2021 All Rights Reserved 658

In st allat io n an d Co n figu r at io n Gu id e

This procedure assumes you have already opened the Configuration Wizard in
command line mode and selected to create a Platform Analytics project, as
described in Creating a response.ini File, page 643.

To cr eat e a Pl at f o r m An al yt i cs p r o j ect

1. Enter your MicroStrategy username and password to connect to the

Intelligence Server. You must have administrative privileges.
2. If the Configuration Wizard detects an existing Platform Analytics
Project in the metadata, a message is displayed on whether to update
the Platform Analytics project tables. If you type Y and press Enter, all
information in the existing Platform Analytics project tables is
overwritten when the response file 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/PostgreSQL
ODBC DSN for the database to store your Platform Analytics Project
tables and click Enter.

If you do not have a DSN defined on your Linux machine, see Creating
a DSN for a Data Source.

6. Enter the login and password to your DSN and click Enter.

7. Enter characters to use as a prefix for the names of your metadata

tables or use no prefix and click Enter.

The Configuration Wizard automatically applies the following

configuration files:

l PlatformAnalyticsConfigurationNew.scp
l PlatformAnalyticsConfigurationNew_PostgreSQL.scp
l PlatformAnalyticsConfigurationUpgrade.scp
l PlatformAnalyticsConfigurationUpgrade_PostgreSQL.scp

Copyright © 2021 All Rights Reserved 659

In st allat io n an d Co n figu r at io n Gu id e

8. If an error appears about being unable to automatically apply project

settings to Platform Analtyics, you must manually update the project
settings. For instructions, see Configure the Platform Analytics Project.

To Gen er at e a r esp o n se.i n i Fi l e

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name and click Enter. The
response.ini file is generated, and you are prompted whether to run
the configuration immediately.
2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

l Type N and click Enter to quit without running the configuration.

You can use the response.ini file created for future

configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

To Up d at e a Pl at f o r m An al yt i cs Pr o j ect

1. Type 5 in Creating a response.ini File and choose Upgrade Platform

Analytics Project.
2. Enter your MicroStrategy username and password to connect to the
Intelligence Server. You must have administrative privileges.
3. If the Configuration Wizard detects an existing Platform Analytics
Project in the metadata, a message is displayed on whether to update

Copyright © 2021 All Rights Reserved 660

In st allat io n an d Co n figu r at io n Gu id e

the Platform Analytics project tables. If you type Y and press Enter, all
information in the existing Platform Analytics project tables is
overwritten when the response file 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/PostgreSQL
ODBC DSN for the database to store your Platform Analytics Project
tables and click Enter.

If you do not have a DSN defined on your Linux machine, see Creating
a DSN for a Data Source.

7. Enter the login and password to your DSN and click Enter.

8. Enter characters to use as a prefix for the names of your metadata

tables or use no prefix and click Enter.

The Configuration Wizard automatically applies the following

configuration files:

l PlatformAnalyticsConfigurationNew.scp
l PlatformAnalyticsConfigurationNew_PostgreSQL.scp
l PlatformAnalyticsConfigurationUpgrade.scp
l PlatformAnalyticsConfigurationUpgrade_PostgreSQL.scp
9. If an error appears about being unable to automatically apply project
settings to Platform Analtyics, you must manually update the project
settings. For instructions, see Configure the Platform Analytics Project.

To Gen er at e a r esp o n se.i n i Fi l e

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name, and then click Enter.
The response.ini file is generated, and you are prompted whether to

Copyright © 2021 All Rights Reserved 661

In st allat io n an d Co n figu r at io n Gu id e

run the configuration immediately.

2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

l Type N and click Enter to quit without running the configuration.

You can use the response.ini file created for future

configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

Creating a Project Source

If you selected option 4 in Creating a response.ini File, page 643, you can
create 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 the
project source to be created and click Enter. You are then prompted to
provide the Intelligence Server name.
2. Type the Intelligence Server name and click Enter. You can also click
Enter without typing any information to accept the default Intelligence
Server. You are then prompted to provide a TCP port to use for
Intelligence Server.
3. You can use the default port number or enter a different port number for
Intelligence Server, as described below:
l Leave the prompt blank and click Enter to use the default port
number.

Copyright © 2021 All Rights Reserved 662

In st allat io n an d Co n figu r at io n Gu id e

l Type a port number and click Enter.

You are then prompted to define a time interval for a project source
connection time out.

4. Type a numerical value (in minutes) for the amount of inactivity that is
allowed before a user is automatically disconnected from a project
source. This enforces a connection time out for inactive users
connected to a project source. Type 0 to define that users are not
disconnected from project sources due to inactivity. Click Enter.

You are then prompted to select an authentication type for the project
source.

5. You can type the corresponding number to select one of the

authentication types listed in the command line. For information on
each authentication type, see Modes of Authentication in the System
Admin Guide.

You are then prompted to provide a name for the response.ini file.

To Generate a response.ini File

1. By default, the configuration is saved as Response.ini in the /HOME_

PATH/ directory, where HOME_PATH is the directory you specified as
the Home Directory during installation. You can leave the field blank to
use the default name or type a different name and click Enter. The
response.ini file is generated, and you are prompted whether to run
the configuration immediately.
2. You can choose to run the configuration you just completed or to run
the configuration using the response.ini file at a different time, as
described below:
l Type Y and click Enter to run the configuration.

You can also use the response.ini file created for future
configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

Copyright © 2021 All Rights Reserved 663

In st allat io n an d Co n figu r at io n Gu id e

l Type N and click Enter to quit without running the configuration.

You can use the response.ini file created for future

configurations, as described in Using the response.ini file to
Configure MicroStrategy, page 664.

Using the response.ini file to Configure MicroStrategy

This section describes how to use the response.ini file through the
MicroStrategy Configuration Wizard. For information on how to configure
through the MicroStrategy Configuration Wizard, see Creating a response.ini
File, page 643.

1. In a Linux console window, browse to HOME_PATH, where HOME_PATH

is the specified home directory during installation.
2. Browse to the folder bin.

3. Type ./mstrcfgwiz-editor -r ResponseFile, where

ResponseFile is the full qualified path to the response.ini file. For
example:

./mstrcfgwiz-editor -r /home/username/MicroStrategy/response.ini

4. Click Enter.

If the path and the response file are valid, the configuration is performed and
a successful configuration message appears. If an error occurs before or
during the process, an error message displays the error that occurred when
executing the response file.

Parameters and Options in the response.ini File

For a list of all parameters and options available for a response.ini file, see
Response configuration parameters and options, page 421.

Starting, Configuring, and Monitoring Intelligence Server with

mstrsvr
If your Intelligence Server is installed on a Linux machine, you can start,
configure, and monitor your Intelligence Server from the command line with

Copyright © 2021 All Rights Reserved 664

In st allat io n an d Co n figu r at io n Gu id e

mstrsvr. This tool starts Intelligence Server from the command line and
displays the following information about your Intelligence Server connection:

l Intelligence Server version number

l Intelligence Server instance name
l Metadata DSN
l Metadata login
l Intelligence Server definition name
l Port number

You can then perform various configuration and monitoring tasks for your
running Intelligence Server, which includes but is not limited 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 specified as the home directory during
installation.
l Browse to the folder bin.
l Type mstrsvr, and then click Enter.
l Once Intelligence Server is started, general configuration information is
displayed along with all available configuration and monitoring options.

Copyright © 2021 All Rights Reserved 665

In st allat io n an d Co n figu r at io n Gu id e

Perform any configuration and monitoring tasks you require.

l To quit the tool and stop Intelligence Server, type S, and then click Enter.

Configuring the Default Server Instance with mstrsvr-configure

You can configure the default server instance for Intelligence Server using
mstrsvr-configure, which is a wizard-style command line tool that
prompts you for the required information.

1. From a Linux console window, browse to HOME_PATH, where HOME_

PATH is the directory that you specified as the home directory during
installation.
2. Browse to the folder bin.
3. Type mstrsvr-configure, and then click Enter.
4. Type a port number, and then click Enter.
5. Type a DSN, and then click Enter.
6. Type a valid login for the DSN, and then click Enter.
7. Type a valid password for the DSN login, and then click Enter.
8. Type a server definition name, and then click Enter.

Creating and Configuring Intelligence Server Instances with

mstrctl
You can create and configure Intelligence Server instances with the
mstrctl tool. Intelligence Servers running with a particular server definition
are referred to as server instances.

1. From a Linux console window, browse to HOME_PATH, where HOME_

PATH is the directory that you specified as the home directory during
installation.
2. Browse to the folder bin.
3. Enter mstrctl -h and click Enter.
4. Review the help information and run any required configuration tasks.

Copyright © 2021 All Rights Reserved 666

In st allat io n an d Co n figu r at io n Gu id e

There are some commands that can output information to a file, or require a
long definition that can be retrieved from a file. For information on using files
to store output from and provide input to mstrctl commands, see Using
files to store output and provide input, page 667.

You do not need to enter any command to quit the mstrctl tool because it
is a one-line command line tool.

Using files to store output and provide input

With the mstrctl command line tool, you can perform the following tasks:

l Display and modify a server configuration

l Display and modify a service configuration
l Display and modify a server instance configuration

The commands that display the configurations listed above output long XML
definitions to the command line. The commands that modify the
configurations listed above require a long XML definition as input.

Rather than displaying and inputting long XML definitions from the command
line, you can use files to store and provide input for long XML definitions.

• Configuring Intelligence Server with XML files requires extensive

knowledge of the various parameters and values used to define
Intelligence Server configurations. Providing an incorrect XML
definition to configure Intelligence Server can cause errors and
unexpected functionality.

• Prior to using commands to display and modify service configurations

(gsvc and ssvc) you must register Intelligence Server as a service.
You can perform this task by using the rs command for mstrctl. To
register an Intelligence Server as a service on a Linux machine, you
must be logged in with an account that has root user privileges and
permissions.

The following commands can have their output sent to a file:

Copyright © 2021 All Rights Reserved 667

In st allat io n an d Co n figu r at io n Gu id e

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 following command to output the server
instance configuration to an XML file:

mstrctl -s IntelligenceServer gsic > ServerInstance.xml

A ServerInstance.xml file is saved in the current directory.

The following commands can read input from a file:

l ssc: Modifies a server configuration

l ssvc: Modifies a service configuration
l ssic: Modifies a server instance configuration

For example, you can run the following command to modify the server
instance configuration by reading input from an XML file:

mstrctl -s IntelligenceServer ssic < ServerInstance.xml

The XML definition in ServerInstance.xml is used to define the server

instance configuration.

It would be difficult and time consuming to type a complete server, service,

or server instance configuration from the command line. An easier way to
provide this type of configuration is to output the current configuration to a
file, modify the file with a text editor, and then use the file as input to a
command to modify the configuration.

Supporting Reserved Words and Characters

When you perform MicroStrategy configuration tasks through the Linux
operating system console, you must make sure reserved words and
characters are not mistakenly included in your commands.

Copyright © 2021 All Rights Reserved 668

In st allat io n an d Co n figu r at io n Gu id e

Linux operating system consoles use reserved words and characters to

perform various actions. For example, the $ character may perform an action
when included as part of a command executed through the operating system
console. If this character is included in a command to configure, it can cause
the command to fail.

For example, you use the following command to create a DSN to an Oracle
database:

mstrconnectwiz ORCLW $MyOracleDSN 12.34.56.78 orcl 1521 -

u:OracleUser -p:OracleUserPasword

Notice that the name of the DSN begins with the $ character. If this is a
reserved character, the command fails to execute properly.

To avoid this problem, you can place single quotes ('') around any
character strings that may include reserved words or characters. This
prevents the operating system console from interpreting the characters as
an operating system action, and instead includes them as part of the
character string. For example, the same command as above to create a DSN
can be rewritten as follows:

mstrconnectwiz ORCLW '$MyOracleDSN' 12.34.56.78 orcl 1521 -

u:OracleUser -p:OracleUserPasword

This time, the name of the DSN $MyOracleDSN is enclosed by single

quotes, which allows all of the characters to be interpreted as a string of
characters.

Configuring your MicroStrategy Installation

To help guide the rest of your installation and configuration steps, refer to
the section Installing and Configuring MicroStrategy on Linux, page 141 in
Chapter 1, Planning Your Installation, for an installation and configuration
checklist.

Copyright © 2021 All Rights Reserved 669

In st allat io n an d Co n figu r at io n Gu id e

A D D IN G OR REM OVIN G
M ICRO STRATEGY
COM PON EN TS

Copyright © 2021 All Rights Reserved 670

In st allat io n an d Co n figu r at io n Gu id e

This section describes how to add or remove MicroStrategy components on

different operating systems and includes the following:

Adding or Removing MicroStrategy Components on Windows 671

Re-installing MicroStrategy components on Windows 672

Uninstalling MicroStrategy Components on Windows 674

Uninstalling MicroStrategy Components on Linux 677

Adding or Removing MicroStrategy Components on

Windows
If you installed the MicroStrategy components using a disk, you will need
your original installation disk to add or remove MicroStrategy components.

To add or remove MicroStrategy components

1. Close all MicroStrategy products.
2. Open the Microsoft Control Panel and navigate to the options to add or
remove programs. See the Microsoft documentation for steps to access
these options.
3. Within the list of installed programs, select MicroStrategy and click
Change. The MicroStrategy Setup Maintenance program opens.
4. Select Modify and click Next.
5. Select to accept the license agreement and click Next.
6. Verify your customer information and click Next.
7. Select the components to add by clicking their check boxes. Clear the
check boxes for the components you want to uninstall and click Next.

The components that are currently installed are displayed with their
check boxes selected. These components are not re-installed during
the modification process. If you clear any of the check boxes, that

Copyright © 2021 All Rights Reserved 671

In st allat io n an d Co n figu r at io n Gu id e

particular component is uninstalled during the modification process.

You are advised not to clear the check boxes of the components that
are already installed, unless you want to remove the component.

8. If prompted to stop your Web server, click Yes.

9. Verify the settings and click Next.
10. After the modification routine is complete, click Finish. To fully remove
MicroStrategy Office, see Uninstalling MicroStrategy Office, page 676.

For more details on each page of the MicroStrategy Installation Wizard, see
Chapter 2, Installing MicroStrategy on Windows.

Re-installing MicroStrategy components on Windows

You can re-install MicroStrategy components if there are problems with
previously installed components. During re-installation the list of
components previously installed are displayed and these components are
re-installed. If you installed the MicroStrategy components using a disk, you
need your original installation disk to repair the installation.

The re-installation of MicroStrategy Office must be performed separately.

The procedure for re-installing MicroStrategy Office is explained in the
following section.

To re-install MicroStrategy components

1. Close all MicroStrategy products.
2. Open the Microsoft Control Panel and navigate to the options to add or
remove programs. Refer to the appropriate Microsoft documentation for
steps to access these options.
3. Within the list of installed programs, select MicroStrategy and click
Change. The MicroStrategy Setup Maintenance program opens.
4. Select Repair and click Next.
5. Accept the license agreement and click Next.

Copyright © 2021 All Rights Reserved 672

In st allat io n an d Co n figu r at io n Gu id e

6. You are prompted to select Yes to continue with the re-installation

procedure and overwrite the components. If you do not want to
overwrite the components, select No.
7. If prompted to stop your Web server, click Yes to stop it and continue
with the re-installation.
8. After the re-installation routine is complete, click Finish.

For details on each page of the MicroStrategy Installation Wizard, see

Chapter 2, Installing MicroStrategy on Windows.

Re-installing MicroStrategy Office

This information applies to the legacy MicroStrategy Office add-in, the

add-in for Microsoft Office applications which is no longer actively
developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

This section describes the re-installation procedure for MicroStrategy Office

on Windows 7, 8.1, and 10.

To re-install MicroStrategy Office

1. Close all MicroStrategy products.

2. Navigate to the add/remove menus for Windows:

l For Windows 7 or 8.1 users, open the Microsoft Control Panel or

navigate to the options to add or remove programs. See the
appropriate Microsoft documentation for steps to access these

Copyright © 2021 All Rights Reserved 673

In st allat io n an d Co n figu r at io n Gu id e

options.
l For Microsoft Windows 10 users, select Settings under the Start
Menu and navigate to the Apps.

3. In MicroStrategy Office, follow the below instructions for your Windows

version to begin re-installing:

l For Windows 7 or 8.1 users, select MicroStrategy Office and click

Change. The MicroStrategy Office Setup Maintenance program
opens.
l For Windows 10 users, select MicroStrategy Office and click Re-
install. The MicroStrategy Office Setup Maintenance program opens.
4. Select Repair and click Next.
5. Accept the license agreement and click Next.
6. You are prompted to select Yes to continue with the re-installation
procedure and overwrite the components. If you do not want to
overwrite components, select No.
7. If prompted to stop your Web server, click Yes to stop it and continue
with the re-installation.
8. After the re-installation routine is complete, click Finish.

For details on each page of the MicroStrategy Installation Wizard, see

Chapter 2, Installing MicroStrategy on Windows.

Uninstalling MicroStrategy Components on Windows

The uninstallation procedure performs the following functions:

l Unregisters and removes selected files, registry entries, and shortcuts

logged in the Uninst.isu log file.
l Calls a custom DLL to handle unlogged items, such as registry entries and
files.

Before uninstallation begins, the DLL file performs the following functions:

Copyright © 2021 All Rights Reserved 674

In st allat io n an d Co n figu r at io n Gu id e

l Checks for user privileges. If they are not valid, uninstallation stops.
l Checks for running components. If a component is found running,
uninstallation stops.
l Stops and deletes the MicroStrategy Intelligence Server service. This
occurs only when the Intelligence Server is being uninstalled.
l Deletes files created by the application, such as *.log, *.gid, *.ldb
and *.tb.

The uninstallation of MicroStrategy Office must be performed separately.

The procedure for uninstalling MicroStrategy Office is explained in the
following sections.

1. Close all MicroStrategy products.

2. Open the Microsoft Control Panel and navigate to the options to add or
remove programs. See the appropriate Microsoft documentation for
steps to access these options.
3. Within the list of installed programs, select MicroStrategy and click
Change. The MicroStrategy Setup Maintenance program opens.
4. Select Remove and click Next.
5. Click Yes to any prompts that appear.
6. If prompted to stop your Web server, click Yes.
7. After the uninstall is complete, select Yes to restart your computer, or
No to restart it later.
8. Click Finish.

You should restart the computer for a clean uninstall.

Related Topics
KB307710: How to uninstall MicroStrategy Analytics Enterprise using the
Uninstallation Cleanup Utility

Copyright © 2021 All Rights Reserved 675

In st allat io n an d Co n figu r at io n Gu id e

Uninstalling MicroStrategy Office

This information applies to the legacy MicroStrategy Office add-in, the
add-in for Microsoft Office applications which is no longer actively
developed.

It was substituted with a new add-in, MicroStrategy for Office, which

supports Office 365 applications. The initial version does not yet have all
the functionalities of the previous add-in.

For more information, see the MicroStrategy for Office page in the Readme
and the MicroStrategy for Office Help.

This section describes the steps to uninstall MicroStrategy Office for

Windows 7, 8.1, and 10.

1. Close all MicroStrategy products.

2. Navigate to the add/remove menus for Windows:
l For Windows 7 or 8.1 users, open the Microsoft Control Panel or
navigate to the options to add or remove programs. See the
appropriate Microsoft documentation for steps to access these
options.
l For Microsoft Windows 10 users, select Settings under the Start
Menu and navigate to the Apps.
3. In MicroStrategy Office, follow the below instructions for your Windows
version to begin uninstalling:
l For Windows 7 or 8.1 users, select MicroStrategy Office and click
Change.
l For Windows 10 users, select MicroStrategy Office and click
Uninstall.
4. Select Remove and click Next.
5. When prompted, select Yes.
6. Click Finish.

Copyright © 2021 All Rights Reserved 676

In st allat io n an d Co n figu r at io n Gu id e

Uninstalling MicroStrategy Components on Linux

This section discusses how to uninstall MicroStrategy Intelligence Server
and other MicroStrategy products on a Linux platform.

This does not apply to Platform Analytics. The Platform Analytics project
must be 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, where

INSTALL_PATH is the directory you specified as the install directory
during installation.
2. Browse to the /_uninst folder.
3. You can uninstall MicroStrategy products using the MicroStrategy
Installation Wizard or through the command line as described in the
options below:
l To uninstall using the MicroStrategy Installation Wizard, type
./setup.sh and click Enter.
l To uninstall through the command line, type ./setup.sh -console
and click Enter. Follow the command line prompts to complete the
uninstallation process.
4. A dialog box prompts for a language. Specify the language to be used
for the MicroStrategy uninstallation and click OK to proceed to the next
step.
5. The MicroStrategy Installation Wizard opens with the Welcome page
displayed. Click Next. The MicroStrategy Installation Selection page
opens.
6. Select Use an existing installation, and then select the installation
from the drop-down list.
7. From the Selected Operation area, select one of the following
uninstallation options:

Copyright © 2021 All Rights Reserved 677

In st allat io n an d Co n figu r at io n Gu id e

l Modify: Select this option to uninstall only some of the MicroStrategy

products installed on the machine. Click Next.
l Uninstall: Select this option to uninstall all MicroStrategy products
installed on the machine. Click Next.
8. The License Agreement page opens. Review the license agreement and
select I accept the terms of the license agreement, and then click
Next. The Customer Information page opens.
9. Type your user name, company name, and license key for your
installation and click Next. The Select Components page opens.
10. Clear the check box for all MicroStrategy products that are to be
uninstalled, and then click Next.

You can also install products as part of the uninstallation by selecting

the check box for any MicroStrategy product not previously installed.

11. On the Product Uninstallation page, select the products to uninstall.

Click Next.
12. On the Start installer operation page, verify the information and click
Start.
13. After uninstallation is complete, a message is displayed. Click Finish.

Copyright © 2021 All Rights Reserved 678

In st allat io n an d Co n figu r at io n Gu id e

EXPORT EN GIN E
CON FIGURATION

Copyright © 2021 All Rights Reserved 679

In st allat io n an d Co n figu r at io n Gu id e

The following sections include steps for further configuration of the Export
Engine:

Installation of Export Engine

In versions of MicroStrategy prior to 2020, the Export Engine service is
installed automatically by the MicroStrategy installer when selecting to
install the Intelligence Server. The service will use port 20100 by default. In
MicroStrategy 2020, you now have the option to install the Export Engine
service independently of the Intelligence Server.

Windows Installations
For Windows installations prior to MicroStrategy 2020, the Export Engine
service will begin automatically after the Intelligence Server is started or
after installation; however, if the server is restarted, the service must be
started manually. Find and control this service through Windows Task
Manager or Windows services panel, listed as MSTR_PDFExporter.

For Windows installations on MicroStrategy 2020 or later, select the

MicroStrategy Export checkbox to install the Export Engine. This allows you
to install the Export Engine on a stand-alone machine with all other features
unchecked.

Copyright © 2021 All Rights Reserved 680

In st allat io n an d Co n figu r at io n Gu id e

Linux Installations
For Linux installations prior to MicroStrategy 2020, the Export Engine
Service will begin automatically after the Intelligence Server is started or
after installation; however, if the server is restarted, the service must be
started manually. For Linux installations on MicroStrategy 2020 or later, you
can install the Export Engine Service separately from the Intelligence
Server.

The script to start the PDF Exporter service can be found under the path
install/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 Exporter Service.

Copyright © 2021 All Rights Reserved 681

In st allat io n an d Co n figu r at io n Gu id e

Connecting the Intelligence Server to an Export Engine on a

Different Machine
You can configure the Intelligence Server to use an export engine that is
installed on a different machine. You may want to do this if you are using a
dedicated machine for the export engine or if you are using RHEL 6.x for
your Intelligence Server, which does not support the installation of the
export engine. See the Certification dossier for a list of supported export
applications.

To connect the Intelligence Server to an export engine on a different

machine, update the registry on the Intelligence Server machine. No
changes need to be made on the machine that has the export engine
installed.

If Services Registration (Consul) has been installed and your network

settings allows for it, you can rely on Services Registration to discover and
connect to the export engine by removing these entries.

1. Open the registry.

On Windows, open the Registry Editor.

On Linux, navigate to the <HOME_PATH> and open the file

MSIReg.reg.

2. On Windows, navigate to the following location and update the registry

key "host" to the Fully Qualified Name or IP Address of the machine
where the export engine is located.

"[HKEY_LOCAL_
MACHINE\SOFTWARE\WOW6432Node\MicroStrategy\DSS
Server\PDFExporter]":
"host"="localhost"

3. On Linux, edit the host in MSIReg.reg:

Copyright © 2021 All Rights Reserved 682

In st allat io n an d Co n figu r at io n Gu id e

HKEY_LOCAL_MACHINE\SOFTWARE\MicroStrategy\DSS
Server\PDFExporter

host: localhost

4. In the same location, update the registry key "port" to the port
number that is running the export engine service.

During installation, the default value for the service is 20100. To

calculate the port number, use "dword:" and the hexidecimal value of
the decimal to be used.

For example, 00004E84 converted from hexidecimal to decimal is

20100, which gives you the full value of "dword:00004E84" as shown
in the example below:

"[HKEY_LOCAL_
MACHINE\SOFTWARE\WOW6432Node\MicroStrategy\DSS
Server\PDFExporter]":
"port"=dword:00004E84

5. Restart the Intelligence Server.

Export Engine: Puppeteer Integration

The Export Engine for MicroStrategy 2021 uses the headless browser
Puppeteer to export dossiers to PDF. All other formatting requests for
reports and Report Services Documents are performed by the Intelligence
Server.

Puppeteer requires one of the following operating systems:

Windows:

l Server 2016
l Server 2012 R2

Copyright © 2021 All Rights Reserved 683

In st allat io n an d Co n figu r at io n Gu id e

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 Systems

When installing MicroStrategy, the installer will run a check to ensure that all
necessary packages are installed on your machine. You will be notified by
the installer of any missing requirements that are needed.

Chrome Dependencies
The Puppeteer module contains Chrome binary which has certain
dependencies depending on your operating system. Ensure that the
following packages are installed to ensure Chrome binary functions
properly.

RHEL 7 SUSE 12
Chrome Dependency Notes
package Package

libpthread.so.0

libdl.so.2

librt.so.1
glibc glibc
libm.so.6

libc.so.6

ld-linux-x86-64.so.2

libX11.so.6 libX11 libX11-6

libX11-xcb.so.1 libX11 libX11-xcb1

Copyright © 2021 All Rights Reserved 684

In st allat io n an d Co n figu r at io n Gu id e

RHEL 7 SUSE 12
Chrome Dependency Notes
package Package

libxcb.so.1 libxcb libxcb1

libXcomposite.so.1 libXcomposite libXcomposite1

libXcursor.so.1 libXcursor libXcursor1

libXdamage.so.1 libXdamage libXdamage1

libXext.so.6 libXext libXext6

libXfixes.so.3 libXfixes libXfixes3

libXi.so.6 libXi libXi6

libXrender.so.1 libXrender libXrender1

libXtst.so.6 libXtst libXtst6

libgobject-2.0.so.0 glib2 libgobject-2_0-0

libglib-2.0.so.0 glib2 libglib-2_0-0

NSS >= 3.26

libnss3.so nss mozilla-nss
required

libnssutil3.so nss-util mozilla-nss

libsmime3.so nss mozilla-nss

libnspr4.so nspr mozilla-nspr

libcups.so.2 cups-libs cups-libs

libdbus-1.so.3 dbus-libs libdbus-1-3

libexpat.so.1 expat libexpat1

libXss.so.1 libXScrnSaver libXss1

libXrandr.so.2 libXrandr libXrandr2

libgio-2.0.so.0 glib2 libgio-2_0-0

Copyright © 2021 All Rights Reserved 685

In st allat io n an d Co n figu r at io n Gu id e

RHEL 7 SUSE 12
Chrome Dependency Notes
package Package

libasound.so.2 alsa-lib libasound2

libpangocairo-1.0.so.0
pango libpango-1_0-0
libpango-1.0.so.0

libcairo.so.2 cairo libcairo2

libatk-bridge-2.0.so.0 at-spi2-atk libatk-bridge-2_0-0

libgtk-3.so.0 libgdk-
gtk3 libgtk-3-0
3.so.0

libgdk_pixbuf-2_0-
libgdk_pixbuf-2.0.so.0 gdk-pixbuf2
0

libgcc_s.so.1 libgcc libgcc_s1

Additional Packages for Amazon Linux

Amazon Linux is based on RHEL 7 and the dependency list of RHEL 7
mentioned above can be applied to Amazon Linux. However, Amazon Linux
does not contain any graphical library packages (GTK3) in the Yum
repository. These packages must be installed from the CentOS/Fedora Yum
repository.

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 libXScrnSaver-1.2.2-6.fc20.x86_64.rpm

Copyright © 2021 All Rights Reserved 686

In st allat io n an d Co n figu r at io n Gu id e

Missing Package External Resource

libxkbcommon libxkbcommon-0.3.1-1.fc20.x86_64.rpm

libwayland-client libwayland-client-1.2.0-3.fc20.x86_64.rpm

libwayland-cursor libwayland-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 the
application.properties file. The default location is:

l Windows: C:\Program Files (x86)\MicroStrategy\Export

l Linux: /opt/mstr/MicroStrategy/install/Export

Application Core Properties

You must restart the PDF Exporter service if these properties are changed.

Changing any of the below properties will require you to restart NEE, not
just the core properties.

Property Default Value Comments

Used to generate the baseUrl used by

server.host localhost the renderer.

Do not change this value.

server.port 20100 Port number of the service URL.

server.context-
/PDFExporterService Context path of the service URL.
path

Copyright © 2021 All Rights Reserved 687

In st allat io n an d Co n figu r at io n Gu id e

Property Default Value Comments

Maximum memory usage by the service

jvm.heapsize 1024
process in MB.

Subprocess Properties

Default
Property Comments
Value

exporter.renderer.type Puppeteer

1/4 of the
number of Maximum number of renderer
exporter.renderer.process.max
CPU cores. processes.
(Min 2)

Default is
The absolute path of the
exporter.renderer.path the system
renderer.
path.

System
Location of temporary files will
exporter.renderer.file.folder temporary
be saved.
file directory.

The full path of puppeteer.js

exporter.script.path.puppeteer
file. Set by install script.

The full path of node

executable file. Set by install
nodejs.exec
script. If not set, NEE will use
the global installed node.

Copyright © 2021 All Rights Reserved 688

In st allat io n an d Co n figu r at io n Gu id e

Renderer Properties

Default
Property Comments
Value

Time limit in seconds before killing

exporter.renderer.executionTi phantomjs execution. If you change
300
meout this value you must restart the
service.

exporter.renderer.rendering.t Maximum wait time before completing

60
imeout rendering in seconds.

exporter.renderer.resource.ti Maximum wait time for each resource

60
meout request in seconds.

Maximum wait time between two

exporter.resource.idletime 500
resource requests in milliseconds.

Whether to retrieve the web resources

required during exporting from the
export engine.

This property has a higher priority

exporter.internal.web.resourc than exporter.web.url.forced,
false
e exporter.web.url, and
exporter.library.url. If this property
value is set to true, exporter.web.url
and exporter.library.url are not be
used.

Whether exporter.web.url should

exporter.web.url.forced false always be used instead of that from
Intelligence Server.

The URL of the web server which has

Map and D3 plug-ins installed. This is
used to support scheduled export (DS)
exporter.web.url of Map and D3 content.

JSP web server format: http(s)://<host

or

Copyright © 2021 All Rights Reserved 689

In st allat io n an d Co n figu r at io n Gu id e

Default
Property Comments
Value

IP>:<port>/<webAppName>/servlet/m
strWeb

ASP web server format: http(s):

//<host or
IP>:<port>/<webAppName>/asp/Main.
aspx

Library server format: http(s)://<host

exporter.library.url or
IP>:<port>/MicroStrategyLibrary/app/

Whether to save the renderer log to

logging.renderer.kafka true
Kafka.

Logging Properties

Property Default Value Comments

Kafka server IP. If you

logging.kafka.server 127.0.0.1 change this value you must
restart the service.

Kafka server port. If you

logging.kafka.port 9092 change this value you must
restart the service.

Level of log to write to

Kafka. The value of the
property should be error,
logging.level.kafka info
trace, or info. If you change
this value you must restart
the service.

Kafka log file name. If you

logging.kafka.filename NewExportEngine.log
change this value you must

Copyright © 2021 All Rights Reserved 690

In st allat io n an d Co n figu r at io n Gu id e

Property Default Value Comments

restart the service.

The file name created by

file logger. (Fallback
logging.file.filename NewExportEngine.log
logging if kafka is
unavailable.)

Size of log file for file

logging.file.size 2 MB logger.(The fall back logger
when kafka is not available)

Miscellaneous Properties

Property Default Value Comments

Value to limit the number of

exporter.pages.limit 1000 pages generated by the Export
Engine. (-1 indicates no limit).

Maximum JSON length request

exporter.content.limit 200 allowed in MB. The maximum
value of this property is 2048.

Spring Properties

Property Default Value Comments

Whether to enable Spring AOP

spring.aop.auto true auto configuration. Changing
this value is not recommended.

Whether to enable Spring Boot

spring.jmx.enabled true JMX. Changing this value is not
recommended.

logging.file.filename NewExportEngine.log

Copyright © 2021 All Rights Reserved 691

In st allat io n an d Co n figu r at io n Gu id e

Enable Local Resource Loading for the Export Engine

Tthe Export Engine supports redirecting web resource requests to the export
engine side. By default, this feature is disabled. To enable this feature,
follow the steps below.

1. Open the application.properties file and set

exporter.internal.web.resource to true. See Export Engine
Configuration Properties for more information about this setting.

The configuration of the Export Engine service is handled through the

application.properties file. The default location is:

l Windows: C:\Program Files (x86)\MicroStrategy\Export

l Linux: /opt/mstr/MicroStrategy/install/Export
2. Copy all plugins installed in Web to
<PDFExportServiceRootFolder>/resources/plugins.
3. Copy all plugins installed in Library to
<PDFExportServiceRootFolder>/resources/plugins.
4. Check to see if any map keys are configured in
<Web/LibraryRootFolder>/WEB-
INF/xml/config/mapConfig.xml. If they are, copy
mapConfig.xml into
<PDFExportServiceRootFolder>/resources/WEB-
INF/xml/config/mapConfig.xml.

5. If there are any images in <WebFolder>/images or

<WebFolder>/VisFramework, you must copy them into
resources/images and resources/VisFramework in the root
folder of the PDF Export Service.

6. Restart the PDF Export Service.

See knowledge base article 483235 to troubleshoot issues with the export
engine.

Copyright © 2021 All Rights Reserved 692

In st allat io n an d Co n figu r at io n Gu id e

When you install new plugin widgets, you must copy them to
resources/plugins in the Web, Library, and PDF Export Service root
folders.

When you configure map keys for ESRI, Google, or Geospatial Services,
you must copy mapConfig.xml to WEB-INF/xml/config in the Web,
Library, and PDF Export Service root folders.

Configure Secure Communication Between the

Export Engine and Intelligence Server
HTTPS is used to secure communication between the Export Engine service
and Intelligence server.

Enable HTTPS
To enable HTTPS, you need to explicitly set the following property in
application.properties of the Export Engine:

## Whether to enable HTTPS support. Default: false.

server.ssl.enabled=true
## Whether the value of server.ssl.key-store-password is encrypted.
Default: false
password.encrypted=true

The following properties must be correctly configured with the HTTPS

certificate:

## The keystore that contains a private key and a certificate chain. If

HTTPS is enabled, this is required.
server.ssl.key-store=

## The keystore type. It must be either PKCS12 or JKS. Default: PKCS12.

server.ssl.key-store-type=PKCS12

## The keystore password. This is required to decrypt and read the

keystore.

Copyright © 2021 All Rights Reserved 693

In st allat io n an d Co n figu r at io n Gu id e

server.ssl.key-store-password=

## The key alias in the keystore. If HTTPS is enabled, this is required to

find the corresponding key in the keystore.
server.ssl.key-alias=

1. Open application.properties located in <install

path>/Export. For example:
l In Linux:/opt/mstr/MicroStrategy/install/Export/
l In Windows: C:\Program Files
(x86)\MicroStrategy\Export\

2. Add the following parameters to application.properties:

l server.ssl.enabled - Set to true to enable HTTPS.

l server.ssl.key-store - The correct path of the corresponding

certificate. For example,
/home/mstr/Desktop/HTTPS/xxxxx.p12. The administrator
needs to pursue the right certificate to use.

l server.ssl.key-store-type - The value of this parameter (either

PKCS12 or JKS) must be consistent with the certificate type. The
defautl value is PKCS12.

l server.ssl.key-store-password - If the password is not

encrypted, the parameter password.encrypted is set to false. If
you want to encrypt the password, the parameter
password.encrypted must be set to true, and a tool must be used
to get the encrypted password.

In Linux:

1. Run the command ./pdfexporter.sh encrypt to generate

an encrypted password.

Copyright © 2021 All Rights Reserved 694

In st allat io n an d Co n figu r at io n Gu id e

2. Paste the output as the value of server.ssl.key-store-

password and set password.encrypted to true.

In Windows:

1. Run encryptor.bat to generate an encrypted password.

2. Paste the output as the value of server.ssl.key-store-
password and set password.encrypted to true.

l server.ssl.key-alias - When you set the alias of the key when

generating the key, you need to fill in the alias. If you did not set it,
you can comment this parameter.

3. Start the Export Engine service.

If the parameters are correctly configured, the Export Engine service

starts normally. If the startup fails, check NewExportEngine.log to
troubleshoot.

4. Enable HTTPS on the Intelligence server.

A new option is added to the registry under [HKEY_LOCAL_

MACHINE\SOFTWARE\MicroStrategy\DSS Server\PDFExporter]
or [HKEY_LOCAL_
MACHINE\SOFTWARE\WoW6432\MicroStrategy\DSS
Server\PDFExporter].

Default
Key Type Description
Value

If this is set to 1, HTTPS should

be used instead of HTTP to
DWORD
communicate with the Export
https 0 (32-
Engine. As Consul can only return
bit)
an IP address and a port, no
protocol is returned. The

Copyright © 2021 All Rights Reserved 695

In st allat io n an d Co n figu r at io n Gu id e

Default
Key Type Description
Value

IntelligencesServer should read

this value to decide whether
HTTPS should be used.

The Intelligence server will try

connecting to the Export Engine
with this host name. If it does not
host localhost String exist, the Intelligence Server
queries the Export Engine from
Consul. This value should be the
same as the certificate value.

The Intelligence server will try

connecting to the Export Engine
DWORD
with this port number. If it does
port 20100 (32-
not exist, the Intelligence Server
bit)
queries the Export Engine from
Consul.

Bundle of root CA certificates that

the Intelligence server passes to
ssl.ca.location String cURL. It’s used to identify any
HTTPS endpoints, including the
Export Engine.

5. Run a dossier and export to PDF.

Confirm that the PDF export is successful. If export fails, check

NewExportEngine.log and DSSErrors.log to troubleshoot.

Copyright © 2021 All Rights Reserved 696

In st allat io n an d Co n figu r at io n Gu id e

Co n n ect i n g t o Dat ab ases an d

Dat a So u r ces
This appendix describes the configuration parameters required to connect
MicroStrategy to various databases and data sources. Data Source Names
(DSN) can be created using the MicroStrategy Connectivity Wizard, and in
Linux, you can also configure parameters with the odbc.ini file. This
appendix discusses the following topics:

l Creating DSNs for Specific Data Sources, page 697: Configuration

information required to create a DSN for data sources available through
the Connectivity Wizard.
l Creating Database Connections in Web, page 737: Steps to define a new
database connection directly from Web for users to import data from a
data source into MicroStrategy.
l Configuring ODBC Parameters with ODBC.ini, page 740: Configuration
information required to configure data sources using the odbc.ini file in
a Linux environment.
l MicroStrategy Storage Service: Adds a local or remote repository for
Library server.

Creating DSNs for Specific Data Sources

You can create a DSN for data sources available through the Connectivity
Wizard. The following table lists the information required for each type of
data source when you create a new DSN using the Connectivity Wizard. For
information on what operating systems each ODBC driver is certified for, see
Certified ODBC Drivers for MicroStrategy Intelligence Server, page 130.

Copyright © 2021 All Rights Reserved 697

In st allat io n an d Co n figu r at io n Gu id e

l For ODBC-specific driver details, refer to the different ODBC driver

sections below the table.
l You can create a DSN from the command line version of the Connectivity
Wizard in Linux. Browse to HOME_PATH/bin, where HOME_PATH is the
directory you specified as the home directory during installation. In the
console window, type ./mstrconnectwiz -h, then press Enter. This
command displays command line syntax and examples for different
database platforms. Create your command based on the syntax and
examples displayed. Once you run your command, a DSN is created in the
odbc.ini file.

Driver Details

• Data source name

MicroStrategy ODBC Driver
for DB2 Wire Protocol for • Host name
Windows and Linux, page • Database name
702
• Port number

• Data source name

• IP address

MicroStrategy ODBC Driver • Collection

for DB2 Wire Protocol for
• Location
IBM Db2 for i for Windows
and Linux, page 703 • Isolation level

• Package owner

• TCP port (446 in most cases)

• Data source name

MicroStrategy ODBC Driver • IP address

for IBM Db2 for z/OS for
• Collection
Windows and Linux, page
704 • Location

• Package collection

Copyright © 2021 All Rights Reserved 698

In st allat io n an d Co n figu r at io n Gu id e

Driver Details

• Package owner

• TCP port (446 in most cases)

• Data source name

• Host name
MicroStrategy ODBC Driver
for Microsoft SQL Server for • Port number
Windows and Linux, page • Database name
705
• Use Windows NT Authentication for login ID

• Enable SQL Database (Azure) support

• Data source name

MicroStrategy ODBC Driver • Host name
for MongoDB for Windows
and Linux, page 707 • Port number

• Database name

Data source name and either:

Standard connection:

• Host name

• Port number (in most cases, 1521)

MicroStrategy ODBC Driver
for Oracle Wire Protocol for • SID (MicroStrategy default is ORCL)
Windows and Linux, page • Service name
708
• Alternate servers

TNSNames connection:

• Server name

• TNSNames file

MicroStrategy ODBC Driver • Data source name

for SAP Sybase ASE Wire
• Network address
Protocol for Windows and
Linux • Database name

Copyright © 2021 All Rights Reserved 699

In st allat io n an d Co n figu r at io n Gu id e

Driver Details

• Enable unicode support

The MicroStrategy ODBC Driver for SequeLink allows you to

MicroStrategy ODBC Driver access Microsoft Access databases or Microsoft Excel files
for SequeLink, page 711 stored on a Windows machine from an Intelligence Server
hosted on a Linux machine.

The MicroStrategy ODBC Driver for Salesforce allows you to

MicroStrategy ODBC Driver
access resources on Salesforce.com, from an Intelligence
for Salesforce, page 715
Server hosted on a Linux machine.

• Data Source Name

• Server Name
ODBC Driver for Teradata • Authentication Mechanism
for Windows and Linux,
page 716 • Database Name

• Session Character Set

• Enable Data Encryption

• Data Source Name

• Server Name

SnowflakeDSII ODBC Driver • Database Name

for Snowflake Database for
• Schema
Windows and Linux, page
735 • Warehouse

• Role

• Enable SSL 

This section also provides information on how to install and configure

drivers from other vendors with MicroStrategy:

l ODBC Driver for Sybase Adaptive Server IQ for Linux

l ODBC Driver for Informix 8 for Linux, page 717
l ODBC Driver for Netezza for Linux, page 719

Copyright © 2021 All Rights Reserved 700

In st allat io n an d Co n figu r at io n Gu id e

l ODBC Driver for MySQL for Linux, page 721

l ODBC Driver for Aster Database for Linux, page 723
l ODBC Driver for DataDirect Cloud for Linux, page 725
l ODBC Driver for Vertica for Linux, page 727
l ODBC Driver for SAP HANA for Windows and Linux, page 729
l Other Data Sources and Relational Databases for Windows, page 735

MicroStrategy ODBC Driver for Amazon Redshift Wire

Protocol for Windows and Linux
The following information is required for setting up the driver connection for
the MicroStrategy ODBC Driver for Amazon Redshift Wire Protocol:

l Data Source Name: A name to identify the Amazon Redshift data source
configuration in MicroStrategy. For example, Finance or Redshift-1
can serve to identify the connection.
l Host Name: The server name or IP address of the machine on which the
Amazon Redshift data source resides. Contact your system administrator
for the server name or IP address.
l Port Number: The port number for the connection. In most cases, the
default port number is 5439, but you should check with your database
administrator for the correct number.
l Database Name: The name of the database to connect to by default. The
database administrator assigns the database name.
l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.
l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols
that can be used when SSL is enabled.
l ValidatedServerCertificate: Determines whether the driver validates the
certificate that is sent by the database server when SSL encryption is
enabled.

Copyright © 2021 All Rights Reserved 701

In st allat io n an d Co n figu r at io n Gu id e

l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

MicroStrategy ODBC Driver for DB2 Wire Protocol for

Windows and Linux
The following information is required for setting up the driver connection for
MicroStrategy ODBC Driver for DB2 when running against IBM Db2:

l Data Source Name: A name to identify the Db2 data source configuration
in MicroStrategy. For example, Finance or Db2-Serv1 can serve to identify
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 default,
which is assigned by the database administrator.
l Port Number: The Db2 server listener's port number. In most cases, the
default port number is 50000, but check with your database administrator
for the correct number.
l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.
l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols
that can be used when SSL is enabled.
l ValidatedServerCertificate: Determines whether the driver validates the
certificate that is sent by the database server when SSL encryption is
enabled.
l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

Copyright © 2021 All Rights Reserved 702

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy ODBC Driver for DB2 Wire Protocol for IBM Db2
for i for Windows and Linux
The following information is required for setting up the driver connection for
MicroStrategy ODBC Driver for DB2 Wire Protocol for IBM Db2 for i:

l Data Source Name: A name to identify the Db2 data source configuration
in MicroStrategy. For example, Finance or Db2-1 can serve to identify the
connection.
l IP Address: The IP Address of the machine where the catalog tables are
stored. This can be either a numeric address such as 123.456.789.98,
or a host name. If you use a host name, it must be located in the HOSTS
file of the machine or a DNS server.
l Collection: The name that identifies a logical group of database objects.
l Location: The Db2 location name, which is defined during the local Db2
installation.
l Isolation Level: The method by which locks are acquired and released by
the system.
l Package Owner: The package's AuthID if you want to specify a fixed user
to create and modify the packages on the database. The AuthID must have
authority to execute all the SQL in the package.
l TCP Port: The Db2 DRDA listener process's port number on the server
host machine provided by your database administrator. The default port
number is usually 446.
l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.
l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols
that can be used when SSL is enabled.
l ValidatedServerCertificate: Determines whether the driver validates the
certificate that is sent by the database server when SSL encryption is
enabled.

Copyright © 2021 All Rights Reserved 703

In st allat io n an d Co n figu r at io n Gu id e

l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

MicroStrategy ODBC Driver for IBM Db2 for z/OS for Windows
and Linux
The following information is required for setting up the driver connection for
MicroStrategy ODBC Driver for IBM Db2 for z/OS.

l Data Source Name: A name to identify the Db2 z/OS data source
configuration in MicroStrategy. For example, Finance or Db2z/OS-1 can
serve to identify the connection.
l IP Address: The IP Address of the machine where the catalog tables are
stored. This can be either a numeric address such as 123.456.789.98,
or a host name. If you use a host name, it must be located in the HOSTS
file of the machine or a DNS server.
l Collection: The name that identifies a logical group of database objects,
which is also the current schema. On Db2 z/OS, the user ID should be
used as the Collection.
l Location: The Db2 z/OS location name, which is defined during the local
Db2 z/OS installation. To determine the Db2 location, you can run the
command DISPLAY DDF.
l Package Collection: The collection or location name where bind
packages are created and stored for searching purposes.
l Package Owner (Optional): The package's AuthID if you want to specify a
fixed user to create and modify the packages on the database. The AuthID
must have authority to execute all the SQL in the package.
l TCP Port: The Db2 DRDA listener process's port number on the server
host machine provided by your database administrator. The default port
number is usually 446.

Copyright © 2021 All Rights Reserved 704

In st allat io n an d Co n figu r at io n Gu id e

l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.
l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols
that can be used when SSL is enabled.
l ValidatedServerCertificate: Determines whether the driver validates the
certificate that is sent by the database server when SSL encryption is
enabled.
l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

MicroStrategy ODBC Driver for Microsoft SQL Server for

Windows and Linux
The following information is required for setting up the driver connection for
the MicroStrategy-branded version of the Microsoft SQL Server driver:

l Data Source Name: A name to identify the Microsoft SQL Server data
source configuration in MicroStrategy. For example, Personnel or
SQLServer-1 can serve to identify the connection.
l Host Name: Enter the name of a SQL Server on your network. For
example, if your network supports named servers, you can specify an
address such as SQLServer-1. You can also specify the IP address such
as 123.45.678.998. Contact your system administrator for the server
name or IP address.

Additionally, if you use named instances to distinguish SQL Server

databases, you can include the named instance along with either the
server name or IP address using the format
ServerName\NamedInstance or IPAddress\NamedInstance. The
following are examples of providing the server name for your SQL Server
database:

Copyright © 2021 All Rights Reserved 705

In st allat io n an d Co n figu r at io n Gu id e

l SQLServer-1\Instance1
l 123.45.678.998\Instance1
l Port Number: The port number for the connection. The default port
number for SQL Server is usually 1433. Check with your database
administrator for the correct number.

l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.

This option replaces the previous function, Enable Azure. If you want to
use the Enable Azure option, please deselect Validate Server
Certificate.

l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols

that can be used when SSL is enabled.
l ValidatedServerCertificate: Determines whether the driver validates the
certificate that is sent by the database server when SSL encryption is
enabled.
l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.
l Database Name: The name of the database to connect to by default. The
database administrator assigns the database name.
l Use Windows NT Authentication for login ID: This option is available if
you are configuring your connection on Windows. Select this check box to
use Windows NT authentication to pass a user's credentials on the
Windows machine to execute against a SQL Server database.

If you use Windows NT authentication with SQL Server, you must enter the
Windows NT account user name and password in the Service Manager.
For information on the Service Manager, see the System Administration
Help.

Copyright © 2021 All Rights Reserved 706

In st allat io n an d Co n figu r at io n Gu id e

Inserting date data into SQL Server 2000 tables can cause errors if the
system's Regional Settings are not set properly. Ensure that the date
format is defined to be in an English format.

MicroStrategy ODBC Driver for MongoDB for Windows and

Linux
The following information is required for setting up the driver connection for
the MicroStrategy ODBC Driver for MongoDB:

l Data Source Name: A name to identify the MongoDB data source

configuration in MicroStrategy. For example, Finance or MongoDB-1 can
serve to identify the connection.
l Host Name: The server name or IP address of the machine on which the
MongoDB data source resides. Contact your system administrator for the
server name or IP address.
l Port Number: The port number for the connection. Check with your
database administrator for the correct number.
l Database Name: The name of the database to connect to by default. The
database administrator assigns the database name.
l Schema Definition Path: The path where configuration files that define
the relational map of native data are stored. These configuration files are
created in this location when first connecting to the data source and then
used for subsequent connections.
l Enable SSL: The data is encrypted using SSL. If the database server does
not support SSL, the connection fails.
l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

Copyright © 2021 All Rights Reserved 707

In st allat io n an d Co n figu r at io n Gu id e

MicroStrategy ODBC Driver for Oracle Wire Protocol for

Windows and Linux
The following information is required for setting up the driver connection for
MicroStrategy ODBC driver for Oracle Wire Protocol:

l Data Source Name: Enter a name to identify the Oracle data source
configuration in MicroStrategy. For example, Finance or Oracle-1 can
serve to identify the connection. A DSN is required for any Oracle Wire
Protocol connection. Depending on whether you want to use a standard
connection or a TNSNames connection, refer to one of the following lists
of options below:
l Standard Connection: A standard connection is configured through
Oracle Wire Protocol with the following connection parameters:
l Host Name: The name of the Oracle server to be accessed. For
example, the server could be named Oracle-1 or an IP address such as
123.456.789.98.
l Port Number: The Oracle listener port number provided by your
database administrator. The default port number is usually 1521.
l One of the following parameters; which one you choose is up to your
personal preference:
l SID: The Oracle System Identifier for the instance of Oracle running
on the server. The default SID is usually ORCL.
l Service Name: The global database name, which includes the
database name and the domain name. For example, if your database
name is finance and its domain is business.com the service name
is finance.business.com.
l Alternate Servers: A list of alternate database servers to enable
connection failover for the driver. If the primary database server entered
as the SID or service name is unavailable, a connection to the servers in
this list is attempted until a connection can be established. You can list
the servers in SID or service name format, as shown in the following
examples:

Copyright © 2021 All Rights Reserved 708

In st allat io n an d Co n figu r at io n Gu id e

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 Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.

l CryptoProtocolVersion: Specifies a cryptographic protocol or protocols

that can be used when SSL is enabled.

l ValidatedServerCertificate: Determines whether the driver validates the

certificate that is sent by the database server when SSL encryption is
enabled.

l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.

l Host Name in Certificate: Enter a host name for certificate validation

when SSL encryption and validation are enabled.

l TNSNames Connection: A TNSNames connection uses a TNSNAMES.ORA

file to retrieve host, port number, and SID information from a server (alias
or Oracle net service name) listed in the TNSNAMES.ORA file. A
TNSNames connection requires the following parameters:
l Server Name: A server name, which is included in a TNSNAMES.ORA file
included in the TNSNames File text box below.
l TNSNames File: The location of your TNSNAMES.ORA file. Make sure to
enter the entire path to the TNSNAMES.ORA file, including the file name
itself. You can specify multiple TNSNAMES.ORA files.

When connecting to an installation of Oracle as metadata, it is imperative

that the ODBC driver is configured to use the character set parameters as
the Oracle metadata installation. This is controlled through the
IANAAppCodePage option in the odbc.ini file.

Copyright © 2021 All Rights Reserved 709

In st allat io n an d Co n figu r at io n Gu id e

Follow these steps to determine the character set of your Oracle metadata
installation 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 at
http://www.iana.org/assignments/character-sets/character-sets.xhtml.
5. Open the odbc.ini file and set the IANAAppCodePage value to the
assigned MIBenum value from the IANA registry.

MicroStrategy ODBC Driver for PostgreSQL Wire Protocol for

Windows and Linux
The following information is required for setting up the driver connection for
the MicroStrategy ODBC driver for PostgreSQL Wire Protocol:

l Data Source Name: A name to identify the PostgreSQL data source

configuration in MicroStrategy. For example, Finance or PostgreSQL-1
can serve to identify the connection.
l Host Name: The name or IP address of the machine on which the
PostgreSQL database resides. The system administrator or database
administrator assigns the host name.
l Port Number: The port number for the connection. The default port
number for PostgreSQL is usually 5432. Check with your database
administrator for the correct number.
l Database Name: The name of the database to connect to by default. The
database administrator assigns the database name.
l User Name: The name of a valid user for the PostgreSQL database.
l Enable SSL: The data is encrypted using SSL. If the database server
does not support SSL, the connection fails.

Copyright © 2021 All Rights Reserved 710

In st allat io n an d Co n figu r at io n Gu id e

l ValidatedServerCertificate: Determines whether the driver validates the

certificate that is sent by the database server when SSL encryption is
enabled.
l TrustStore: Enter the directory of the truststore file to be used when SSL
is enabled.
l Host Name in Certificate: Enter a host name for certificate validation
when SSL encryption and validation are enabled.

MicroStrategy ODBC Driver for SequeLink

The MicroStrategy ODBC Driver for SequeLink allows you to access
Microsoft Access databases or Microsoft Excel files stored on a Windows
machine from an Intelligence Server hosted on a Linux machine. The steps
below show you how to perform the necessary configurations on the various
machines to support this type of configuration.

Preparing the Microsoft Access Database from an Intelligence

Server Hosted on Linux
You must complete the steps below to access an Access database stored on
a Windows machine from an Intelligence Server hosted on a Linux machine.

On the Windows machine where the Access database is stored, you must
create a DSN to connect to the Access database. For instructions on creating a
DSN, see Creating a DSN for a data source, page 379.

1. On the Windows machine that stores the Access database to connect

to, install the SequeLink ODBC Socket Server. This can be installed as
part of a MicroStrategy installation, and is included in the Other
components options of the MicroStrategy Product Suite (see Select
Components, page 150).

The SequeLink ODBC Socket Server that is provided with a

MicroStrategy installation is for exclusive use with the MicroStrategy

Copyright © 2021 All Rights Reserved 711

In st allat io n an d Co n figu r at io n Gu id e

Product Suite. You are not licensed to use this product with any
application other than MicroStrategy products.

2. On the Windows machine where you installed the SequeLink ODBC

Socket Server, go to the SequeLink Management Console Snap-in.
3. Under Console Root, go to SequeLink 6.0 Manager > Connected to
SLAgent55 > 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-click DataSourceSOCODBCConnStr and select Properties. The
DataSourceSOCODBCConnStr Properties dialog box opens.
8. In the Value field, type DSN=AccessDSN, where AccessDSN is the DSN
you created to connect to your Access database. This is different from
the data source you created as part of the steps to configure the
SequeLink ODBC Socket Server.
9. Click OK.
10. Within the same data source, select User Security.
11. Right click DataSourceLogonMethod and select Properties.
12. From the Value drop-down list, select Anonymous.
13. Click OK.
14. Right-click the data source, point to All Tasks, and select Save
configuration.
15. On the Linux machine that hosts your Intelligence Server, you must
configure the MicroStrategy ODBC driver for SequeLink to connect to
the Access database. For instructions on how to perform this
configuration, see Configuring the MicroStrategy ODBC Driver for
SequeLink, page 714.

Copyright © 2021 All Rights Reserved 712

In st allat io n an d Co n figu r at io n Gu id e

Preparing the Microsoft Excel File from an Intelligence Server

Hosted on Linux
You must complete the steps below to access Excel files stored on a
Windows machine from an Intelligence server hosted on a Linux machine

On the Windows machine where the Excel file is stored, you must prepare the
Excel file as a valid data source. For instructions to prepare an Excel file, see
Prepare an Excel file as a valid data source, page 736.

On the Windows machine where the Excel file is stored, you must create a DSN
to connect to the Excel file. For instructions to create a DSN for an Excel file,
see Use your Excel file as a data source, page 737.

1. On the Windows machine that stores the Excel files to connect to,
install the SequeLink ODBC Socket Server. This can be installed as
part of a MicroStrategy installation, and is included in the Other
components options of the MicroStrategy Product Suite (see Select
Components, page 150).
2. On the Windows machine where you installed the SequeLink ODBC
Socket Server, go to the SequeLink Management Console Snap-In.
3. Under Console Root, expand SequeLink 6.0 Manager, expand
Connected to SLAgent55, expand SequeLink Services, expand
SLSocket55, expand Configuration, and then select Data Source
Settings.
4. From the Action menu, point to New, and select Data Source. A new
data source is created underneath Data Source Settings.
5. Type a descriptive name for the new data source, such as Excel Data
Source.
6. Expand the new data source, and select Advanced.
7. Right-click DataSourceSOCODBCConnStr and select Properties. The
DataSourceSOCODBCConnStr Properties dialog box opens.
8. In the Value field, type DSN=ExcelDSN, where ExcelDSN is the DSN
you created to connect to your Excel file. This is different from that data

Copyright © 2021 All Rights Reserved 713

In st allat io n an d Co n figu r at io n Gu id e

source you created as part of the steps to configure the SequeLink

ODBC Socket Server.
9. Click OK.
10. Within the same data source, select User Security.
11. Right click DataSourceLogonMethod and select Properties. The
DataSourceLogonMethod Properties dialog box opens.
12. From the Value drop-down list, select Anonymous. This allows
connection to the Excel file without using a user name and password.
13. Click OK.
14. Right-click the data source, point to All Tasks, and select Save
configuration.
15. On the Linux machine that hosts your Intelligence Server, you must
configure the MicroStrategy ODBC driver for SequeLink to connect to
the Excel files. For instructions on how to perform this configuration,
see Configuring the MicroStrategy ODBC Driver for SequeLink, page
714.

Configuring the MicroStrategy ODBC Driver for SequeLink

The steps below show you how to configure the MicroStrategy ODBC driver
for SequeLink to access either Microsoft Access databases or Excel files
stored on a Windows machine:

1. On the Linux machine that hosts Intelligence Server, browse to HOME_

PATH where HOME_PATH is the directory you specified as the Home
Directory during installation.
2. Open the odbc.ini.example file and find the section that starts with
[SequeLinkODBC]. Copy this section into the odbc.ini file. For
information on the parameters, refer to DataDirect's documentation at
http://media.datadirect.com/download/docs/odbc/allodbc/help.html.

Copyright © 2021 All Rights Reserved 714

In st allat io n an d Co n figu r at io n Gu id e

3. Edit the parameters listed below:

l Host: Type the IP address of the Windows machine that stores the
Access database or Excel files.
l ServerDataSource: Type the name of the data source for the Access
database or Excel file to connect to as a data source. This is the
name of the data source that you defined while configuring the
SequeLink ODBC Socket Server, as shown in the example image
below:

4. Save the odbc.ini file.

5. Restart Intelligence Server.

MicroStrategy ODBC Driver for Salesforce

The MicroStrategy ODBC Driver for Salesforce allows you to access
resources on Salesforce.com, from an Intelligence Server hosted on a
Windows or Linux machine.

You can also use MicroStrategy Web and Import Data to integrate
Salesforce.com data into MicroStrategy. For steps to configure a connection
to Salesforce.com to support this type of integration, see Configuring Third-
Party Data Sources for Importing Data, page 499.

Copyright © 2021 All Rights Reserved 715

In st allat io n an d Co n figu r at io n Gu id e

The following information is required for setting up the driver connection for
the MicroStrategy ODBC driver for Salesforce:

l Data Source Name: A name to identify the Salesforce data source

configuration in MicroStrategy. For example, Finance or Salesforce-1 can
serve to identify the connection.
l Host Name: The URL used to log in to the Salesforce.com system. You
can keep the default of login.salesforce.com to connect to the production
instance. However, you can also connect to other systems such as
test.salesforce.com if you are connecting to testing environments.

If you attempt to test the connection to your Salesforce.com system, the

password syntax is PasswordSecuritytoken, where Password is the
password for the user account and Securitytoken is the additional
security token required to access Salesforce.com. Do not use any spaces or
other characters to separate the password and security token. As part of
configuring a connection to your Salesforce.com system, you can include the
password and security token as part of the database login, which is a
component of a database instance used to access the DSN in MicroStrategy.
For steps to create a database login, which you can use to provide the
Salesforce.com password and security token, see Creating a database login.

ODBC Driver for Teradata for Windows and Linux

The following information are required for setting up the driver connection
for Teradata ODBC Driver when running against Teradata:

l Data Source Name: A name to identify the Teradata data source

configuration in MicroStrategy. For example, Finance or Teradata can
serve to identify the connection.
l Server Name: The IP Address or the name of the machine that runs the
Teradata server.
l Authentication Mechanism: The method by which the user will be
authenticated.

Copyright © 2021 All Rights Reserved 716

In st allat io n an d Co n figu r at io n Gu id e

l Database Name: The name of the database to connect to by default,

which is assigned by the database administrator.
l Session Character Set: The character set to use for the session. Default
value is UTF8.
l Enable Data Encryption: Whether the driver encrypts data and
communicates with the Teradata gateway using encryption.

ODBC Driver for Informix 8 for Linux

The MicroStrategy ODBC Driver for Informix 8 is already installed in the
INSTALL_PATH/lib directory.

The ODBC Driver for Informix 8 for Linux is a MicroStrategy-branded ODBC

driver, but it is not accessible through the Connectivity Wizard.

However, the Informix Client Software Developer's Kit (CSDK) must be

installed before you create a DSN. This software is not included in the
MicroStrategy product suite installation and must be obtained through the
database vendor or a third party. For information on installation, refer to the
product documentation provided directly by the database vendor.

The following steps show how to configure the MicroStrategy ODBC driver
for Informix 8.

To configure ODBC Driver for Informix 8

Begin by installing the Informix CSDK.

The directory where CSDK is installed should always be accessible to

Intelligence Server.

The following set of instructions are divided into two sections: how to
configure the environment and how to configure a DSN.

Copyright © 2021 All Rights Reserved 717

In st allat io n an d Co n figu r at io n Gu id e

To Configure the Environm ent

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.Browse to the folder
env.
2. Add Write privileges to the ODBC.sh file by entering the following
command:
chmod u+w ODBC.sh

3. Edit the ODBC.sh file and make the following changes:

l Provide the location of the directory where the Informix Client
Software Developer's Kit (CSDK) is installed. The following definition
is included:

INFORMIXDIR='<INFORMIXDIR>'

Replace this <INFORMIXDIR> placeholder with the directory path. Do

not modify any other occurrences of <INFORMIXDIR> within
odbc.sh.

l Provide the name of the Informix Server. The following definition is

included:

INFORMIXSERVER='<INFORMIXSERVER>'

Replace this <INFORMIXSERVER> placeholder with the directory

path.

This value is chosen from the list in <INFORMIXDIR>/etc/sqlhosts.

Do not modify any other occurrences of <INFORMIXSERVER>

within odbc.sh.

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:
chmod a-w ODBC.sh

Copyright © 2021 All Rights Reserved 718

In st allat io n an d Co n figu r at io n Gu id e

To Configure a DSN

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Open the odbc.ini.example file and search for the section that
starts with [IBM INFORMIX]. Copy the section into the odbc.ini file.
3. Edit the DSN parameters Database, Servername, and Service. For
information on the available parameters, refer to your third-party
Teradata driver documentation. This can often be found along with the
driver installation.
4. Save the odbc.ini file.

For details on these DSN parameters, refer to the product documentation

provided directly by the database vendor.

ODBC Driver for Netezza for Linux

ODBC driver for Netezza is not a MicroStrategy-branded driver. The
following steps show how to configure ODBC driver for Netezza.

You must modify odbcinst.ini file and odbc.ini file to create the DSN
for Netezza.

To Configure ODBC Driver for Netezza

Begin by installing the ODBC Driver for Netezza for the correct operating
system. For information on installation, refer to the product documentation
provided directly by the database vendor.

The directory where Netezza is installed should always be accessible to

MicroStrategy Intelligence Server.

The following set of instructions are divided into two sections: how to modify
the odbcinst.ini file and how to modify the odbc.ini file.

Copyright © 2021 All Rights Reserved 719

In st allat io n an d Co n figu r at io n Gu id e

To Modify the odbcinst.ini File

1. In a Linux console window, browse to HOME_PATH, where HOME_PATH

is the directory you specified as the home directory during installation.
2. Edit the odbcinst.ini file and replace all instances of <NETEZZA_
ODBC_DIR> with the location of the directory where the Netezza ODBC
Driver is installed. An example of this is as follows:

If the original path is:

Driver = /<NETEZZA_ODBC_DIR>/lib64/libnzodbc.so

Then the modified path will be:

Driver = /usr/odbc/netezzahome/lib64/libnzodbc.so

3. Save the odbcinst.ini file.

To Modify the odbc.ini File

1. Open the odbc.ini.example file and search for the section that
starts with [IBM NETEZZA].
2. Open the MicroStrategy odbc.ini file.
3. Copy and paste the contents from the odbc.ini.example file for your
Netezza ODBC driver. You should paste the contents of the DSN
exactly as they appear in the example file.

4. Make the following changes to the copied sample file:

l Modify the driver location to match the location of the installed

Netezza ODBC Driver.
l Change the database, server name, user name, and password, and
any other relevant parameters to match the information for your
database. For information on the available parameters, refer to your
third-party Netezza driver documentation. This can often be found
along with the driver installation.
5. Save the odbc.ini file.

Copyright © 2021 All Rights Reserved 720

In st allat io n an d Co n figu r at io n Gu id e

For details on these DSN parameters, refer to the product documentation

provided by the database vendor.

ODBC Driver for MySQL for Linux

The ODBC driver for MySQL is not a MicroStrategy-branded driver. The
following steps show how to configure the ODBC driver for MySQL, which is
certified for the Linux operating system.

You must modify the odbc.ini file to create the DSN for MySQL.

The third-party product(s) discussed in the procedure below is

manufactured by vendors independent of MicroStrategy. MicroStrategy
makes no warranty, express, implied or otherwise, regarding this product,
including its performance or reliability.

To configure ODBC driver for MySQL

Begin by installing the 64-bit ODBC Driver for MySQL for the Linux operating
system, found at the hyperlink
http://dev.mysql.com/downloads/connector/odbc/. This site is valid as of the
release of this manual. For information on installation, refer to the product
documentation provided by the database vendor.

l Ensure that the driver files are installed to the /usr/lib directory.
l For exact version numbers of MySQL drivers certified with MicroStrategy,
refer to the MicroStrategy General Information Readme.

The following set of instructions are divided into two sections: how to define
the location of driver files and how to modify the odbc.ini file.

To Define the Location of the Driver Files

1. In a Linux console window, browse to HOME_PATH, where HOME_PATH

is the directory you specified as the Home Directory during installation.
Browse to the folder env.

Copyright © 2021 All Rights Reserved 721

In st allat io n an d Co n figu r at io n Gu id e

2. Add Write privileges to the ODBC.sh file by entering the following

command:
chmod u+w ODBC.sh

3. Edit the ODBC.sh file and provide the location of the directory where
the MySQL driver is installed. Within the ODBC.sh file, the following
definition is included:

MYSQL_PATH='<MYSQL_PATH>'

Replace this <MYSQL_PATH> placeholder with the location of where the

MySQL driver is installed. Do not modify any other occurrences of
<MYSQL_PATH> within odbc.sh.

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:

chmod a-w ODBC.sh

To M odify t he odbc.ini File

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Open the odbc.ini.example file and search for the section that
starts with [MySQL].
3. Open the MicroStrategy odbc.ini file.
4. Copy and paste the contents from the odbc.ini.example file for your
MySQL ODBC driver. You should paste the contents of the DSN exactly
as they appear in the example file.

5. Make the following changes to the copied sample file:

l Modify the <MYSQL_ODBC_DIR> placeholder in the driver location to

match the location of the installed MySQL ODBC Driver.
l Change the database, server name, user name, password, and any
other relevant parameters to match the information for your database.

Copyright © 2021 All Rights Reserved 722

In st allat io n an d Co n figu r at io n Gu id e

For information on the available parameters, refer to your third-party

MySQL driver documentation. This can often be found along with the
driver installation.

Ensure that there is no white space between the equals sign (=) which
separates the parameter and its value.

6. Save the odbc.ini file.

You can test a connection to your MySQL database with the MicroStrategy
DB Query Tool.

This completes the steps to create a DSN and configure an ODBC driver for
MySQL. To create a database instance and database connection, see
Creating a database instance, page 446 and Creating a database
connection, page 450.

ODBC Driver for Aster Database for Linux

The ODBC driver for Aster Database is not a MicroStrategy-branded driver.
The following steps show how to configure the ODBC driver for Aster
Database for Linux.

You must modify the odbc.ini file to create the DSN for Aster.

The third-party product(s) discussed in the procedure below is

manufactured by vendors independent of MicroStrategy. MicroStrategy
makes no warranty, express, implied or otherwise, regarding this product,
including its performance or reliability.

To Configure ODBC Driver for Aster Database

Begin by installing the Aster ODBC Driver for the Linux operating system.
For information on installation, refer to the product documentation provided
by the database vendor.

Copyright © 2021 All Rights Reserved 723

In st allat io n an d Co n figu r at io n Gu id e

l The path to the installation location you choose for the ODBC driver is
used later in this procedure as the value for the Driver parameter in the
odbc.ini file.
l For exact version numbers of Aster drivers certified with MicroStrategy,
refer to the MicroStrategy General Information Readme.

The following set of instructions are divided into two sections: how to
configure the environment and how to modify the odbc.ini file.

To Configure the Environm ent

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation. Browse to the folder
env.
2. Add Write privileges to the ODBC.sh file by entering the following
command:
chmod u+w ODBC.sh

3. Edit the ODBC.sh file and provide the location of the Aster library
installation. Within the ODBC.sh file, the following definition is
included:

ASTER_PATH='<ASTER_PATH>'

Replace this <ASTER_PATH> placeholder with the location of the Aster

library installation. Do not modify any other occurrences of <ASTER_
PATH> within odbc.sh.

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:
chmod a-w ODBC.sh

To Modify the odbc.ini File

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.

Copyright © 2021 All Rights Reserved 724

In st allat io n an d Co n figu r at io n Gu id e

2. Open the odbc.ini.example file and search for the section that
starts with [Aster Database].
3. Open the MicroStrategy odbc.ini file.
4. Copy and paste the contents from the odbc.ini.example file for your
Aster ODBC driver. You should paste the contents of the DSN exactly
as they appear in the example file.
5. Make the following changes to the copied sample file:
l Modify the driver location to match the location of the installed Aster
ODBC Driver.
l Change the database, server name, user name, password, and any
other relevant parameters to match the information for your database.
For information on the available parameters, refer to your third-party
Aster Database driver documentation. This can often be found along
with the driver installation.

Ensure that there is no white space between the equals sign (=) which
separates the parameter and its value.

6. Save the odbc.ini file.

This completes the steps to create a DSN and configure an ODBC driver for
Aster Database.

ODBC Driver for DataDirect Cloud for Linux

The ODBC driver for DataDirect Cloud is not a MicroStrategy-branded
driver. The following steps show how to configure the ODBC driver for
DataDirect Cloud for Linux.

The third-party product(s) discussed in the procedure below is

manufactured by vendors independent of MicroStrategy. MicroStrategy
makes no warranty, express, implied or otherwise, regarding this product,
including its performance or reliability.

Copyright © 2021 All Rights Reserved 725

In st allat io n an d Co n figu r at io n Gu id e

To Configure ODBC Driver for DataDirect Cloud

Begin by installing the DataDirect Cloud ODBC Driver for the Linux
operating system. For information on installation, refer to the product
documentation provided by the database vendor.

l The path to the installation location you choose for the ODBC driver is
used later in this procedure as the value for the Driver parameter in the
odbc.ini file.
l For exact version numbers of DataDirect Cloud drivers certified with
MicroStrategy, refer to the MicroStrategy General Information Readme.

The following set of instructions are divided into two sections: how to
configure the environment and how to modify the odbc.ini file.

To Configure the Environm ent

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.Browse to the folder
env.
2. Add Write privileges to the ODBC.sh file by entering the following
command:
chmod u+w ODBC.sh

3. Edit the ODBC.sh file and provide the location of the DataDirect Cloud
ODBC driver files. Within the ODBC.sh file, the following definition is
included:

DataDirectCloud_PATH='<DataDirectCloud_PATH>'

Replace this <DataDirectCloud_PATH> placeholder with the location

of the DataDirect Cloud ODBC driver files. Do not modify any other
occurrences of <DataDirectCloud_PATH> within odbc.sh.

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:

chmod a-w ODBC.sh

Copyright © 2021 All Rights Reserved 726

In st allat io n an d Co n figu r at io n Gu id e

To Modify the odbc.ini File

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Open the odbc.ini.example file and search for the section that
starts with [DataDirect Cloud].
3. Open the MicroStrategy odbc.ini file.
4. Copy and paste the contents from the odbc.ini.example file for your
DataDirect Cloud ODBC driver. You should paste the contents of the
DSN exactly as they appear in the example file.
5. Make the following changes to the copied sample file:
l Modify the driver location to match the location of the installed
DataDirect Cloud ODBC Driver.
l Change the database, server name, user name, password, and any
other relevant parameters to match the information for your database.
For information on the available parameters, refer to your third-party
DataDirect Cloud driver documentation. This can often be found
along with the driver installation.

Ensure that there is no white space between the equals sign (=) which
separates the parameter and its value.

6. Save the odbc.ini file.

This completes the steps to create a DSN and configure an ODBC driver for
DataDirect Cloud.

ODBC Driver for Vertica for Linux

The ODBC driver for Vertica is not a MicroStrategy-branded driver. The
following steps show how to configure the ODBC driver for Vertica for Linux.

You must modify the odbc.ini file to create the DSN for Vertica.

The third-party product(s) discussed in the procedure below is

manufactured by vendors independent of MicroStrategy. MicroStrategy

Copyright © 2021 All Rights Reserved 727

In st allat io n an d Co n figu r at io n Gu id e

makes no warranty, express, implied or otherwise, regarding this product,

including its performance or reliability.

To Configure ODBC Driver for Vertica

Begin by installing the ODBC Driver for Vertica for the Linux operating
system. For information on installation, refer to the product documentation
provided by the database vendor.

The path to the installation location you choose for the ODBC driver is used
later in this procedure as the value for the Driver parameter in the
odbc.ini file.

The following set of instructions are divided into two sections: how to
configure the environment and how to modify the odbc.ini file.

To Configure the Environm ent

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation. Browse to the folder
env.
2. Add Write privileges to the ODBC.sh file by entering the following
command:
chmod u+w ODBC.sh

3. Edit the ODBC.sh file and provide the location of the vertica.ini file.
Within the ODBC.sh file, the following definition is included:

VERTICAINI='<VERTICAINI_PATH>'

Replace this <VERTICAINI_PATH> placeholder with the location of the

vertica.ini file. Do not modify any other occurrences of
<VERTICAINI_PATH> within odbc.sh.

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:

chmod a-w ODBC.sh

Copyright © 2021 All Rights Reserved 728

In st allat io n an d Co n figu r at io n Gu id e

To Modify the odbc.ini File

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Open the odbc.ini.example file and search for the section that
starts with [HP VERTICA].
3. Open the MicroStrategy odbc.ini file.
4. Copy and paste the contents from the odbc.ini.example file for your
Vertica ODBC driver. You should paste the contents of the DSN exactly
as they appear in the example file.

5. Make the following changes to the copied sample file:

l Modify the driver location to match the location of the installed

Vertica ODBC Driver.
l Change the database, server name, user name, password, and any
other relevant parameters to match the information for your database.
For information on the available parameters, refer to your third-party
Vertica driver documentation. This can often be found along with the
driver installation.

Ensure that there is no white space between the equals sign (=) which
separates the parameter and its value.

6. Save the odbc.ini file.

This completes the steps to create a DSN and configure an ODBC driver for
Vertica.

ODBC Driver for SAP HANA for Windows and Linux

The ODBC driver for SAP HANA is not a MicroStrategy-branded driver. The
following steps show how to configure ODBC driver for SAP HANA.

MicroStrategy recommends that the SAP HANA user account used to create the
database is granted full permissions for the database. If the database user

Copyright © 2021 All Rights Reserved 729

In st allat io n an d Co n figu r at io n Gu id e

account cannot be granted full permissions to the database, you can use the
recommendations listed in Required database permissions to create metadata,
History List, and statistics repositories, page 392 to determine the required
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

theCREATE ANY permission.

To Configure an ODBC Driver for SAP HANA on Windows

1. Install the SAP HANA ODBC driver files on the Windows system that
will host the MicroStrategy Intelligence Server. For specific installation
steps, refer to your third-party SAP documentation.
2. Using the Microsoft ODBC Data Source Administrator, create a data
source name to connect to your SAP HANA data source.

For best practices on using the Microsoft ODBC Data Source

Administrator to create data source names that are to be used in
MicroStrategy, see Managing ODBC and data sources with Microsoft
ODBC Data Source Administrator, page 381.

3. You can use the MicroStrategy DB Query Tool to test whether data can
be retrieved data from your SAP HANA data source. For information on
how to use the MicroStrategy DB Query Tool, see Using the DB Query
Tool, page 640.
4. To use an SAP HANA as a data source, you must create a database
instance in MicroStrategy. For information on creating a database
instance, see Creating a database instance, page 446.

Copyright © 2021 All Rights Reserved 730

In st allat io n an d Co n figu r at io n Gu id e

When creating a database connection, which is part of a database

instance, ensure that you select Non UTF-8 as the character set
encoding for Windows drivers.

This completes the steps for the initial connection to SAP HANA in
MicroStrategy for Windows environments. For additional configuration
requirements, see Additional Requirements to Support SAP HANA, page
734.

To Configure an ODBC Driver for SAP HANA on Linux

Begin by installing the SAP HANA ODBC driver files on the Linux system
that will host the MicroStrategy Intelligence Server. For specific installation
steps, refer to your third-party SAP documentation.

The following set of instructions are divided into two sections: how to
configure your environment and how to configure a DSN.

To Configure the Environm ent

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.Browse to the folder
env.
2. Add Write privileges to the ODBC.sh file by entering the following
command:
chmod u+w ODBC.sh

3. Edit the odbc.sh file and provide the location where you installed the
SAP HANA ODBC driver files. Within the ODBC.sh file, the following
definition is included:

SAPHANA_PATH='<SAPHANA_PATH>'

Replace this <SAPHANA_PATH> placeholder with the location of the

SAP HANA ODBC driver files. Do not modify any other occurrences of
<SAPHANA_PATH> within odbc.sh.

Copyright © 2021 All Rights Reserved 731

In st allat io n an d Co n figu r at io n Gu id e

4. Save the ODBC.sh file and remove Write privileges from the file by
entering the following command:
chmod a-w ODBC.sh

To Configure a DSN

1. In a Linux console window, browse to HOME_PATH where HOME_PATH is

the specified home directory during installation.
2. Open the odbc.ini.example file and find the section that starts with
[SAP HANA]. Copy the section into the odbc.ini file.

3. Edit the following information from the syntax that you copied to
odbc.ini:

l Driver=<SAPHANA_PATH>/libodbcHDB.so

Replace <SAPHANA_PATH> with the location where you installed the

SAP HANA ODBC driver files.

l Servernode=ip_address:port

Replace ip_address with the IP address for the machine that hosts
the SAP HANA database.

Replace port with the port number for the connection to the SAP
HANA database. Contact your SAP HANA database administrator for
the required port number.

l USER=uid

Replace uid with a valid SAP HANA user account.

l PASSWORD=pwd

Replace pwd with the password for the SAP HANA user account
described above.

Copyright © 2021 All Rights Reserved 732

In st allat io n an d Co n figu r at io n Gu id e

For information on the available parameters, refer to your third-party

SAP HANA driver documentation. This can often be found along with
the driver installation.

4. Save the odbc.ini file.

5. You can use the MicroStrategy DB Query Tool to test whether data can
be retrieved data from your SAP HANA data source. For information on
how to use the MicroStrategy DB Query Tool, see Using the DB Query
Tool, page 640.
6. To use an SAP HANA as a data source, you must create a database
instance in MicroStrategy. For information on creating a database
instance, see Creating a database instance, page 446.

When creating a database connection, which is part of a database

instance, for SAP HANA, ensure that you select Non UTF-8 as the
character set encoding for Linux drivers.

This completes the steps for the initial connection to SAP HANA in
MicroStrategy for Windows environments. For additional configuration
requirements, see Additional Requirements to Support SAP HANA, page 734
below.

To Configure a DSN-less Connection

To configure the ODBC driver for DSN-less connection, an additional step is

required along with the steps in the To Configure a DSN section above.

1. Open the odbcinst.ini file and find this section:

[HDBODBC]
Driver=<SAP_HANA_ODBC_DIR>/libodbcHDB.so
Description=HANA Driver
Setup=<SAP_HANA_ODBC_DIR>/libodbcHDB.so
CPTimeout=0

Copyright © 2021 All Rights Reserved 733

In st allat io n an d Co n figu r at io n Gu id e

2. Replace the <SAP_HANA_ODBC_DIR> placeholder with the location

where you installed the SAP HANA ODBC driver files. The path is the
same as specified in the odbc.ini file.
3. Restart the Intelligence Server.

Additional Requirements to Support SAP HANA

Review the following additional requirements to ensure a successful
integration of SAP HANA in MicroStrategy:

l Be aware that once you import tables from SAP HANA into MicroStrategy,
you must manually import any prefix information as well. Using the
Warehouse Catalog, you can select all tables imported from SAP HANA
and select Import Prefix to import the prefix information. For additional
steps to access and use the Warehouse Catalog, see the Project Design
Help.
l If the tables in SAP HANA include input parameters, these are supported
in MicroStrategy using prompts. Using the Table Editor available in
MicroStrategy Developer, you can create and modify prompts to support
input parameters. For steps to access and use the Table Editor, refer to
the Project Design Help.

OData (CData Driver) ODBC Driver for Windows and Linux

The following information is required for setting up the driver connection for
OData (CData driver) ODBC Driver when running against OData (CData
driver):

l Data Source Name: A name to identify the OData (CData driver) data
source configuration in MicroStrategy. For example, Finance or OData
(CData driver) which can serve to identify the connection.
l Description: The description of what this DSN and the driver is used for.
l Authentication Mechanism: The method by which the user will be
authenticated. Currently, only "Basic Auth" is supported.
l URL: The URL of the OData service of the SAP S/4HANA system.

Copyright © 2021 All Rights Reserved 734

In st allat io n an d Co n figu r at io n Gu id e

l Username: The username of the technical user used to authenticate with

the OData service.
l Password: The password of the technical user used to authenticate with
the OData service.

SnowflakeDSII ODBC Driver for Snowflake Database for

Windows and Linux
The following information is required for setting up the driver connection for
Snowflake ODBC Driver when running against Snowflake:

l Data Source Name: A name to identify the Snowflake data source

configuration in MicroStrategy. For example, Finance or Snowflake
which can serve to identify the connection.
l Server Name: Specifies the hostname for your account.
l Database Name: Specifies the default database to use for sessions
initiated by the driver.
l Schema: Specifies the default schema to use for sessions initiated by the
driver.
l Warehouse: Specifies the default warehouse to use for sessions initiated
by the driver.
l Role: Specifies the default role to use for sessions initiated by the driver.
The specified role should be a role that has been assigned to the specified
user for the driver.
l Enable SSL: Data is encrypted while transmitting. Snowflake only allows
HTTPS to connect, and so it always uses TLS/SSL.

Other Data Sources and Relational Databases for Windows

If you use other databases or data sources, refer to the database-specific
documentation for information on required settings. Standard settings are
supported by MicroStrategy for most relational databases.

Copyright © 2021 All Rights Reserved 735

In st allat io n an d Co n figu r at io n Gu id e

Microsoft Excel
A Microsoft Excel file can be used as a data source in MicroStrategy. The
information below explains how to prepare an Excel file for use with
MicroStrategy and how to connect to the Excel file.

This data can be used as part of a MicroStrategy project in various ways. For
example, you can integrate the Excel data in your project using tools such as
Architect, as described in the Project Design Help. You can also use
Freeform SQL and Query Builder to access your Excel data, as described in
the Advanced Reporting Help.

Prepare an Excel file as a valid data source

To use an Excel file as a data source, you must create and store the data in
the Excel file so that it can be recognized in MicroStrategy as a set of tables
that contain valid data. Follow the below instructions to create a table with
valid data in an Excel file:

1. Prepare the Excel file as follows:

l Ensure that all column headers are of a valid format:
l No spaces in the header name (for example, Category_ID instead
of Category ID) .
l Alphanumeric, and beginning with a letter.
l Ensure that all cells for the ID column have a value in them.
2. In the Excel file, create a table by performing the following:
a. Highlight the specific rows and columns with the data to use to
create a report with, including the column headers, such as
Category_ID and Category_DESC.

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 so may include numerous empty cells with NULL
values.

Copyright © 2021 All Rights Reserved 736

In st allat io n an d Co n figu r at io n Gu id e

b. In the Name Box, type a name for the highlighted cells, and then
press ENTER. The name you type in is used in MicroStrategy as a
table name.

The Name Box is the drop-down list on the left-hand side below
the toolbars.

You can create multiple tables in one Excel file by highlighting

different parts of the file and assigning them different names.

3. Save the Excel file.

Ensure that the file is not password-protected.

Use your Excel file as a data source

To use an Excel file as a data source, you can create a data source name
(DSN) for the Excel file. This DSN can be used by a database instance in
MicroStrategy to connect to the Excel file. For information on creating a
database instance, see Creating a database instance, page 446.

As an alternative, you can use Data Import to quickly include Excel data in
your MicroStrategy project. Steps to use Data Import to import data and
begin your analysis is included in the MicroStrategy Web Help.

Text files
A text file can be used as a data source in MicroStrategy. You can use Data
Import to quickly include data from text files in your MicroStrategy project.
Steps to use Data Import to import data and begin your analysis is included
in 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 results of a Freeform query, then create reports,

Copyright © 2021 All Rights Reserved 737

In st allat io n an d Co n figu r at io n Gu id e

documents, and dossiers to report on their imported data. You can define a
new database connection directly from Web for users to import data from, or
edit, delete, rename, or duplicate an existing connection.

You must have the Create and Edit Database Instances and Connections and
Create and Edit Database Logins privileges to define a new database
connection.

If you plan to connect to a data source using a DSN, the DSN must be created
and available. If a DSN is not available, you can use the DSNLess Connection
option to connect to your data source.

To Create a New Database Connection

1. In MicroStrategy Web, navigate to any folder page, such as Shared

Reports or My Reports.
2. From the navigation bar on the left, go to Create > Access External
Data > Database. The Select Import Options dialog box opens.
3. Select Pick Tables to select single or multiple tables to import data
from.
l If you want to use a graphical interface to build the SQL query to use
to import your data, select Build a Query.
l If you want to manually type or paste a query to import your data,
select Type a Query.
4. Click OK.
5. From the Data Sources panel, click Add.
6. Select the type of connection to your database, as follows:
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 the
DSN drop-down list, then select the appropriate database
management system (DBMS) from the DBMS drop-down list.
l To connect directly to a data source, select DSNless Connections.

Copyright © 2021 All Rights Reserved 738

In st allat io n an d Co n figu r at io n Gu id e

l If you clear the Show databases whose drivers were not found
check box, only databases that have an installed and configured
driver are available for selection. These databases can be
connected to by selecting the required Database and Version from
the drop-down lists, and supplying the required connection
information. For a detailed list of the information required for each
database type, see Creating DSNs for Specific Data Sources, page
697.
l If you select the Show databases whose drivers were not found
check box, additional databases that do not have a configured
driver are available for selection. These databases can be
connected to by selecting the required Database and Version from
the drop-down lists, and then configuring a connection to the
database by completing the following steps:
1. Click Show connection string.
2. Type the value for each configuration requirement listed.
Depending on the database you are connecting to, this
includes the server name, port number, and database name.
For a detailed list of the information required for each
database type, see Creating DSNs for Specific Data Sources,
page 697.
3. Select the Edit connection string check box.
4. Modify the Driver={DriverName} part of the connection
string, where DriverName is the default name used for the
driver. Replace the default DriverName with the name of the
driver that your administrator installed for the database.
5. If there were any optional configuration parameters that you
chose not to define, modify the connection string to remove the
parameters completely from the string. These parameters are
listed with an equal sign (=) followed immediately by a
semicolon (;), indicating no value is provided. For example, if

Copyright © 2021 All Rights Reserved 739

In st allat io n an d Co n figu r at io n Gu id e

the connection string includes AlternateServers=; remove

this text from the connection string.
7. Type a user name and password with access to the database in the
User and Password fields.
8. Type a name for the database connection in the Data Source Name
field.
9. Do one of the following:
l To allow other users to import data using the database connection,
select the Share this connection with everybody check box.
l To deny other users the ability to import data using the database
connection, clear the Share this connection with everybody check
box.
10. Click OK.

Configuring ODBC Parameters with ODBC.ini

The odbc.ini file is the configuration file that stores the definitions for all
the ODBC DSNs in a Linux environment. Therefore this section is not
relevant to ODBC and DSN connections on Windows.

For information on what drivers to use with MicroStrategy, see the Drivers
and Connectors page.

These ODBC DSNs are defined by specifying values for certain DSN
parameters. This file is activated by the environment variable ODBCINI, and
is required by all ODBC applications. By default, the odbc.ini file is
installed in HOME_PATH, where HOME_PATH is the directory you specified as
the home directory during installation on Linux. It contains the definitions for
all the MicroStrategy-branded ODBC drivers.

MicroStrategy supports ODBC drivers from other vendors that you can
install separately. This involves manually defining the DSN parameters in
the odbc.ini file.

Copyright © 2021 All Rights Reserved 740

In st allat io n an d Co n figu r at io n Gu id e

Modification of the odbc.ini file is necessary to configure the full list of

ODBC driver settings or for ODBC drivers that are not accessible through
the MicroStrategy Connectivity Wizard. However, caution should be taken
when modifying the odbc.ini file as incorrect modifications can cause
unintended functionality and errors.

Refer to the odbc.ini.example file installed in HOME_PATH, where HOME_

PATH is the directory you specified as the home directory during installation
on Linux. It is recommended to copy the examples in the
odbc.ini.example file to odbc.ini, to act as a basis for your
configurations. This example file provides commonly used settings for the
driver parameters.

If you require additional information on the purpose of and available options

for each parameter, refer to the vendor documentation.

Copyright © 2021 All Rights Reserved 741

In st allat io n an d Co n figu r at io n Gu id e

M i cr o St r at egy Had o o p Gat ew ay

Si m p l i f i ed In st al l at i o n
Introduction to the MicroStrategy Hadoop Gateway 742

Environment Considerations 744

Using the MicroStrategy Hadoop Gateway 750

Troubleshooting 759

Known Issues 768

Frequently Asked Questions 770

Introduction to the MicroStrategy Hadoop Gateway

Assumptions
l This document is only eligible for MicroStrategy MicroStrategy Hadoop
Gateway 10.11 and later versions. Previous versions are not fully covered.
l The Intelligence Server and MicroStrategy Hadoop Gateway version
numbers must be identical. Otherwise, data files may not be imported
successfully.
l See the Certification Dossier for a list of certified gateways.

l Starting with MicroStrategy 10.11, MicroStrategy Hadoop Gateway will be

launched with spark-submit.

The application detects Hadoop and Java dependencies and resolves

them automatically. MicroStrategy also provides automatic deployment via
MicroStrategy Hadoop Gateway Manager. Refer to MicroStrategy
Community for more details.

Copyright © 2021 All Rights Reserved 742

In st allat io n an d Co n figu r at io n Gu id e

Introduction
MicroStrategy Hadoop Gateway is a new data processing engine, introduced
in MicroStrategy 10.6, that can be installed in a Spark environment. This
native connector allows analysis of data in Hadoop and provides high-speed
parallel data transfer between the Hadoop Distributed File System (HDFS)
and the MicroStrategy Intelligence Server.

MicroStrategy Hadoop Gateway is a native connector which was built based

on Spark 1.6.x. You can choose one or more data files from Hadoop HDFS
and load them into MicroStrategy Intelligence Server. Data files can be
published as either an In-Memory Cube or a Live Connect Cube.

MicroStrategy Hadoop Gateway supports three operation modes:

l YARN client
l Standalone (HDP cluster does not support Standalone)
l Local

In YARN client mode, the driver runs in the client process, and the
application master is only used for requesting resources from YARN.
Running in this mode requires YARN service to be enabled on your Hadoop
cluster.

In Standalone mode, MicroStrategy Hadoop Gateway uses Spark Master to

coordinate data processing.

In Local mode, no application is deployed in the Spark nodes. All data

processing is executed in the MicroStrategy Hadoop Gateway host. This
modality is intended for testing and troubleshooting.

Related Topics
Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Start the MicroStrategy Hadoop Gateway

Copyright © 2021 All Rights Reserved 743

In st allat io n an d Co n figu r at io n Gu id e

How to Register the MicroStrategy Hadoop Gateway

Troubleshooting

Known Issues

Frequently Asked Questions

Environment Considerations
Security on Data Access (Authentication)
Accessing your Cluster services may be controlled by a compliant Kerberos
implementation (Kerberos MIT, Active Directory). In a Kerberos
environment, the MicroStrategy Hadoop Gateway can identify itself as a
Kerberos principal and have access to the required services: HDFS, Spark
Manager.

Hadoop as an Edge or Proxy Mode of the Cluster

We recommend the MicroStrategy Hadoop Gateway host to be part of the
Hadoop cluster for security, administration and performance benefit. An
Edge or Proxy node is physically or logically located within the cluster, and
contains the same set of libraries.

From an administration point of view, any upgrade on the cluster library

version will include the Edge or Proxy node. It benefits performance, as the
data transfer speed should be higher. It improves security, as the node could
be constrained to the same rules and authentication.

High Availability Mode in HDFS and YARN Cluster Services

Following best practices, the cluster may have implemented High Availability
(HA) mode on the services. A server node can be set as Active and enabled
while an additional can be set to Standby to replace the Active at any time.
An HA environment would use a different set of properties when referring to
these services. Review your environment and make sure it runs in HA mode.

Copyright © 2021 All Rights Reserved 744

In st allat io n an d Co n figu r at io n Gu id e

System Requirements and Supported Configurations

The system requirements for a MicroStrategy Hadoop Gateway are the same
as for a Spark cluster. The supported Spark version is 1.6.x. Supported
distribution version for MicroStrategy Hadoop Gateway is Cloudera Data
Hub 5.10 or above, and Hortonworks 2.4 or above.

For Cluster environments with a standard authentication mechanism, the

MicroStrategy Hadoop Gateway can be operated in Local, YARN client and
Spark Standalone mode. For environments with Kerberos authentication
enabled, the MicroStrategy Hadoop Gateway can only be operated in YARN
client mode.

The following are needed on a Hadoop cluster:

l You should have a Hadoop environment installed on Unix/Linux servers.

The Hadoop Cluster must have at least the HDFS service installed. Other
services that can be installed include Hive, Hue, Oozie, and ZooKeeper.

l MicroStrategy Hadoop Gateway supports the High Availability mode of

NameNode and YARN Resource Manager.

To enable NameNode High Availability, see How to Browse the Hadoop

Distributed File System and Preview Files. No extra configuration is
required for YARN Resource Manager High Availability. It is handled
automatically.

l If you are using the MicroStrategy Hadoop Gateway in YARN client mode,
the Hadoop Cluster should have YARN and Spark services installed.
l If you are using MicroStrategy Hadoop Gateway on Spark Standalone
mode, the Hadoop cluster should have Spark (Standalone) service
installed.
l Connectivity parameters to the Spark master (for example
spark://SparkMasterNode:7077)
l Cloudera Manager does not allow this service to be installed if the
cluster has Kerberos enabled.

Copyright © 2021 All Rights Reserved 745

In st allat io n an d Co n figu r at io n Gu id e

l For troubleshooting purposes:

l Access to Spark Standalone website
http://SparkMasterNode:18080
l Access to Spark History Server website
http://SparkHistoryServerNode:18088
l Access to YARN resource monitor website
http://YARNResourceManagerNode:8088

l Make sure Spark service is installed and configured properly.

MicroStrategy Hadoop Gateway 10.11 and later will be launched with
spark-submit methodology to avoid issues with cluster environment
compliance and compatibility.

Ports Used by MicroStrategy Hadoop Gateway

To: Service
From Explanation
Default Port

Sending commands from the Intelligence Server to

MicroStrategy
MicroStrategy Hadoop Gateway to fetch data. The port
Intelligence Hadoop
number is configurable in MicroStrategy Hadoop
Server Gateway Host
Gateway configuration file: /conf/hgos-
Port 30004
spark.properties.

Port used by Intelligence Server to browse HDFS via

MicroStrategy MicroStrategy Hadoop Gateway RESTful service.
Intelligence Hadoop
Server Gateway Host The port number is configurable in MicroStrategy

Port 4020 Hadoop Gateway configuration file: /conf/hgos-

spark.properties.

MicroStrategy HDFS
Default port number is: 8020. Please contact your
Hadoop NameNode
cluster administrators for specific port number.
Gateway Port 8020

HDFS (all Intelligence Used to send query result set from MicroStrategy
nodes of Server Port Hadoop Gateway Spark application worker nodes to
cluster 30241 Intelligence Server. The port number is configurable in

Copyright © 2021 All Rights Reserved 746

In st allat io n an d Co n figu r at io n Gu id e

To: Service
From Explanation
Default Port

the OS registry where the Intelligence Server is

installed.

Registry key: HKEY_LOCAL_

Hadoop)
MACHINE/SOFTWARE/Wow6432Node/MicroStrategy
/DSS Server/Castor/DSPort

Registry file in Linux: MSIReg.reg

YARN
MicroStrategy
Resource
Hadoop YARN connectivity
Manager Port
Gateway
8032

MicroStrategy
Spark Port
Hadoop Spark connectivity
4040
Gateway

MicroStrategy
Kerberos KDC To authenticate MicroStrategy Hadoop Gateway to
Hadoop
Port 88 access other services (such as HDFS).
Gateway

If Kerberos Authentication Has Been Enabled

To learn about Kerberos installation, see: How to Install the Kerberos
Authentication Service.

Please refer to following links about how to enable Kerberos authentication

in Cloudera CDH and Hortonworks HDP cluster.

You will need a Kerberos principal (or SPN in Active Directory) to

authenticate your MicroStrategy Hadoop Gateway process.

The Kerberos authentication happens in at least two events:

l Browsing the HDFS file directory to select files to import. MicroStrategy

Hadoop Gateway directly connects NameNode.

Copyright © 2021 All Rights Reserved 747

In st allat io n an d Co n figu r at io n Gu id e

l Starting the MicroStrategy Hadoop Gateway on YARN-client mode:

MicroStrategy Hadoop Gateway will deploy Spark applications across
YARN and requires a Kerberos ticket for this.

MicroStrategy Hadoop Gateway should be executed with a valid Linux user

account linked to a Kerberos principal. It could have any name, but for
convention we will refer to it as
hgos/<HadoopGatewayHostFQDN>@REALM_NAME. As any other Cluster
account, this account should be able to log into all machines of the cluster.

This account should be allowed to log into HDFS with write privileges in its
home directory (for example hdfs://NameNode:8020/user/hgos).

Cluster nodes should have required libraries to work as a Kerberos client

(these could be the packages krb5-workstation, openldap-client).

If High Availability Mode Has Been Enabled

Identify the nameservice of the HDFS service.

The following are needed on a MicroStrategy Hadoop Gateway driver

machine:

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 subversion available)
installed.
l Linux account must have write and execute privileges in the installation
folder.
l The OS account should have an assigned user folder in HDFS and
read/write privileges (for example
hdfs://<HDFSNameNode:8020>/user/<Principal name>/) (a temp
directory .sparkStaging will be created).
l Connectivity parameters, IP address and the port to connect from
Intelligence Server.

Copyright © 2021 All Rights Reserved 748

In st allat io n an d Co n figu r at io n Gu id e

l For detailed logs, replace the log4j.properties file with the richer
version available in the troubleshooting section.

If Kerberos Authentication Has Been Enabled

l The host should have installed Kerberos client libraries (like krb5-
workstation) and allow Kerberos commands like kinit or klist.
l The Java Runtime Environment should have the Java Cryptography
Extension libraries to support aes-256 encryption. There libraries are
available at Oracle's website. The Java JCE package contains two JAR
libraries. Use these and replace them in the directory <JRE_
HOME>/lib/security (If JDK is installed instead of JRE, it should be
<JDK_Home>/jre/lib/security. Keep a backup of your original
libraries).

For the Intelligence Server host, update firewall and network rules to allow
connectivity into port 30241 from cluster worker nodes.

Related Topics
Introduction to the MicroStrategy Hadoop Gateway

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

Copyright © 2021 All Rights Reserved 749

In st allat io n an d Co n figu r at io n Gu id e

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 machine

requires transferring, extracting, and configuring the MicroStrategy
Hadoop Gateway.

l How to Start the MicroStrategy Hadoop Gateway

Starting the MicroStrategy Hadoop Gateway will start the MicroStrategy

Hadoop Gateway service and will be ready to accept commands from the
Intelligence Server (through specified TCP port).

l How to Register the MicroStrategy Hadoop Gateway

Registering the MicroStrategy Hadoop Gateway stores the configuration of

the MicroStrategy Hadoop Gateway in the Intelligence Server
environment. In this stage, you define the operation mode and connectivity
parameters.

How to Deploy the MicroStrategy Hadoop Gateway

Deploying the MicroStrategy Hadoop Gateway on a host machine requires to
transfer, extract and configure MicroStrategy Hadoop Gateway.

Obtain MicroStrategy Hadoop Gateway

You will need a copy of the MicroStrategy Hadoop Gateway package. It can
be obtained from MicroStrategy download website or from Intelligence
Server directory.

Copyright © 2021 All Rights Reserved 750

In st allat io n an d Co n figu r at io n Gu id e

Download the MicroStrategy Hadoop Gateway

1. Go to MicroStrategy download website.

2. Click on Feature Releases and select your version (for example 10.x).
3. Click on MicroStrategy 10.x Add-Ons and Tools.
4. Click to download Hadoop Gateway.
5. Click OK
6. Save the file 10.x.00xx.00xx_10.x_GA_HadoopGateway.zip.
7. Copy the file onto your MicroStrategy Hadoop Gateway machine.

Copy the MicroStrategy Hadoop Gateway From the Intelligence Server

1. Go to the Intelligence Server directory.

2. Open the "hgos-manager" directory.
3. Copy the file hgos-dist.tar.gz onto your MicroStrategy Hadoop
Gateway machine.

Install the MicroStrategy Hadoop Gateway

1. Log in to the MicroStrategy Hadoop Gateway host machine via SSH.
2. Locate the MicroStrategy Hadoop Gateway tarball hgos-
dist.tar.gz.
3. Unzip it in your selected directory (for example, by running: tar -xvzf
hgos-dist.tar.gz).

Configure MicroStrategy Hadoop Gateway

MicroStrategy Hadoop Gateway will be configured with minimum
infrastructure after installation.

To customize the installation to specific requirements, modify the

MicroStrategy Hadoop Gateway configuration file <Installation
path>/conf/hgos-spark.properties.

Copyright © 2021 All Rights Reserved 751

In st allat io n an d Co n figu r at io n Gu id e

If Kerberos Authentication Has Been Enabled

Modify MicroStrategy Hadoop Gateway configuration file <MicroStrategy

Hadoop Gateway installation path>/conf/hgos-
spark.properties and uncomment the following section:

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, and
connectivity parameters.

Related Topics

Introduction to the MicroStrategy Hadoop Gateway

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Register the MicroStrategy Hadoop Gateway

Troubleshooting

Known Issues

Frequently Asked Questions

How to Start the MicroStrategy Hadoop Gateway

Starting MicroStrategy Hadoop Gateway will start the MicroStrategy Hadoop
Gateway service and will be ready to accept commands from the Intelligence
Server (through specified TCP port).

Copyright © 2021 All Rights Reserved 752

In st allat io n an d Co n figu r at io n Gu id e

Launch MicroStrategy Hadoop Gateway Service

1. Run the file /<MicroStrategy Hadoop Gateway installation
path>/sbin/start-hgos.sh.
2. Once the MicroStrategy Hadoop Gateway is started successfully, the
result should look like 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

Introduction to the MicroStrategy Hadoop Gateway

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Register the MicroStrategy Hadoop Gateway

Troubleshooting

Copyright © 2021 All Rights Reserved 753

In st allat io n an d Co n figu r at io n Gu id e

Known Issues

Frequently Asked Questions

How to Register the MicroStrategy Hadoop Gateway

Registering MicroStrategy Hadoop Gateway stores the configuration of the
MicroStrategy Hadoop Gateway in the Intelligence Server environment. In
this stage, you define the operation mode and connectivity parameters.

How to Browse the Hadoop Distributed File System and Preview

Files
1. Log into MicroStrategy Web.
2. Click Create > Add External Data.
3. In the Connect your Data dialog, click Hadoop.

4. Select Browse Hadoop Files using MicroStrategy Big Data Engine

when "Select Import Options" form appears.

Copyright © 2021 All Rights Reserved 754

In st allat io n an d Co n figu r at io n Gu id e

5. Click Next. The "Connect to Hadoop" form appears with the HDFS file
browser.
6. In Hadoop File Browser entry, click Change Connection on top of
screen.

Copyright © 2021 All Rights Reserved 755

In st allat io n an d Co n figu r at io n Gu id e

7. Select Edit connection string to enable connection string

modification.

Copyright © 2021 All Rights Reserved 756

In st allat io n an d Co n figu r at io n Gu id e

8. Make sure you configure appropriate Hadoop NameNode IP/Host and

port in the connection string.

Hadoop NameNode IP address is: 10.242.109.2, and HDFS port

number is by default: 8020. The MicroStrategy Hadoop Gateway is
deployed on host IP: 10.242.109.10 with port: 30005 (port can be
configured in MicroStrategy Hadoop Gateway configuration file). The
connection string for the above data should look like this:

Copyright © 2021 All Rights Reserved 757

In st allat io n an d Co n figu r at io n Gu id e

hadoopName=10.242.109.2;hdfsPort=8020;BDEIP=10.242.109.10;BDEPORT=300
05;

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 the
connection string, and remove the attribute hdfsPort.

Here, the HDFS nameservice is "nameservice1" in the cluster. The

connection 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. Click OK to save connectivity parameters and finish MicroStrategy

Hadoop Gateway registration. HDFS folders and files will appear if
everything has been configured properly.

Once the MicroStrategy Hadoop Gateway is running, the Import Data feature
can be used to import data as an Intelligent Cube for data consumption.

Related Topics

Introduction to the MicroStrategy Hadoop Gateway

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Start the MicroStrategy Hadoop Gateway

Troubleshooting

Known Issues

Frequently Asked Questions

Copyright © 2021 All Rights Reserved 758

In st allat io n an d Co n figu r at io n Gu id e

Troubleshooting
How to Get Additional Log Messages to Troubleshoot the
MicroStrategy Hadoop Gateway
1. Connect to the MicroStrategy Hadoop Gateway host. Edit the
configuration file log4.properties in the MicroStrategy Hadoop
Gateway installation path.
2. Update its contents to match the lines 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

Copyright © 2021 All Rights Reserved 759

In st allat io n an d Co n figu r at io n Gu id e

How to Get YARN Log Messages to Troubleshoot the

MicroStrategy Hadoop Gateway

If You Are Using the Cloudera CDH Cluster

1. Log into Cloudera Manager, the cluster administration portal.
2. Click YARN service.

3. Click Web UI.

4. Select the active ResourceManager WebUI if YARN Resource
Manager is configured as High Availability. You will be redirected to the

Copyright © 2021 All Rights Reserved 760

In st allat io n an d Co n figu r at io n Gu id e

Hadoop Resource Manager page.

Copyright © 2021 All Rights Reserved 761

In st allat io n an d Co n figu r at io n Gu id e

If You Are Using the Hortonworks Cluster

1. Log into Ambari, the cluster administration portal.
2. Click YARN service.

3. Click Quick Links.

Copyright © 2021 All Rights Reserved 762

In st allat io n an d Co n figu r at io n Gu id e

4. Select ResourceManager UI. You will be redirected to the Hadoop

Resource Manager page.

5. Find Hadoop Gateway in the application list, and click the application
ID.

You will find application details and logs in YARN.

Copyright © 2021 All Rights Reserved 763

In st allat io n an d Co n figu r at io n Gu id e

What to Do if You Get an Error in the MicroStrategy Hadoop

Gateway Connection Page and You Are Unable to Browse
HDFS

Follow the steps below to diagnose the issue.

Copyright © 2021 All Rights Reserved 764

In st allat io n an d Co n figu r at io n Gu id e

1. Make sure MicroStrategy Hadoop Gateway service has been started

successfully and port number 4020 is open on MicroStrategy Hadoop
Gateway host machine. In MicroStrategy2021, the port 4020 is
configurable in Hadoop. You can change the value (port number) of
parameter hgos.restful.port in <MicroStrategy Hadoop
Gateway installation path>/conf/hgos-spark.properties.
2. Check if the HDFS service is running and NameNode is accessible from
the MicroStrategy Hadoop Gateway host machine.

3. Check if an appropriate connection string is configured and the values

are correct. All the connection string attributes are case sensitive.

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 the
connection string, and remove the attribute hdfsPort.

hadoopNameService=<HDFS nameservice>;BDEIP=<MicroStrategy Hadoop

Gateway host machine>;BDEPORT=<MicroStrategy Hadoop Gateway port>;

If Kerberos Authentication Has Been Enabled

1. Make sure the principal ticket is valid. You can refresh the ticket by
running the following command:

kinit -k -t <Principal keytab file path> <Principal> -c <Cache name>

2. Make sure that the present principal has sufficient permissions to

browse HDFS. You can do so by running the following command:
hadoop fs -ls /

Copyright © 2021 All Rights Reserved 765

In st allat io n an d Co n figu r at io n Gu id e

The expected result is like 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
-rw-r--r-- 3 root supergroup 308 2017-11-08 07:31 /Date_
Format_b.csv
-rw-r--r-- 3 root supergroup 476 2017-11-01 10:26 /Date_
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 published or generate dossiers in the Live

Connect mode. By using the MicroStrategy Hadoop Gateway log, you
can determine if data is transmitted back to Intelligence Server
successfully from the Hadoop cluster.

Make sure that the port number used to receive data from
MicroStrategy Hadoop Gateway is open on the Intelligence Server. By
default, the port number is 30241, and it is configurable in the registry.

If the intelligence Server and Hadoop cluster are installed on separate

networks, the Intelligence Server communicates with the cluster via a
gateway. You need to specify the Intelligence Server host name and IP.
Otherwise, the MicroStrategy Hadoop Gateway will submit data to the

Copyright © 2021 All Rights Reserved 766

In st allat io n an d Co n figu r at io n Gu id e

gateway machine instead, because the MicroStrategy Hadoop Gateway

detects the source automatically from the network request.

To specify the Intelligence Server host name and IP, you need to
modify the registry key and manually set DSHostName with the
Intelligence Server host name and IP.

The ability to specify the Intelligence Server hostname and IP is only

available for MicroStrategy 10.10 and later.

Registry key:

HKEY_LOCAL_MACHINE/SOFTWARE/Wow6432Node/MicroStrategy/DSS
Server/Castor/DSHostName

Registry file on the Intelligence Server:

MSIReg.reg

3. Restart the Intelligence Server and the MicroStrategy Hadoop Gateway.

Related Topics
Introduction to the MicroStrategy Hadoop Gateway

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Start the MicroStrategy Hadoop Gateway

How to Register the MicroStrategy Hadoop Gateway

Known Issues

Frequently Asked Questions

Copyright © 2021 All Rights Reserved 767

In st allat io n an d Co n figu r at io n Gu id e

Known Issues
Symptom
In MicroStrategy Web, users have an expansion in the variety of data
sources to which they can connect. These new options are under Add
External Data. A user with Web Reporter, Web Analyst, and Web
Professional privileges will receive a "You do not have enough privileges to
perform this operation" error when trying to import a table from a data
source. This is due to the fact that the user privilege "Access data from
Databases, Google BigQuery, BigData, OLAP, BI tools" is not the only
privilege needed. Creating a data source object to import Tables is
considered an Administrator Privilege.

Workaround

Give the user the privilege from the Administration group "Create and edit
database and instances and connections".

The "Create and edit database and instances and connections" is a Server
level only privilege and can only be granted only at the project source level,
so it needs to be given at a user or user group level.

Copyright © 2021 All Rights Reserved 768

In st allat io n an d Co n figu r at io n Gu id e

Symptom
There are persisting tables in the Hive Metastore when the MicroStrategy
Hadoop Gateway service starts. In the log file you can see that the
MicroStrategy Hadoop Gateway service is trying to modify the structure of
some Metastore tables (such as DBS tables). When it tries to commit the
transaction, an error is produced and a rollback operation is generated.

Workaround

MicroStrategy Hadoop Gateway requires a Hive component to load ORC

files, and basic metadata needs to be created to establish the Hive
component. Modifying the structure of Metastore tables is not permitted by
default.

To enable Metastore modification, add the following section to

/etc/hive/conf/hive-site.xml.

<property>
<name>datanucleus.autoCreateSchema</name>
<value>true</value>
</property>

Alternatively, the Hive component can be disabled if you are not going to
import ORC files. Set the property hgos.spark.enable value to false in
the MicroStrategy Hadoop Gateway configuration file<MicroStrategy
Hadoop Gateway installation path>/conf/hgos-
spark.properties.

Symptom
Text columns in the parquet file created by Impala are loaded as binaries.

Workaround

The Impala Parquet writer always creates an unannotated binary field for
string columns. It is possible to specify that the field include the UTF-8
annotation to indicate UTF-8 string data. It was resolved in Impala 2.6 and
CDH 5.11 has 2.8.

Copyright © 2021 All Rights Reserved 769

In st allat io n an d Co n figu r at io n Gu id e

If all these columns need to be converted to UTF-8 strings, add

spark.sql.parquet.binaryAsString=true into configuration file
<MicroStrategy Hadoop Gateway installation
path>/conf/hgos-spark.properties.

Related Topics
Introduction to the MicroStrategy Hadoop Gateway

Environment Considerations

How to Deploy the MicroStrategy Hadoop Gateway

How to Start the MicroStrategy Hadoop Gateway

How to Register the MicroStrategy Hadoop Gateway

Troubleshooting

Frequently Asked Questions

Frequently Asked Questions

What are the recommended settings for hgos-spark.properties?

The table below helps calculate the recommended settings based on the
number of working nodes, RAM and virtual cores in each node, and the
number of executors to be allocated on each worker node.

Recommended performance parameters for YARN client mode

Formul
ID Item Parameter Value Description
a

Number Available in your

C1 2
of Node hardware

RAM per Available in your

C2 380
Node hardware

Copyright © 2021 All Rights Reserved 770

In st allat io n an d Co n figu r at io n Gu id e

Formul
ID Item Parameter Value Description
a

(GB)

VCores Available in your

C3 40
per Node hardware

Total
number
C4 C1 × C3 80
of
VCores

Allocated
S1 = S2
S1 executor 48
× C1
s

Executor Number of executors to

spark.executor.core
S2 s per 6 be allocated on each
s
Node worker node

Max
memory
S3 = C2
S3 per 63
/ S2
executor
(GB)

Overhead memory used

by the OS.
Overhead H1 = S3
H1 4 It defaults to 0.07 ×
(GB) × 0.07
spark.executor.me
mory

Total number of
executors created in
Number the cluster.
spark.executor.inst H2 = S1
H2 of 47
ance -1 One node needs to
executor
occupy an executor for
AM.

Copyright © 2021 All Rights Reserved 771

In st allat io n an d Co n figu r at io n Gu id e

Formul
ID Item Parameter Value Description
a

Running executors with

too much memory often
Memory results in excessive
per spark.executor.memo H3 = S3 garbage collection
H3 59 delays.
executor ry - H1
(GB) 64 GB is a rough guess
at a good upper limit for
a single executor.

Cores H4 =
Leave 1 core for
H4 per (C3 / 6
system processes
executor S2) - 1

Can MicroStrategy Hadoop Gateway release cluster resources during idle

time?

Yes, MicroStrategy Hadoop Gateway supports releasing cluster resources

while the service is idle. You will have to configure the MicroStrategy
Hadoop Gateway executors and cores as dynamically allocated to enable
this behavior. Modify the MicroStrategy Hadoop Gateway configuration file
<MicroStrategy Hadoop Gateway installation
path>/conf/hgos-spark.properties, and uncomment the dynamic
allocation section.

Does MicroStrategy Hadoop Gateway support Live Connect?

Yes, MicroStrategy Hadoop Gateway supports Live Connect Cube since

MicroStrategy 10.9. There is no extra configuration required to enable it.

What is the minimum memory and hard drive space to install MicroStrategy
Hadoop Gateway on the host machine?

The minimum requirement for the MicroStrategy Hadoop Gateway is 256 MB

of disk space and 2 GB of memory.

Copyright © 2021 All Rights Reserved 772

In st allat io n an d Co n figu r at io n Gu id e

What is the memory and hard drive space necessary in other nodes
(NameNode, DataNode) while MicroStrategy Hadoop Gateway is running?

MicroStrategy Hadoop Gateway will not start any extra processes on a

NameNode or a DataNode. MicroStrategy Hadoop Gateway just submits job
to Spark.

DataNode memory usage depends on the number set by the customer to

attribute file spark.executor.memory in the configuration file (by default,
it is 1 GB). Meanwhile, NameNode memory usage will not be significantly
affected.

Will MicroStrategy Hadoop Gateway create any metadata on HDFS?

When MicroStrategy Hadoop Gateway starts, some JAR files will be

uploaded to HDFS to hdfs://HDFSNameNode:8020/user/${user_
name_start_hgos}/.sparkStaging. By default, the files in
sparkStaging will be deleted automatically once MicroStrategy Hadoop
Gateway service is shut down.

Total size of JAR files will be no larger than 256 MB.

Can MicroStrategy Hadoop Gateway refresh Kerberos principal ticket

automatically?

No, MicroStrategy Hadoop Gateway will not refresh Kerberos principal ticket
automatically. You will have to refresh it 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

Copyright © 2021 All Rights Reserved 773

In st allat io n an d Co n figu r at io n Gu id e

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 Apache Sentry,

and no extra configuration is required. See the video below for how
MicroStrategy Hadoop Gateway works with Apache Sentry.

Does MicroStrategy Hadoop Gateway support Apache Spark 2 and later?

No. MicroStrategy Hadoop Gateway is built on Spark 1.6 and only eligible to
be deployed in a Spark 1.6 environment. We are working to release
MicroStrategy Hadoop Gateway on Spark 2.

Copyright © 2021 All Rights Reserved 774

In st allat io n an d Co n figu r at io n Gu id e

Related Topics
Introduction to the MicroStrategy Hadoop Gateway

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

Copyright © 2021 All Rights Reserved 775

In st allat io n an d Co n figu r at io n Gu id e

In st al l i n g an d Co n f i gu r i n g
To p o l o gy
MicroStrategy Workstation Topology provides users with a graphical
interface that presents the entire topology of every node within their
environment, in addition to related services for available nodes. Through the
Monitors menu in Workstation, administrators can monitor the current state
of every service on each node, as well as start or stop individual services.

This section describes how to install and configure topology.

Introduction to Topology
Topology allows administrators to monitor MicroStrategy Services and
manage them in MicroStrategy Workstation. The following functionality is
supported:

Copyright © 2021 All Rights Reserved 776

In st allat io n an d Co n figu r at io n Gu id e

l Service Health Monitor

The administrator can monitor MicroStrategy services through Workstation

and visualize if they are running or stopped.

l Service Start/Stop

The administrator can start or stop MicroStrategy services through

Workstation. This functionality is currently limited to SSH authentication
with username and password.

See the topic, How to View Environment Topology and Monitor Services in
the Workstation Help for more information about using topology within
Workstation.

The two following types of lightweight agents are used to monitor services in
Workstation:

l Monitoring Agents

The monitoring agents come with the installation of most MicroStrategy

services. Use them to monitor services and view their health status.

l Communication Agents:

Some monitoring agents also act as communication agents. In addition to

monitoring services, communication agents help other monitoring agents
locate each other and gather monitoring information. The administrator
must pick at least one agent to act as a communication agent, so all other
agents can locate each other through this agent.

On environments where three or more machines host MicroStrategy

Services, it is recommended that you choose at least three communication
agents to provide redundancy and improved reliability, in case one
communication agent becomes unavailable. The machines chosen to act
as communication agents must be machines that host MicroStrategy
Services, such as Intelligence Server or MicroStrategy Library. If you
decide to use only one communication agent, it is recommended that you
choose the machine that houses MicroStrategy Library (if deployed

Copyright © 2021 All Rights Reserved 777

In st allat io n an d Co n figu r at io n Gu id e

through the MicroStrategy installation), since Library communicates

directly with Workstation.

If your Library deployment is done through a WAR file or if you do not use
a machine that houses MicroStrategy Library to host the communication
agent, then use a machine that houses Intelligence Server.

MicroStrategy uses Consul technology for Services Registration. A

monitoring agent corresponds to a Consul agent in client mode. A
communication agent corresponds to a Consul agent in server mode.

Copyright © 2021 All Rights Reserved 778

In st allat io n an d Co n figu r at io n Gu id e

Installing Topology
This section describes how to install topology using the Topology
Configuration dialog of the Installation wizard.

1. On the Topology Configuration dialog of the Installation wizard, select

whether your environment has Single or Multiple machines.

Copyright © 2021 All Rights Reserved 779

In st allat io n an d Co n figu r at io n Gu id e

2. If your environment contains multiple machines, determine which

machines in your environment you want to act as communication
agents. Among all the machines in your environment that will host
MicroStrategy Services, select at least one of them (three are
recommended for multiple machine environments) to act as a
communication agent. Enter each machine in the text field, separated
by semicolons. You must input the exact same list on all machines,
using the Topology Configuration dialog of the Installation wizard,
including the monitoring and communication agent machines.

The MicroStrategy Services are as follows:

l MicroStrategy Intelligence Server

l MicroStrategy Web Universal
l MicroStrategy Library
l MicroStrategy Mobile
l MicroStrategy Messaging Services
l MicroStrategy Platform Analytics
l MicroStrategy Certificate Store

An odd number of communication agents is required due to the

leadership selection algorithm.

Examples:

servername1.domain.com;servername2.domain.com;server
name3.domain.com;
servername1.domain.com;

Example: Your environment contains the following two machines and

you select one machine to host the communication agent:

l Machine 1 hosts MicroStrategy Library and the communication agent

l Machine 2 hosts the Intelligence Server

Copyright © 2021 All Rights Reserved 780

In st allat io n an d Co n figu r at io n Gu id e

When performing the installation, enter the full domain name,

machine1.domain.com, on both machines.

Example: Your environment contains the following three machines and

you want all machines to host a communication agent:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1
l Machine 3 hosts Intelligence Server 2

When performing the installation, enter

machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all three machines.

Example: Your environment contains the following five machines and

you select three machines to host the communication agents:

l Machine 1 hosts MicroStrategy Library

l Machine 2 hosts Intelligence Server 1 and a communication agent
l Machine 3 hosts Intelligence Server 2 and a communication agent
l Machine 4 hosts Intelligence Server 3 and a communication agent
l Machine 5 hosts Intelligence Server or other services

Enter
machine1.domain.com;machine2.domain.com;machine3.domain.c
om; on all machines.

Some important information to keep in mind:

l In MicroStrategy 2019, OpenSSH is no longer installed on Windows

machines. You must install Open SSH to start and stop services using
topology. Upgrading your system from 11.0 to 2019 removes Open SSH.

If consul is already installed on a machine, prior to installing MicroStrategy

products, the service registration auto configuration and execution is

Copyright © 2021 All Rights Reserved 781

In st allat io n an d Co n figu r at io n Gu id e

affected. We do not recommend a separate consul installation on the same

machine.

l If you select Multiple machine environment, you must enter an odd

number of machines.
l If your environment includes more than one machine and machines with
dynamic IP addresses as communication agents, use FQDN for the
communication agent machine list during the installation.
l If your environment includes more than one machine and machines with
more than one IP address as communication agents, it is recommended
that you use FQDN for the communication agent machine list during the
installation. If IP address list is used, make sure the machine with multiple
IP addresses can be pinged with an IP address included in the list.

Topology supports installation on machines with public IP addresses. To

avoid unexpected joins to topology nodes, possibly exposing service
information, you must configure your firewall correctly. Your firewall
should allows ports for Server RPC (default 8300), and Serf LAN (default
8301), and Serf WAN (default 8302) only for the nodes within the
Workstation topology node cluster. See Enabling Topology
Communication Through a Firewall for more information.

Deploying MicroStrategy Library through a WAR File

If you do not want to deploy MicroStrategy Library through the installer,
which uses Tomcat by default, you can deploy MicroStrategy Library to a
Web 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 in this
deployment becomes a monitoring agent by default. It automatically

Copyright © 2021 All Rights Reserved 782

In st allat io n an d Co n figu r at io n Gu id e

connects to the agent on the iServer machine that is connected to

Library.
3. Make sure the Intelligence server, connected to Library, hosts the
communication agent.
4. Keep in mind that restarting the application also restarts the service
registration agent.

5. If the firewall is turned on for this machine, refer to Enabling Topology

Communication Through a Firewall to make sure the proper ports are
open to support service registration agent communications.

To create redundancy for the communication agents:

In this configuration, one machine hosts MicroStrategy Library and the other
two machines host Intelligent servers (and/or more machines hosting
services). Redundancy is recommended, with a total of three
communication agents.

1. Create a list of the three machines separated by semicolons.

librarymachine.domain.com;intelligenceserver1.domain.com;intelligences
erver2.domain.com

2. During the installation, enter the list of three machines, as noted above,
on both Intelligent servers and/or any other machines where the
MicroStrategy installation runs.

3. After deploying Library, manually change its configuration to run as a

communication agent.
a. Navigate to the deployed folder of MicroStrategy Library and the
subfolder, \ServicesRegistration\yaml.
b. Modify the configuration file.
c. Restart all consul nodes.

Copyright © 2021 All Rights Reserved 783

In st allat io n an d Co n figu r at io n Gu id e

Enabling Topology Communication Through a Firewall

MicroStrategy supports machines with registration services installed in the
same subset as a MicroStrategy environment. If there is a firewall between
MicroStrategy Services, make sure the specified ports (shown below) are
allowed to send and receive TCP/UDP requests through the firewall, so the
Services Registration agents can communicate properly. Consul uses both
TCP and UDP, so make sure to allow both protocols.

l Server RPC (Default 8300)

This port is used by the communication agents to handle incoming
requests from other agents. TCP only.
l Serf LAN (Default 8301)
This port is used by all monitoring and communication agents to
communicate with each other on the LAN. TCP and UDP.

l Serf WAN (Default 8302). Use this port for machine communication over a
WAN. This port is used by servers to gossip over the WAN to other
servers. TCP and UDP.

If you are performing a Windows installation and the firewall is on, the
installer adds rules to open 8300 and 8301 for TCP and 8301 for UDP.

On machines with public IP addresses exposed to the internet, make sure

firewall ports for Server RPC (default 8300), Serf LAN (default 8301), and
Serf WAN (default 8302) are only for nodes within the Workstation topology
cluster.

See the Consul documentation for more information on port requirements.

See Using Firewalls for more information about using firewalls with
MicroStrategy.

Using Firewalls
A firewall enforces an access control policy between two systems. A firewall
can be thought of as something that exists to block certain network traffic

Copyright © 2021 All Rights Reserved 784

In st allat io n an d Co n figu r at io n Gu id e

while permitting other network traffic. Though the actual means by which this
is accomplished varies widely, firewalls can be implemented using both
hardware and software, or a combination of both.

Firewalls are most frequently used to prevent unauthorized Internet users

from accessing private networks connected to the Internet, especially
intranets. If you use MicroStrategy Web or Mobile products over the Internet
to access projects on an Intelligence Server that is most likely on an
intranet, there is the possibility that a malicious user can exploit the security
hole created by the connection between the two systems.

Therefore, in many environments and for a variety of reasons you may want
to put a firewall between your Web servers and the Intelligence Server or
cluster. This does not pose any problems for the MicroStrategy system, but
there are some things you need to know to ensure that the system functions
as expected. Another common place for a firewall is between the Web clients
and the Web or Mobile server.

Another common place for a firewall is between the Web clients and the Web
or Mobile server. The following diagram shows how a MicroStrategy system
might look with firewalls in both of these locations:

Regardless of how you choose to implement your firewalls, you must make
sure that the clients can communicate with MicroStrategy Web and Mobile
Servers, that MicroStrategy Web and Mobile can communicate with
Intelligence Server, and vice versa. To do this, certain communication ports
must be open on the server machines and the firewalls must allow Web
server and Intelligence Server communications to go through on those ports.
Most firewalls have some way to specify this. Consult the documentation
that came with your firewall solution for details.

Copyright © 2021 All Rights Reserved 785

In st allat io n an d Co n figu r at io n Gu id e

To Enable Communication through a Firewall

1. Client Web browsers communicate with MicroStrategy Web on port 80

(HTTP). So, if you have a firewall between your clients and
MicroStrategy Web servers, you must make sure port 80 is allowed to
send and receive requests through the firewall.

Depending on how you deployed Web Universal, it may communicate

on a different port number.

2. MicroStrategy Web products can communicate with Intelligence Server

using any port that is greater than 1024. By default, the ports are 34952
and 34962. If you have a firewall between your Web servers and
Intelligence Server, you must make sure port 34952 and 34962 are
allowed to send and receive TCP/IP requests through the firewall.

You can change this port number. See the steps in the next procedure
To Change the Port through which MicroStrategy Web and Intelligence
Server Communicate, page 787 to learn how.

3. You must configure your firewall to allow MicroStrategy Web products

to communicate with Intelligence Server using port 3333. This is in
addition to the port configured in the previous step of this procedure.
4. The MicroStrategy Listener Service communicates with MicroStrategy
Web products and Intelligence Server on port 30172. So, if you are
using the Listener Service, you must make sure port 30172 is allowed
to send and receive TCP/IP and UDP requests through the firewall. You
cannot change this port number.

5. The MicroStrategy Intelligence Server REST Listener listens on port

34962 for REST requests. So, if you have a firewall, you must make
sure 34962 is allowed to receive TCP requests through the firewall. If
you change this port (34962) to a different one through Configuration
Wizard, you need to modify Inbound Rules for the Firewall accordingly.

Copyright © 2021 All Rights Reserved 786

In st allat io n an d Co n figu r at io n Gu id e

6. MicroStrategy Telemetry Server uses ports 2181, 9092, 2888, and 3888
to communicate with other MicroStrategy Services, such as the
Intelligence Server, New Export Engine, and Platform Analytics. If you
have a firewall between MicroStrategy Services you must make sure
these four ports are allowed to send and receive TCP requests through
the firewall.

7. MicroStrategy Topology uses ports 8300 and 8301 to communicate

between agents. If you have a firewall between MicroStrategy Services
you must make sure these two ports are allowed to send and receive
TCP/UDP requests through the firewall.

The MicroStrategy Services are as follows:

l MicroStrategy Intelligence Server

l MicroStrategy Web Universal
l MicroStrategy Library
l MicroStrategy Mobile
l MicroStrategy Telemetry Server
l MicroStrategy Platform Analytics
l MicroStrategy Certificate Store
l Usher Security Services

To Change the Port through which MicroStrategy Web and

Intelligence Server Communicate

By default, MicroStrategy Web and Intelligence Server communicate with

each other using port 34952 (Web Universal may use a different port
depending on how you deployed it). If you want to change this, you must
change it for both the Web servers and the Intelligence Servers. The port
numbers on both sides must match.

Copyright © 2021 All Rights Reserved 787

In st allat io n an d Co n figu r at io n Gu id e

If you are using clusters, you must make sure that all machines in the Web
server cluster can communicate with all machines in the Intelligence Server
cluster.

To Ch an ge t h e Po r t N u m b er f o r In t el l i gen ce Ser ver

1. In Developer, log in to the project source that connects to the server

whose port you want to change.
2. In the Service Manager, click Options.
3. On the Intelligence Server Options tab, type the port number you want
to use in the Port Number box. Save your changes.
4. A message appears telling you to restart Intelligence Server. Click OK.
5. Restart Intelligence Server.
6. In Developer, right-click the project source that connects to the
Intelligence Server whose port number you changed and choose
Modify Project Source.
7. On the Connection tab, enter the new port number and click OK.

You must update this port number for all project sources in your
system that connect to this Intelligence Server.

To Ch an ge t h e Po r t N u m b er f o r M i cr o St r at egy Web

1. Open the Administrator page in MicroStrategy Web.

2. If your MicroStrategy Web product is connected to the Intelligence
Server whose port number you changed, click Disconnect to
disconnect it. You cannot change the port while connected to an
Intelligence Server.

It probably is not connected because the MicroStrategy Web product

does not yet know the new port number you assigned to Intelligence
Server.

Copyright © 2021 All Rights Reserved 788

In st allat io n an d Co n figu r at io n Gu id e

3. In the entry that corresponds to the appropriate Intelligence Server,

click Modify (in the Properties column, all the way to the right).
4. In the Port box, type the port number you want to use. This port number
must match the port number you set for Intelligence Server. An entry of
0 means use port 34952 (the default).
5. Click Save.

If the port numbers for your MicroStrategy Web product and

Intelligence Server do not match, you get an error when the
MicroStrategy Web product tries to connect to Intelligence Server.

Removing a Service from the Topology Monitor

The administrator may choose to install MicroStrategy products on a
machine, but not plan to configure them at the moment. To eliminate
confusion, the administrator can remove them from the topology monitor.

1. Navigate to /MicroStrategy/Services Registration/config in your

installation directory.
2. Delete the .json file that corresponds with the name of the service you
want to remove.
3. Navigate to the installation directory and delete the Services
Registration/data folder.
4. Restart the consul.

5. In Workstation, navigate to the Topology view and click the Refresh

button.

Copyright © 2021 All Rights Reserved 789

In st allat io n an d Co n figu r at io n Gu id e

6. Verify 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 stop
MicroStrategy Services Registration.

2. If you are using Linux, enter the following commands to start and stop
the 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 installation, you can see all configuration files for the service's
registration in the consul.json file, located in MicroStrategy/Services

Copyright © 2021 All Rights Reserved 790

In st allat io n an d Co n figu r at io n Gu id e

Registration/config, in your installation directory.

If you have a single machine environment or a multiple machine environment

with two machines, consul.json appears as follows:

{
"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 with three or more machines,

consul.json appears as follows:

{
"enable_debug": true,
"datacenter": "dc1",
"enable_script_checks": true,
"check_update_interval": "0s",
"log_level": "WARN",
"data_dir": "../data",

Copyright © 2021 All Rights Reserved 791

In st allat io n an d Co n figu r at io n Gu id e

"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"
]
}
],
"retry_join": [
"was-jinli.corp.microstrategy.com",
"wezhong-win1019.corp.microstrategy.com",
"was-pcheng.corp.microstrategy.com"
],
"server": true,
"bootstrap_expect": 3
}

In consul.json file, bootstrap_expect, refers to the number of machines

that act as communication agents in the environment. This is set on each
machine where you specify the communication agent only. Specify the
machines that act as communication agents in retry_join. This field is
specified on every machine where the MicroStrategy Services are installed
so that they can find the communication agents in the network.

To support machines with dynamic and multiple IP addresses, the

consul.json file is regenerated each time the service registration agent
restarts.

Copyright © 2021 All Rights Reserved 792

In st allat io n an d Co n figu r at io n Gu id e

Changing the Monitoring Agent to a Communication

Agent
You can change a monitoring agent to a communication agent by manually
modifying the installation_list.yaml file.

Manually modifying the installation_list.yaml file to change the agent from a

monitoring to a communication agent (or vice versa) is not recommended.
Only a MicroStrategy administrator should manually modify installation_
list.yaml to correct input mistakes during installation or reconfigure the
service registration agents in a cluster with manually deployed web
applications.

During the installation, when selecting a multiple machine environment, the

user must provide a list of communication agents. If the current machine
where installation is running is not in the list, it is not configured as a
communication agent. Instead, it is set as a monitoring agent only. If the
library server is manually deployed on a machine, the embedded service
registration agent is configured as a monitoring agent by default.

To manually change the monitoring agent to a communication

agent:
1. After installation, navigate to the directory MicroStrategy/Services
Registration/yaml.

2. Open installation_list.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

Copyright © 2021 All Rights Reserved 793

In st allat io n an d Co n figu r at io n Gu id e

- 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 file. If this is a two
machine environment and both machines are started as monitoring
agents, add "bootstrap_expect":1 instead.
5. Make sure the machine name is added in the retry_join list and only
three machine names are in the list. If this is a two machine
environment, make sure only one machine name is in the list. Save the
file.
6. Modify installation_list.yaml on all machines in the same consul cluster
by including the name of this machine in the retry_join list and make
sure only three machines are in the list. The list should be identical for
all machines in the same consul cluster.
7. Stop the consul on all machines in the same consul cluster. These
machines have the same retry_join list running as either a
communication or monitoring agent.
8. Navigate to the installation directory and delete MicroStrategy/Services
Registration/data.
9. Restart the consuls on all machines in the same consul cluster.

To switch one machine from a monitoring agent to a communication agent,

another machine previously running as a communication agent in the same
cluster should be switched to a monitoring agent. Do this by modifying the
installation_list.yaml file. Change the server value to false and remove
"bootstrap_expect".

Starting and Stopping Services

The topology view uses SSH authentication to start and stop services
remotely. If you are using Windows, the default Windows SSH configuration,

Copyright © 2021 All Rights Reserved 794

In st allat io n an d Co n figu r at io n Gu id e

TCP port 22, is used. The credentials are typically the machine
administrator's credentials. See Configuring SSH on Windows to configure
SSH on Windows. See Configuring SSH on Linux to configure SSH on Linux.

Configuring SSH on Windows

If SSH is not running or installed during your MicroStrategy installation, the
installer does not enable the feature to start and stop services in
Workstation. You must enable SSH server in Services Registration to start
and stop services in Workstation.

To configure SSH on Windows:

1. Install or enable SSH server on your Windows machine. If your

Windows machine has Windows 10 Fall Creators Update, Windows
Service 1809, or Windows Server 2019, you can follow the steps from
the following Microsoft websites:

Open SSH in Windows 10!

Windows Server 2019 Includes OpenSSH

Using the OpenSSH Beta in Windows 10 Fall Creators Update and

Windows Server 1709

2. To enable the built-in SSH server for older Windows versions, see
Install Win32 OpenSSH.
3. Configure and start your SSH server.
4. If you have firewall, open the SSH port in your firewall. For example,
port 22.
5. Navigate to C:\Program Files (x86)\MicroStrategy\Services
Registration\yaml and edit the installation_list.yaml file.

6. Make the following modifications:

l Modify "CommonPath" to the MicroStrategy Common Files

installation directory. By default, this path is C:\Program Files

Copyright © 2021 All Rights Reserved 795

In st allat io n an d Co n figu r at io n Gu id e

(x86)\Common Files\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 Files (x86)\MicroStrategy\Services

Registration\jar and run the following command to generate a new
JSON file 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 Service

Manager.
9. Open the Topology view in Workstation. Now you can start and stop
services.

Configuring SSH on Linux

MicroStrategy uses the SSH included with your Linux OS by default. If SSH
is not running at the time of your MicroStrategy installation, the installer
does not enable the feature to start and stop services in the Workstation
Topology view.

Copyright © 2021 All Rights Reserved 796

In st allat io n an d Co n figu r at io n Gu id e

To configure SSH on Linux:

1. Install OpenSSH by opening a terminal and running the following

commands with super user permissions.

On Ubuntu/Debian/Linux Mint:

# apt-get install openssh-server openssh-client

openssh

On RHEL/Centos/Fedora:

# yum -y install openssh-server openssh-clients

openssh

2. Start the service by typing the following commands in terminal:

# chkconfig sshd on
# service sshd start

3. If you have firewall, open the SSH port in your firewall. For example,
port 22.
4. Navigate to /opt/MicroStrategy/ServicesRegistration/yaml/ and open
the installation_list.yaml file.
5. Make the following modifications:
l Modify "CommonPath" to the MicroStrategy Common Files
installation directory. By default, 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

Copyright © 2021 All Rights Reserved 797

In st allat io n an d Co n figu r at io n Gu id e

Port: 22
Tags:
"version": "11.2.0000.0123"

6. Navigate to /opt/MicroStrategy/ServicesRegistration/jar and run the

following command to generate a new JSON file 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 following

command:

# java -jar <MSTR_INSTALL_

PATH>/ServicesRegistration/jar/svcsreg-admin.jar
control consul restart

8. Open the Topology view in Workstation. Now you can start and stop
services.

Supported MicroStrategy Platform Services

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

Executes
Intellige the query,
Intellige
nce reporting 34952 MSTRSv2_64.exe Yes
nce
Server and

Copyright © 2021 All Rights Reserved 798

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

analysis
server for
MicroStra
tegy
software.
Controls
security,
caching,
clusterin
g,
queueing
and
prioritizati
on.

Used by
Intelligenc
e to create
PDF files
PDF Exp
from MSTRPDFExportSe
ort Export 20100 Yes
document rvice.exe
Engine
s, reports,
and
dashboar
ds

A
Tomcat: 
personali
Library 8080 MicroStrategyLibrar
zed portal
Library No
Server for every https: y.war
8443

Copyright © 2021 All Rights Reserved 799

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

end user
to access
all their
dossiers
and report
services
document
s
(documen
ts). BI
authors
can easily
share
links to
dossiers
or
document
s, which
are
hosted in
MicroStra
tegy
Library.
End users
can log
into
MicroStra
tegy
Library to
find a list

Copyright © 2021 All Rights Reserved 800

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

at they
have
access to.

Allows
teams,
departme
nts, and
organizati
ons to
boost
analytics
adoption
via
interactive
discussion
Collabor threads Collabor
Collabor and an
ation 3000 server.js Yes ation
ation intuitive
Server Store
comments
panel.
With real-
time
alerts,
notificatio
ns, and
easily
shared
personaliz
ed views,
users

Copyright © 2021 All Rights Reserved 801

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

have a
holistic
view of
their
business
and
benefit
from
enhanced
teamwork.

Collabor
Collabor
ation
ation 27017 mongod.exe Yes
Reposit
Store
ory

An
interactive
interface
of the
MicroStrat
egy BI
platform http: 80
Mobile that lets
Mobile https: Admin.aspx Yes
Server mobile 443
business
users
harness
the
analytical
power of

Copyright © 2021 All Rights Reserved 802

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

MicroStrat
egy
through
the use of
their
Tomcat:
iPhone®,
8080 MicroStrategyMobil
iPad®, No
https: e.war
and
8443
Android™
devices.

A
browser-
based
client
interface
that
enables IT
to satisfy
the
diverse http: 80
Web
Web analytics https: main.aspx Yes
Server
needs of 443
every
enterprise
user—
consumer
s,
analysts,
data
scientists,

Copyright © 2021 All Rights Reserved 803

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

developer
s, and
administra
tors—
without
the burden
of
distributin
g and
maintainin 8080 MicroStrategy.war No
g multiple
software
packages.

A
distributed
streaming
platform
that stores
records
streams of

Messagi data in Telemetr

Telemetr topics.
ng 9092 kafka.exe Yes y
y Kafka
Server Manager
producers
allow an
applicatio
n, such as
Identity
and
Intelligenc

Copyright © 2021 All Rights Reserved 804

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

e, to
publish
records to
one or
more
topics.
The Kafka
consumer
s allows
applicatio
ns to
subscribe
to topics.

The
MicroStra
tegy
platform
Messagi Telemet messagin
ng ry g service 2181 zookeeper.exe Yes
Manager Manager that
coordinat
es the
Kafka
Cluster

Reads the
Platform data that
Analytics Telemetr Intelligenc PlatformAnalyticsC Telemetr
N/A Yes
Consum y Store e and onsumer.exe y Server
er Identity

Copyright © 2021 All Rights Reserved 805

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

send to
Telemetry,
transforms
the data,
and loads
it into the
Platform
Analytics
warehous
e.

An in-
memory
cache
used to
optimize
In-
Telemet performa
memory 6379 redis-server.exe Yes
ry Cache nce for
Cache
the
Platform
Analytics
Consume
r.

Reposito
3306 mysqld.exe Yes
ry

A highly
scalable, ssl: 1443
Security
Identity two-way ROOT.war Yes
Server
ssl: 2443

Copyright © 2021 All Rights Reserved 806

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

flexible,
and easy
to
maintain
system
built on
industry
standards
such as
Security
Assertion
Markup
Language
(SAML),
Open
Authoriza
tion
(OAuth)
2.0 and
OpenID
Connect.
The
server
synchroni
zes
identities
with
enterprise
identity

Copyright © 2021 All Rights Reserved 807

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

stems of
record,
and
presents
those
identities
to Badge
clients for
authentic
ation. The
Identity
server
can be
installed
on
premises
or in the
MicroStra
tegy
Cloud
environm
ent as
single-
tenant. It
can host
multiple
Badge
networks.

Copyright © 2021 All Rights Reserved 808

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

A
mechanis
m (also
known as
a
connector)
that
permits
communic
ation
between
Identity
server and
a secured
Gateway Identity asset. It two-way
represents gateway.war Yes
Server Gateway ssl: 9501
a bi-
directional
secure
communic
ation
connectio
n used by
the
Identity
server to
communic
ate with
user

Copyright © 2021 All Rights Reserved 809

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

repositori
es hosted
in IDM
systems
and
PACS,
and for
logical
resources.
Each
gateway is
deployed
as a web
service
which
ensures
secure
communic
ation
between
the
Identity
server,
IDM
systems,
PAC
systems,
and
logical
resources.

Copyright © 2021 All Rights Reserved 810

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

The group
of users
in your
organizati
on who
can use
the Badge
app on
their
smartpho
ne to
validate
their
identity,
log on to
Network Identity Window networkmgr
applicatio No
Manager Manager s: 443 httpd.exe
ns, gain
access to
secure
physical
resource
s, and so
on.
Identity
Manager
is the
administr
ative
console
that

Copyright © 2021 All Rights Reserved 811

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

allows
you to
manage
an
organizati
on’s
network of
users,
configure
access to
Badge-
enabled
systems
and
resource
s, and
distribute
digital
badges
and keys.

Highlights
services
lacking
SSL
Certifica
Certifica support, CertificateManager.
te 5050 Yes
te Store tracks exe
Manager
current
and
pending

Copyright © 2021 All Rights Reserved 812

In st allat io n an d Co n figu r at io n Gu id e

Workst
Old New ation
Service
Service Service Default Start/St Depend
Descripti Executable
Display Display Port op ency
on
Name Name Suppor
ted

certificate
expiration
s.
Presents
visual
cues
about
expiring or
already
expired
certificate
s across
the entire
MicroStrat
egy
deployme
nt.

Starting in version 2019, some of the service names have been changed to
better explain their behavior. See the online readme corresponding to your
software version for a list of the changes.

MicroStrategy Logging Consumer, MicroStrategy Listener, SSH, and

MicroStrategy Registration Service are not monitored.

If using clusters, make sure that all machines in the Web server cluster can
communicate with all machines in the Intelligence Server cluster.

Modification of the port the agents use to communicate is currently not

supported.

Copyright © 2021 All Rights Reserved 813

In st allat io n an d Co n figu r at io n Gu id e

Troubleshooting Topology
This section covers issues that may occur in Workstation and how to correct
them.

How to enable debug logging

Debug logging records errors and other useful information for why an issue
occurred. For steps to enable debug logging, see KB483668: How to Enable
Debug Logging for Topology.

How to update service ports for the service registration/topology

monitor
1. Navigate to the service configuration folder at
/MicroStrategy/ServicesRegistration/config. Edit the file for the service
running with a non-default port number by updating the run-time port
number 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"
}

Copyright © 2021 All Rights Reserved 814

In st allat io n an d Co n figu r at io n Gu id e

}
}

2. Save the file and restart the service registration agent.

Service registration does not work when there is no network

connection
If there is no network connection after installation, the service registration
still works for all local services. If not, make sure the user logging into the
machine is a local administrator. A user with adequate privileges for service
registration, when connected to the network, might not have full
administrator privileges locally when there is no network connection.

The service registration agent cannot start and No private IPV4

address found is found in the log file
1. If the machine has more than one IP address, see Configuring
Environments with Multiple IP Addresses
2. If the machine has only one IP address, check the network setting using
the following command, if the IPv4 is not in the list of acceptable private
(RFC1918) addresses provided in the table below.

On Windows:

ipconfig/all

On Linux:

ifconfig -a

Copyright © 2021 All Rights Reserved 815

In st allat io n an d Co n figu r at io n Gu id e

Number Largest
RFC19 Host Mas Classful
IP Address of CIDR Block
18 ID Siz k Descripti
Range Address (Subnet
Name e Bits on
es Mask)

10.0.0.0 - Single
24-bit 16,777,21 10.0.0.0/8
10.255.255.2 24 bits 8 bits class A
block 6 (255.0.0.0)
55 network

172.16.0.0/1 16
172.16.0.0 -
20-bit 2 12 contiguous
172.31.255.25 1,048,576 20 bits
block (255.240.0. bits class B
5
0) networks

192.168.0.0/ 256
192.168.0.0 -
16-bit 16 16 contiguous
192.168.255. 65,536 16 bits
block (255.255.0. bits class C
255
0) networks

3. Check whether the network configuration is intended. If so and you

want to use service registration, complete steps 4 and 5 for a
workaround to bind the service registration agent to the non-acceptable
IPv4 address.
4. Navigate to the Services Registration\yaml folder.
5. Edit the installation_list.yaml file by adding bind_addr: x.x.x.x to the
consul section. Make sure to include a space between the colon and the
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

Copyright © 2021 All Rights Reserved 816

In st allat io n an d Co n figu r at io n Gu id e

- 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 Services

Registration\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 install path at
\Service Registation\bin.
2. Execute the following command.

On Windows:

consul members

On Linux:

./consul members

3. Verify the returned list to see whether it is consistent with the cluster
configuration. Look at machine names and number of machines with
communication agents running, machine names and number of
machines with monitor agents running, status of these agents. etc.

"MicroStrategy Services Registration is NOT available, please

check the service status."
While using Workstation Topology to monitor services, an empty page
appears with the message, "MicroStrategy Services Registration is NOT
available, please check the service status." Follow the steps below to
troubleshoot this issue.

Is the service registration agent running on the Library machine to which

Workstation is connecting?

Copyright © 2021 All Rights Reserved 817

In st allat io n an d Co n figu r at io n Gu id e

Log into the machine where Library is installed and check whether
MicroStrategy Services Registration is running. On Windows, use the
Windows Service Manager. On Linux, use ps -ef | grep consul.

If the agent is running, check whether the cluster agent is forming

successfully. See How to update service ports.

1. If there is a firewall on the machine in which Library is installed, make

sure the 8300(TCP) and 8301(TCP/UDP) ports are open.
2. Try to ping the machines listed in Services
Registration/config/consul.json for "retry_join" to ensure the machines
can be accessed.
3. Make sure the leader election is complete. Check the
ServicesRegistration log file with the latest time stamp in the Services
Registration/log folder. If you see the message, "failed to sync remote
state: No cluster leader" follow steps 4 and 5. Otherwise, skip to step 6.
4. The correct cluster configuration should be verified on every machine
with a service registration agent. Check the configuration of the cluster.
There should be one or three communication agents defined in the
cluster as specified in the "retry_join" list of the installation_list.yaml
file. This list should be consistent on all nodes.
5. Make sure there is no dirty data in the Services Registration/data
folder. After unsuccessful cluster forming or modification of cluster
members, there may be invalid data left in the data files. Stop all
agents, delete the Services Registration/data folder on every cluster
node and restart all agents to form the cluster.
6. If MicroStrategy Library is deployed on a machine where MicroStrategy
Services are not installed, go to the Application Server managing the
consul and restart the MicroStrategy Library deployment. If the agent is
not running, check the ServicesRegistration log file with the latest time
stamp in the Services Registration/log folder to see why the agent did
not start. If the message, "No private IPv4 address found" appears, see
The service registration agent cannot start.

Copyright © 2021 All Rights Reserved 818

In st allat io n an d Co n figu r at io n Gu id e

If the agent is not running, check the ServicesRegistration log file with the
latest time stamp in the Services Registration\log folder to see why the
agent cannot start.

Does the machine have multiple IP addresses? Were all IPs available when
installing the product?

Does the machine have an unacceptable IP address? If the agent hit "No
private IPv4 address found," see The service registration agent cannot start.

How was the MicroStrategy Library WAR file deployed on the server?

There may be issues if the Linux server was not upgraded properly. For
example, if you upgraded to 11.0 from 10.10 on a Linux server, did not run
the MicroStrategy installer, but downloaded and copied the WAR file. In this
situation, see Install MicroStrategy in the In-Place Upgrade on a Linux
Deployment section of the Upgrade Help and Deployment Scenarios in the
Installing MicroStrategy Library on Linux section of the Upgrade Help.

Are the nodes communicating with each other through network address
translation (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 additional
information in the tooltip.
2. Review the possible causes provided in the tooltip.
3. Verify the service is running. Log into the machine where the service is
installed. Verify it is running in Windows Service Manager.
4. Verify the required port is available. If the service fails to start, check to
see whether the required port is available. See Supported
MicroStrategy Platform Services to view the default ports.
5. Verify the proper port is in the configuration file. If the service is
running, but Workstation shows the service is down, check the

Copyright © 2021 All Rights Reserved 819

In st allat io n an d Co n figu r at io n Gu id e

configuration file (such as MicroStrategy Mobile Server JSP.json) for

this service. The configuration file is located in the installation directory
at MicroStrategy/Services Registration/config. Check to see if the port
number, http port number, and https port number are consistent with
the port used for the service.
6. If the ports are correctly defined in the service.json file, but Workstation
still shows the service is down, copy the URL for the health check from
the service.json file. Paste the URL in your browser to see if it is a valid
link. If the link does not work, replace "localhost" with the IP address of
the machine from which you are accessing the URL and try again.
7. Check the log file at /MicroStrategy/Services Registration/log in your
installation 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 must manually update the JSON file with the post-install configured
port number and restart the MicroStrategy Service Registry. Please refer to
How to Update Services Ports.

Unable to start or stop a service

1. Connect to an environment, making sure the corresponding user login
has adequate privileges. In Workstation, log into an environment as a
MicroStrategy user with administrator privileges or as an administrator
user of the web container for the Library. In maintenance mode, go to
the topology view and verify that start/stop capability is supported for a
service, by right-clicking on the service. If the Start and Stop options in
the pop-up menu are grayed out, the start/stop capability is not
supported for that service.
2. Verify SSH is available and running on the machine with the service. If
not, see Configuring SSH on Windows or Configuring SSH on Linux.
3. Verify the firewall is enabled and port 22 is open on the firewall.

Copyright © 2021 All Rights Reserved 820

In st allat io n an d Co n figu r at io n Gu id e

4. Verify the service status in a refreshed view. If a user has sent the start
or 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. Verify that the machine where the service is hosted is reachable from
the MicroStrategy Library machine.
2. If there are firewalls in the environment, verify that the ports (8300 and
8301) are open to support sending and receiving TCP/UDP requests
between the machines hosting the services.
3. Verify that the agent is running. On Windows, use the Windows Service
Manager to check whether MicroStrategy Services Registration is
running. On Linux, use ps -ef | grep -i consul.

Consul does not start after installing MicroStrategy 2019 Update

2 Hotfix on a Linux machine
The nslookup tool is missing if Redhat Enterprise Linux 7 is installed using
the minimal option. Consul depends on the nslookup command to resolve a
machine's IP address from the fully-qualified domain name (FQDN). To
ensure that Consul can be started successfully, install the missing tool by
executing the following command in a terminal:

# yum install bind-utils

Customized Deployments
Case 1: When installing topology in a two machine environment,
MicroStrategy services are installed without the multiple machines option.
As a result, you will need to manually configure the consul cluster after the
installation. In this case, Library was deployed through the installer and both
the Library and Web servers are on the same machine. iServer is installed
on another machine. First, make sure the required ports are open.

Copyright © 2021 All Rights Reserved 821

In st allat io n an d Co n figu r at io n Gu id e

On the Library server m achine:

1. Navigate to the MicroStrategy/Services Registration/yaml directory.

2. Open installation_list.yaml and locate the consul section.
3. Verify the server parameter is set to true.
4. On Windows, use the Service Manager (Run > services.msc) to open
services. Verify that MicroStrategy Services Registration is running.

On the Intelligence server m achine:

1. Navigate to the MicroStrategy/Services Registration/yaml directory.

2. Open installation_list.yaml and locate the consul section.
3. Add the retry_join parameter with the FQDN of the Library server, so
the Intelligence server can point to it.
4. Make sure the format for retry_join matches that shown in Changing the
Monitoring Agent to a Communication Agent.
5. Remove the entire bootstrap_expect line, including the parameter
name, and change server: true to server: false.
6. Save the file.

On both m achines:

1. Stop the consul on all machines. In this case, there are two machines.
2. On Windows, use Service Manager (Run > services.msc) to stop
MicroStrategy Services Registration.
3. On Linux, refer to Restarting the Consul to stop MicroStrategy Services
Registration.
4. Navigate the installation directory and delete MicroStrategy/Services
Registration/data.
5. Restart the consuls on all machines in the same consul cluster.

Case 2: JBoss is running on the same machine as the Intelligence server.

Both Web and Library are installed, but deployed in JBoss.

Copyright © 2021 All Rights Reserved 822

In st allat io n an d Co n figu r at io n Gu id e

1. Since Web and Library are on the same machine, both MicroStrategy
Web Server JSP.json and MicroStrategy Library REST Server.json are
available in the ServicesRegistration/config install folder. Update both
files with the port number used for the Web and Library JBoss
deployment, if necessary.
2. Perform a health check by going to
http://localhost:8080/MicroStrategyLibrary/health and
http://10.248.128.29:8080/MicroStrategy/health. Replace 8080 with the
port number running Web and Library. If this does not work, try
replacing the localhost with 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 from

Workstation
In certain situations, the installer may fail to generate the JSON files for
MicroStrategy Services, such as the Intelligence Server, Platform Web,
Library, Collaboration Server, and others. As a result, the config sub-folder
may not be generated inside the Services Registration installation directory,
or the config folder may only contain a single JSON file. When either of
these situations occur, several or all services cannot be monitored or
controlled via Workstation.

To resolve this issue, go to the problematic node and execute the following
steps.

1. Navigate to the jar folder in the Services Registration installation

directory.

Windows:

C:\Program Files (x86)\MicroStrategy\Services Registration\jar

Linux:

Copyright © 2021 All Rights Reserved 823

In st allat io n an d Co n figu r at io n Gu id e

/opt/MicroStrategy/ServicesRegistration/jar

2. Run the following command:

# java -jar svcsreg-admin.jar parse

3. Verify that the JSON files are generated under the config folder.

4. Restart MicroStrategy Services Registration.

In Windows, perform the restart through Windows Service Manager.

In Linux, execute the following command:

# java -jar svcsreg-admin.jar control consul restart

5. Open the Topology tab in Workstation. Now you should be able to

monitor the status of services and also issue start and stop commands
to MicroStrategy services.

How to update service ports for the Service

Registration/Topology monitor
1. Navigate to the yaml folder in the Services Registration installation
directory.

Windows:

C:\Program Files (x86)\MicroStrategy\Services Registration\yaml

Linux:

/opt/MicroStrategy/ServicesRegistration/yaml

2. Edit the installation_list.yaml file with the port corresponding to the

desired MicroStrategy service.

For example:

---
service:

Copyright © 2021 All Rights Reserved 824

In st allat io n an d Co n figu r at io n Gu id e

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

4. Manually run parser using the following command:

Replace <serviceName> with the name of your service. In the above

example, this would be MySQL.

java -jar svcsreg-admin.jar parse <serviceName>

Configuring Environments with Dynamic or Multiple IP

Addresses
Automatic configuration of agent clustering is limited for machines with
dynamic or multiple IP addresses. In some cases, manual configuration is
required. See Configuring Environments with Nodes Using Dynamic IP
Addresses and Configuring Environments with Multiple IP Addresses for
more information.

Configuring Environments with Nodes Using Dynamic IP

Addresses
If you are using a single machine environment with a dynamic IP address
and connecting Workstation to Library, you may encounter errors when
accessing the Topology screen in Workstation.

After installation is finished and the machine is restarted, the communication

agent may start before the network IP is fully resolved and ready on the

Copyright © 2021 All Rights Reserved 825

In st allat io n an d Co n figu r at io n Gu id e

machine. Therefore, the communication agent may obtain a temporary IP

during the startup and consider it as the fully resolved one . Using the wrong
IP on the machine affects the communication agent's function. If this
problem continues to occur, a manual restart of the consul is required. See
Restarting the Consul for more information.

We do not recommend using machines with dynamic IP addresses as

communication agents in a cluster. If your environment includes more than
one machine and machines with dynamic IP addresses are used as
communication agents, use FQDN (such as machine1.domain.com) in the
communication agent machine list during installation.

If FQDN is not used, you should manually update the "retry_join" section in
consul.json on all machines with communication and monitoring agents
when all machines with dynamic IP addresses are fully resolved, every time
those machines get new IPs.

{
"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"
]
}
],

Copyright © 2021 All Rights Reserved 826

In st allat io n an d Co n figu r at io n Gu id e

"retry_join": [
"10.27.16.239",
"localhost",
"10.27.17.238"
],
"server": true,
"bootstrap_expect": 3
}

Configuring Environments with Multiple IP Addresses

We do not recommend using machines with more than one IP address as a
communication agent. If your environment includes one or more machines
and machines with more than one IP address are used as communication
agents, make sure all IPs are available when installing. The IP mapping to
the FQDN of the machine is included in the consul.json file, as shown below.

{
"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"
]
}
],
"retry_join": [

Copyright © 2021 All Rights Reserved 827

In st allat io n an d Co n figu r at io n Gu id e

"SAP-W10-ent",
"localhost",
"10.27.17.238"
],
"server": true,
"bind_addr": "10.21.20.188",
"bootstrap_expect": 3
}

If a machine has two available IP addresses, the consul may bind itself to
one IP mapping for FQDN, while other machines use FQDN mapping to
another IP. In this situation, you should manually modify consul.json. The IP
used for "bind_addr" should be consistent with the IP the other machine
finds using the FQDN; the IP for "bind_addr" and the IP (if not using FQDN )
in "retry_join" list representing this machine should be consistent. After all
manual modifications of consul.json are complete on all machines with
consul installed, stop the consul on all machines, delete the data folder in
path/MicroStrategy/Services Registration on every machine, and restart all
consuls.

If MicroStrategy is installed when only one IP is available and runs later

when multiple IPs are available, the consul will not start. The
ServiceRegistration.log displays the error, "Multiple private IPv4 addresses
found. Please configure one."

Using FQDN for the communication agent machine list during the installation
is recommended. If the IP address list is used during installation, make sure
to use the IP mapping to the FQDN for the machine with multiple IPs.

Machines with more than one IP address, as well as dynamic IPs, are not
supported for automatic clustering.

Certified Operating Systems for Topology

The following operating systems are certified for topology:

Copyright © 2021 All Rights Reserved 828

In st allat io n an d Co n figu r at io n Gu id e

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 following web containers are certified for topology:

l Apache Tomcat 8.5.30

l Apache Tomcat 9.0.12

l WebLogic 12cR2 (12.2.1.3.0)

l WebSphere Application Server 9.0
l Wildfly 13
l Wildfly 14
l JBoss EAP 7.1
l Jetty 9.4

See Set Up Application Servers for more information about setting up

application servers.

Copyright © 2021 All Rights Reserved 829

In st allat io n an d Co n figu r at io n Gu id e

Ho w t o In st al l t h e Ker b er o s
Au t h en t i cat i o n Ser vi ce
1. Install Kerberos KDC server and client.

a. Download and install the krb5 server package.

rpm -ivh krb5-server-1.10.3-10.el6_4.6.x86_64.rpm

Verify that the following rpm packages are installed before

configuring 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. Install via yum.

On the KDC server:

yum install krb5-server krb5-libs krb5-auth-

dialog

On the Kerberos client:

yum install krb5-workstation krb5-libs krb5-auth-

dialog

2. Modify the /etc/krb5.conf file.

Modify /etc/krb5.conf to look like the code below with the

appropriate REALM and DOMAIN_REALM mappings. krb5.conf can
be found in /etc by default.

Copyright © 2021 All Rights Reserved 830

In st allat io n an d Co n figu r at io n Gu id e

[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. Modify the KDC.conf file.

Log in to the KDC server and modify

/var/kerberos/krb5kdc/kdc.conf as follows:

[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

Copyright © 2021 All Rights Reserved 831

In st allat io n an d Co n figu r at io n Gu id e

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

The users can be granted administrator privileges to the database

using the file /var/kerberos/krb5kdc/kadm5.acl.

*/[email protected] *

In the above example, any principal in the MYREALM with an admin

instance has all administrator privileges.

5. Create a principal.

Create the principal using the command addprinc. For example,

create a principal with 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 following command creates the principal database in

/var/kerberos/krb5kdc.

kdb5_util create -r $realm -s

If the database already exists, it will remove all the related files in
/var/kerberos/krb5kdc. By default, the database name is
"principal." You can add the -d flag to rename the database.

Copyright © 2021 All Rights Reserved 832

In st allat io n an d Co n figu r at io n Gu id e

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 ]

Copyright © 2021 All Rights Reserved 833

In st allat io n an d Co n figu r at io n Gu id e

Tr o u b l esh o o t i n g
This appendix provides information on common problems that you might
encounter while installing and configuring MicroStrategy on Linux and
Windows operating systems.

Reviewing General Installation Errors

Any errors in your MicroStrategy installation are written to the
install.log file.

Review errors found in install.log

1. Browse to LOG_PATH where LOG_PATH in the directory you specified

as the Install Directory during installation

2. Open the install.log file.

l For Linux, it can be found in the log directory.

l For Windows, it can be found in the common files.
3. Review the error messages.

Graph and Document Support of Non-Western

European Fonts
If your Linux system uses non-Western European fonts, you may see
indiscernible values returned in place of text on your graphs when accessed
through MicroStrategy Web. This also occurs for Report Services documents
when accessed through MicroStrategy Web or any other MicroStrategy client

Copyright © 2021 All Rights Reserved 834

In st allat io n an d Co n figu r at io n Gu id e

application (such as Developer) that connects to an Intelligence Server

connected (three-tier) project source.

To support non-Western European fonts, copy True Type fonts into the
Intelligence Server installation directory. Copy these fonts, which have a .ttc
or .ttf extension, to INTELLIGENCE_SERVER_INSTALL_
PATH\PDFGeneratorFiles. The default installation path for the
Intelligence Server in Linux is
home\MicroStrategy\PDFGeneratorFiles. For the change to take
effect, you must restart Intelligence Server.

Server Port Number Errors

I Forgot the Server Port Number

1. Open MicroStrategy Service Manager.
l Windows: From the Start menu, go to Programs > MicroStrategy
Tools > Service Manager.
l Linux: In a Linux console window, browse to HOME_PATH where
HOME_PATH is the specified home directory during
installation.Browse to the folder bin and type ./mstrsvcmgr, then
click Enter. MicroStrategy Service Manager opens.
2. Click Options.
3. Click Intelligence Server Options tab to view the port number.

Port Number is in Use

1. Browse to your target directory. This is the path indicated during
installation as the Directory Name.
2. Browse to the folder bin and type mstrctl –s
IntelligenceServer di FindingPortNumber, then click Enter.
3. Type mstrctl –s IntelligenceServer ci
FindingPortNumber, then click Enter.

Copyright © 2021 All Rights Reserved 835

In st allat io n an d Co n figu r at io n Gu id e

4. Type mstrctl –s IntelligenceServer gs

FindingPortNumber, then click Enter.
5. An XML file 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 connection errors.

Testing the DSN connection failed in DSN Creator

1. In MicroStrategy Connectivity Wizard, go to the Driver Details page and
review all the information.
2. Click each of the boxes and read the comments at the bottom of the
window.
3. Enter the information required for each box and click Test.

Metadata and Other Repository Creation Errors

This section provides troubleshooting information on metadata, History List,
and statistics repository creation errors.

The errors listed below do not cover errors that can occur because a user
does not have the correct database permissions to create a metadata,
History List, or statistics repository. For information on providing the proper
database permissions to create these repositories, see Required database
permissions to create metadata, History List, and statistics repositories,
page 392.

Creating a Metadata Fails Due to Insufficient Page Size

When creating a metadata within a IBM DB2 database, the following error
and resulting error message can be encountered:

Invalid Page Size for DB2 UDB Metadata

Copyright © 2021 All Rights Reserved 836

In st allat io n an d Co n figu r at io n Gu id e

This can occur when an IBM DB2 database user has access to a tablespace
that does not have the space requirements necessary for the metadata
repository. The MicroStrategy metadata repository requires a page size of at
least 8 KB.

To avoid this error, it is recommended to revoke access to any tablespaces

that are lower than 8 KB in page size for the user account that is creating the
metadata. The user must also have access to a tablespace with a page size
of at least 8 KB. Contact your database administrator to perform this user
configuration.

Creating a History List Repository Fails Due to Insufficient

Page Size
When creating a History List repository within a Sybase database, the
following error and resulting 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 size
requirements necessary for the History List Repository. To solve this error,
contact your database administrator to increase the current available space
(PageSizeLimit in the error message above) for the table space to be
large enough to store the History List repository (PageSizeRequirement
in the error message above). As a general rule, the page size for the History
List repository should be at least 4 KB.

Permission Errors
This section provides troubleshooting information on permission errors in a
Linux environment.

Copyright © 2021 All Rights Reserved 837

In st allat io n an d Co n figu r at io n Gu id e

Incorrect "nice" Value Limit

To improve performance under high CPU loads, the Intelligence Server
prioritizes the execution of time-critical jobs, such as interactive dossier
execution, over background requests, like Smart Downloads. To achieve
such a job prioritization mechanism, the threads that execute interactive
jobs are allowed to occupy a larger chunk of CPU time. Equivalently, threads
for background requests are assigned with a smaller CPU time chunk.

In the Linux OS, a thread's CPU chunk size is controlled by its nice value,
which has an inverse relation to CPU time (and priority). To execute every
incoming job or request with the correct priority, the Intelligence Server
picks one or more threads from a pool, dynamically assigns the threads with
a correct nice value to execute the job or request, and then resets the nice
value to the default value of 0, before returning the threads back to the pool.
This dynamic nice value assignment, especially for resetting to 0 after
increasing the nice value (de-prioritization) of background requests' threads,
requires the configuration of a user-level limit for nice.

To ease deployment complexity, the MicroStrategy installer automatically

configures the nice value, as long as it was run by a root user. Otherwise,
if the installer is run by a non-root user, the nice limit cannot be
configured and the following messages are displayed.

l The MicroStrategy installer will display any of the following messages

below at the end of the installation process.

Copyright © 2021 All Rights Reserved 838

In st allat io n an d Co n figu r at io n Gu id e

l A similar message is displayed to the standard output when the installer is

run from command line. On the other hand, if the installer is run in silent
mode, the following entries are added into the install.log file.

3 Jun 2020, 11:35:27 AM:SEVERE: Failed to set MicroStrategy Intelligence

priority process settings
3 Jun 2020, 11:35:27 AM:SEVERE: Priority process settings for
MicroStrategy Intelligence doesn't meet the requirements
3 Jun 2020, 11:35:27 AM:SEVERE: Root privileges are required to configure
the nice limit to 0 or lower

l Despite the above error message, the Intelligence Server can still be
started after the installation is complete. To verify the incorrect nice
limits when the Intelligence Server is running, open the DSSErrors.log
file and search for the following entries:

... [Kernel][Error] ... The maximum scheduling priority ("nice")

returned by "ulimit - e" has a value of %1. It does not satisfy the job
prioritization feature's requirement that expects a value of 20 or

Copyright © 2021 All Rights Reserved 839

In st allat io n an d Co n figu r at io n Gu id e

higher. Please refer to the man page of "ulimit".

... [Kernel][Info] ... The job prioritization feature is disabled.

To fix the problem, you must configure the maximum nice limit, which can
be checked using the ulimit -e command, until the correct value of 20, or
higher, is returned. To configure and check the nice limit, refer to the
following steps:

1. Stop the Intelligence Server if it is running.

2. Using the superuser privilege (e.g., with sudo command), create a new
configuration file. MicroStrategy recommends that you use the name
mstr-priority.conf under the /etc/security/limits.d folder.

3. Add the following entries to the configuration file:

mstr hard nice 0

mstr soft nice 0

4. Save the configuration file.

5. Restart your existing session to apply the new limits. You can simply
disconnect from and reconnect to the new session when using SSH.
When using VNC, you can restart the service, such as using a
systemctl restart vncserver@:1.service command, and then
reconnect to the session. In both cases, make sure mstr user is used
to reconnect.
6. Verify the setting by executing ulimit -e and confirm that the
returned value is 20, or higher.
7. Restart the Intelligence Server.
8. Check the DSSErrors.log to verify that there is no error message
regarding the nice limit and the job prioritization is enabled.

The settings described above modify only the maximum nice value for the
mstr user and should not affect other users. You should be aware of the

Copyright © 2021 All Rights Reserved 840

In st allat io n an d Co n figu r at io n Gu id e

following two special scenarios:

l You must replace mstr with the user name that will run the Intelligence
Server in the steps above. By default, the MicroStrategy installer creates
an mstr user for this purpose, but you can choose another user during or
after the installation.

l When running the Intelligence Server through a VNC session that was

started using systemd, step 6 may not return the correct value, 20, due
to this known Linux issue. To address this issue, add the following setting
to /etc/systemd/user.conf and /etc/systemd/system.conf:

DefaultLimitNICE=20

To apply the setting, run systemctl daemon-reexec and restart your

VNC session, such as using a systemctl restart
vncserver@:1.service command. Alternatively, you can reboot your
machine.

l Your Linux machine may have additional user or system-level limit

settings that prevent ulimit -e from returning the correct value of 20,
or higher. In this case, please review the available limit settings for your
specific Linux distribution.

Core Dump File Problems

Core dumping is functioning properly if the core file is generated under the
target folder, for example, /<path_to_the_location>/core, during a
server crash. The steps to verify this functionality on Linux operating system
(OS) is outlined below.

1. Get the Intelligence server’s process ID by executing ps -ef | grep

-i mstrsvr. The process ID is 6837 in the example below.

$ ps -ef | grep -i mstrsvr

mstr 6837 1 2 12:15 ? 00:02:37
/opt/mstr/MicroStrategy/install/IntelligenceServer/bin/MSTRSvr -s -w

Copyright © 2021 All Rights Reserved 841

In st allat io n an d Co n figu r at io n Gu id e

/opt/mstr/MicroStrategy/IntelligenceServer -t status-iserver.xml
/opt/mstr/MicroStrategy/install/lib/libMSTRSvr2.so -n CastorServer
mstr 32481 32391 0 14:12 pts/0 00:00:00 grep --color=auto -i
mstrsvr

2. Simulate a server crash by running a sudo kill -6 <server_

process_id> command.

3. Verify that a core file is generated under the target folder. For example,
/<path_to_the_location>/core. The core file size should be non-
zero.

If the core file is not generated according to the procedure above, you
should identify the root cause. The possible causes and steps to fix them are
outlined below.

Invalid or Missing Linux Operating System Configuration

See Software Requirements and Recommendations for the correct OS
configuration to enable core dumping. Make sure to restart Intelligence
server after applying the settings.

Missing Configuration when Intelligence Server is Registered

as a Service
Your Linux machine may need a reboot to apply the OS-level core dump
configuration. If core dumping is still disabled after reboot, the default user
profile may have disabled the creation of core files for processes launched
in the init phase (during machine reboot). To fix this, apply the steps below.

1. Using the root permission, open the /etc/init.d/mstr-

<InstallName>-iserver-CastorServer init script. Typically,
<InstallName> is of the form of user@timestamp. Locate the
following lines.

start ()
{

Copyright © 2021 All Rights Reserved 842

In st allat io n an d Co n figu r at io n Gu id e

2. Below the located lines, add the following command to allow

Intelligence server to start as a service with the core file enabled.

ulimit -c ulimited

Insufficient Disk Space

You must ensure that the disk, where the core file will be written into, has
sufficient free space. Note that the core file is written to the directory
specified for kernel.core_pattern (see Enabling core dump for details),
while the expected core files size is identical to the memory footprint of the
Intelligence server when it crashed. Also, please ensure that the creation of
large files (more than 2GB) is supported, when your machine uses Network
File System (NFS).

Alternative: Process Core Files using ABRT in RedHat

Enterprise Linux 6 and Newer
RedHat Linux version 6.x and newer are shipped with an Automatic Bug
Reporting Tool (ABRT) that automatically collects and stores core dump files
into the /var/spool/abrt folder. If this is preferred, additional steps are
needed to ensure Intelligence server’s core dumping can work together with
ABRT. For a detailed explanation, please refer to the official explanation
regarding ABRT.

1. If you have followed the steps in Enabling core dump, please comment
out or remove the following lines from /etc/sysctl.conf.

kernel.core_pattern = /<path_to_the_location>/core/core.%e.%p.%h.%t
fs.suid_dumpable = 2

2. Enable core dump collection for Intelligence server, which is not signed
or packaged by RedHat. Do this by applying the following lines into
/etc/abrt/abrt-action-save-package-data.conf:

OpenGPGCheck = no
ProcessUnpackaged = yes

Copyright © 2021 All Rights Reserved 843

In st allat io n an d Co n figu r at io n Gu id e

3. Configure the folder where the core file will be saved, by adding the
following parameter to /etc/abrt/abrt.conf. By default, the
parameter is commented out and has a value of /var/spool/abrt .

DumpLocation =/Your_desired/Path_to_generate/the_core_file

4. Restart the ABRT service to apply the above-mentioned settings. Make

sure you run these commands as root.

# service abrtd restart

# service abrt-ccpp start

5. Trigger core dumping and verify that the core file can be created by
executing the command below. It is critical to execute this from the
/IntelligenceServer folder and note the location of the core file
created.

# gcore -o <file> <pid>

Several important notes:

1. Ensure that the DumpLocation exists and is writable by the ABRT

process.
2. If you customize the DumpLocation, make sure it is different than the
folder specified for WatchCrashdumpArchiveDir, which is another
settings in the abrt.conf file.
3. If the core file is truncated or still not being dumped, you can review the
system message logs in /var/log/messages to investigate why core
dumping fails.

Copyright © 2021 All Rights Reserved 844