MicroStrategy Upgrade Guide · locationisC:\Program Files (x86)\MicroStrategy\Mobile Server ASPxor\Mobile Server JSP.Then,afteryouhave upgradedMobileServer,copythecontentsofthebacked-updirectoryto

$Page 1: MicroStrategy Upgrade Guide · locationisC:\Program Files (x86)\MicroStrategy\Mobile Server ASPxor\Mobile Server JSP.Then,afteryouhave upgradedMobileServer,copythecontentsofthebacked-updirectoryto$
Upgrade Guide

Version 2020

Micr o St r at egy 2020

Ju n e 2020

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

Trademark Information

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

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

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

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

CONTENTS

Planning Your Upgrade 4

Determine Your Upgrade Methodology 4

Pre-Upgrade Administrative Tasks 5

Upgrade Prerequisi tes 7

Upgrade Best Practices 8

The Upgrade Process Checkl ist 10

Executing the Upgrade 12

Performing an In-Place Upgrade 13

Performing a Paral lel Upgrade 68

Using MicroStrategy Backup and Restore 120

Validating the Upgrade 155

URL Scanner - Identi fy URLs for Export 155

Integri ty Manager - Upgrade Impact Testing 159

MicroStrategy Capaci ty Testing Tool 167

Upgrade Analysis Dossier 200

Resolving Problems Encountered During the Upgrade 211

Supplemental Information 213

Appl ication Servers 213

Using a Response Fi le wi th Configuration Wizard 288

Defining DSNs 312

Speci fying Warehouse Connection Information 316

Minimizing the Impact of Data Changes for Platform Release Upgrades 335

Copyr ight © 2020 All Rights Reserved 4

Plann ing You r Upgr adeUpgrading to MicroStrategy 2020 can have a signi ficant effect on yoursystem. New features and enhancements may cause changes to userworkflows as wel l as the data returned by report executions. To ensure asuccessful upgrade process MicroStrategy strongly recommends that youcareful ly review the upgrade information covered in this in this sectionbefore beginning your upgrade.

Determine Your Upgrade Methodology

Before you begin the upgrade process, you wi l l need to decide on anupgrade methodology to fol low. Choose the best option based on the size,complexi ty, and acceptable downtime for your particular environment.

l In-Place Upgrade: The upgrade is made directly to the current in-placeenvironment hardware. Your MicroStrategy environment wi l l beunavai lable to end users throughout the upgrade process. This optionworks best for smal ler deployments and those where downtime isacceptable.

You do not need to uninstall your current version of MicroStrategy beforeupgrading. MicroStrategy recommends performing an over-install whendoing an in-place upgrade.

l Parallel Upgrade: The upgrade is fi rst executed on a test environment.The testing environment is configured to mirror the current productionenvironment. Once the upgrade process, data val idation, and performancetests are completed and evaluated the testing environment can beconfigured for use as the new production environment.

Up grad e Gu id e


Pre-Upgrade Administrative Tasks

Before you begin upgrading any MicroStrategy systems ensure thefol lowing actions have been taken.

System Preparationl Al l necessary hardware (i f appl icable) for your new environment has beenprocured.

l Al l necessary information from al l hardware has been col lected and isavai lable, including:

l Ful ly Qual i fied Domain Names and IP Addresses

l Machine credentials

l Network Firewal ls

l Instal lation paths that wi l l be used

l Server type (.NET or J2EE)

l Review the Readme for your new version of MicroStrategy to ensure thatal l minimum system requirements are met.

l If you are planning to upgrade Enterprise Manager, use CommandManager to run an Enterprise Manager data load before you upgradeIntel l igence Server or you may lose access to some statistics data. Makesure the Close orphan sessions option is selected.

Backup Repositories and StoresUpgrading to a new feature release or platform release of MicroStrategy wi l lrequire the metadata to be updated, and addi tional ly may require updatingother reposi tories and stores including:

l Identi ty Store

l Col laboration Store

Up grad e Gu id e

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


l Platform Analytics Reposi tory

l Statistics Reposi tory

l History List Reposi tory

MicroStrategy recommends that administrators back up metadatas, stores,and reposi tories before they begin the actual production migration forfal lback support.

Backup Configuration Files

MicroStrategy Web

Backup any changed MicroStrategy Web configuration fi les:

l ../WEB-INF/xml/config/mapConfig.xml

l ../WEB-INF/xml/sys_defaults.properties

l ../WEB-INF/xml/sys_defaults.xml

l ../WEB-INF/web.xml

MicroStrategy Mobile

Backup any changed MicroStrategy Mobi le configuration fi les:

l /WEB-INF/xml/sys_defaults.properties

l /WEB-INF/xml/sys_defaults.xml

l /WEB-INF/web.xml

Backup any mobi le device configurations or saved any images from theMicroStrategy Photo Uploader widget, manual ly back them up beforeproceeding with your upgrade.

l /WEB-INF/xml/mobile

l /WEB-INF/SavedImages

Up grad e Gu id e


If you secure your MicroStrategy Mobi le connections through Certi ficateServer, you must upgrade your Certi ficate Server to support MicroStrategy2020 Mobi le appl ications.

MicroStrategy Library

Backup any MicroStrategy Library Configuration Fi les:

l /webapps/MicroStrategyLibrary/images/

l /webapps/MicroStrategyLibrary/plugins/

l /webapps/MicroStrategyLibrary/WEB-INF/classes/auth/

l /webapps/MicroStrategyLibrary/WEB-

INF/classes/config/configOverride.properties

l Any other customizations including SSL configurations

MicroStrategy Collaboration

Back up the Col laboration Server noti fication fi les in the fol lowing directory:

<INSTALL_PATH>\MicroStrategy\Collaboration Server\node_

modules\mstr-collab-svc\pluginConfig\dossier

List of fi les:

l config.json

l email-Invite.template

l email-Mention.template

Upgrade Prerequisites

Make sure al l of the fol lowing condi tions are met before you continue:

Up grad e Gu id e


l Instal lation fi les have been downloaded from the MicroStrategy downloadsi te.

l Acquire a l icense key from MicroStrategy for the version of theMicroStrategy software that you are instal l ing.

l New Windows machines wi l l require a login account wi th administrativeprivi leges for the domain or target machine

l Instal l ing MicroStrategy on Linux with a CPU-based l icense key wi l lrequire root access for instal lation

Upgrade Best Practices

Review the fol lowing recommendations to help ensure the success andstabi l i ty of your MicroStrategy system and projects when upgrading to thelatest version of MicroStrategy.

l The fol lowing versions of MicroStrategy are supported for upgradedirectly to MicroStrategy 2020:

l 10.4.x

l 2019 (and related updates)

If you are currently on a version of MicroStrategy that is supported todirectly upgrade to MicroStrategy 2020, you must fi rst upgrade to asupported version before upgrading to MicroStrategy 2020.

l If you are currently on a version of MicroStrategy that is not supported todirectly upgrade to 2020 and are doing an in-place upgrade, do notuninstal l the current version of MicroStrategy before upgrading.MicroStrategy recommends performing an over-instal l .

l Review the Readme for a complete l ist of new products, new features,and updates in MicroStrategy.

Up grad e Gu id e



l Fol low the upgrade order and recommendations outl ined in this guide, inparticular the The Upgrade Process Checkl ist, page 10. Always upgradethe Intel l igence Server before upgrading cl ient appl ications such asMicroStrategy Web, Mobi le, Library, and Developer.

l Create an upgrade test environment by dupl icating your productionenvironment and production metadata. Upgrade this test environment toval idate the upgrade before using in your production environment. Forguidel ines on how to test your system, see Val idating the Upgrade.

l Never downgrade a machine from a newer version to an older version ofMicroStrategy. It is not supported and can cause problems. Contact TechSupport i f this has been accidental ly done.

l Avoid instal l ing MicroStrategy products using virtual sessions on the hostmachine such as Windows Terminal Services. Always instal lMicroStrategy directly on the server machine's physical interface, or byusing a remote connection tool (such as Microsoft Remote Desktop) thattakes ful l control of the server machine's interface and creates an actualadministrator session on the machine.

l Shut down al l MicroStrategy Intel l igence Server nodes in a clusteredenvironment before upgrading. For more information about clusteringIntel l igence Servers, see the Clustering chapter in the SystemAdministration Guide.

l Ensure that al l data types assigned in existing projects are supported inthe current MicroStrategy version. If a project containing columns withunsupported data types is upgraded, the data types for those columns areassigned as "reserved," and proper data types are not assigned intemporary tables. This affects report execution. Please see the ProjectDesign Guide for a l isting of the supported data types for each databasetype and addi tional information about changing to supported data types.

Up grad e Gu id e

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


https://www2.microstrategy.com/producthelp/Current/ProjectDesignGuide/WebHelp/Lang_1033/Content/Mapping_of_external_data_types_to_MicroStrategy_da.htm

https://www2.microstrategy.com/producthelp/Current/ProjectDesignGuide/WebHelp/Lang_1033/Content/Mapping_of_external_data_types_to_MicroStrategy_da.htm


The Upgrade Process Checklist

The upgrade process described in the rest of this guide involves thefol lowing high-level steps. To help ensure a successful upgrade, fol lowthese steps in the order they are presented in this guide.

1. Prepare the MicroStrategy system and projects for upgrade.

l Review information speci fic to your version upgrade.

l Pre-upgrade information and prerequisi tes.

l Check for certi fied and supported configurations for al l products andcomponents being instal led.

l Back up the production metadata, reposi tories, and stores.

l Create an upgrade test environment which is a dupl icate ofproduction.

2. Back up your customizations, i f appl icable.

3. If you are upgrading your Express instal lation environment, you canelect to keep the current version of tutorial or your existing database.During the upgrade, you are asked "Do you want to overwri te theexisting database?"

l Select Yes to overwri te the database and existing data.

l Select No to keep your current database to use with the upgrade.

4. Instal l and configure a MicroStrategy 2020 test environment.

5. Using the test environment, update a copy of your product metadata.

6. Val idate the test environment wi th functional testing, comparisonstests in Integri ty Manager, and simulated end-to-end performance testsusing the Capaci ty Testing Tool .

For more information, see Val idating the Upgrade.

Up grad e Gu id e

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


7. Upgrade and configure Intel l igence Server in the productionenvironment.

8. Upgrade remaining MicroStrategy products in the productionenvironment.

Up grad e Gu id e


Execu t ing t he Upgr adeMicroStrategy recommends that you fol low a speci fic product upgradesequence when upgrading MicroStrategy products across severalmachines. Fol lowing this upgrade sequence helps ensure thatMicroStrategy products instal led on separate machines are interoperable,that is, they are able to work together when instal led on separate machines.

The recommended upgrade sequence is as fol lows:

1. Intel l igence Server

2. MicroStrategy Web, Web Services, Mobi le, Library, and Col laborationServers.

3. MicroStrategy Narrowcast Server.

4. Remaining MicroStrategy Components:

Client applications

l Desktop

l Mobi le and Library Mobi le cl ients

l Developer

l Office

Administrative applications

l Workstation

l Command Manager

l Enterprise Manager

l Object Manager

l Integri ty Manager

Up grad e Gu id e


l Systems Manager

l Platform Analytics

Performing an In-Place Upgrade

Performing an In-Place Upgrade on a Windows DeploymentThis section covers the procedure for di rectly upgrading your currentlydeployed Windows environment to MicroStrategy 2020. Careful ly review thePlanning Your Upgrade section before proceeding with your upgrade.

1. Install MicroStrategy 2020

Run the MicroStrategy.exe fi le included in your MicroStrategy 2020download.

Step through each of the Instal lation Wizard windows:

1. Accept the MicroStrategy License Agreement.

2. Update your l icense key.

3. Review the l ist of products included in your l icense.

4. Review the products that wi l l be instal led.

If your l icense includes new products or services select them forinstal lation in this window.

5. The instal ler wi l l display any running services that need to be stopped.Cl ick Yes to stop them now.

6. Configure the Platform Analytics connection to MySQL

7. Configure MicroStrategy Topology.

8. Server activation information

Up grad e Gu id e


9. Enter your contact information for server activation.

10. Choose to have an activation code sent to you now or at a later date.

11. Review the l ist of components you have selected for instal lation.

Choose i f you would l ike the instal ler to automatical ly reboot themachine when needed.

12. Cl ick Install to begin.

2. Update the Metadata

After upgrading the Intel l igence Server, update the metadata by performingthe procedure that fol lows. This procedure creates and updates metadatatables to support new features avai lable in MicroStrategy 2020.

Updating the metadata ensure compatibi l i ty between your pre-existingobjects and the MicroStrategy cl ients. You can also take advantage of newconfiguration settings exposed through the cl ient appl ications, functional i ty,and objects avai lable only wi th the updated version of metadata.

During the metadata update process, the Configuration Wizard generatesaddi tional SQL for tasks such as managing indexes and primary keys. Toview this SQL during the update process, on the Summary Page of theConfiguration Wizard, in the Summary pane, cl ick SQL Preview. Inaddi tion, once you have completed the update process, the generated SQLis saved in the MicroStrategy common fi les directory. The fi le name isOriginalScript_generated.sql , where OriginalScript is thename of the original SQL update script. For example, i f you are updating anOracle database, the original SQL update script is mdorcl.sql and thegenerated SQL fi le is mdorcl_generated.sql .

Be aware of the following:

l If you have made any changes to the priv ileges assigned to the out-of-the-box MicroStrategy user groups and security roles, updating the metadata

Up grad e Gu id e


may overwrite those changes. In particular, if you have made any changesto groups that use any priv ileges mentioned in the List of updatedprivi leges, updating the metadata will overwrite those changes.

l For information about viewing the Configuration Wizard log file if an erroroccurs, see Resolving Problems Encountered During the Upgrade .

l The MDUpdate command line utility that was formerly used to update themetadata is no longer supported. To update the metadata from the commandline, you can use a response file with Configuration Wizard.

As an al ternative to stepping through each page of the ConfigurationWizard for each project source that needs to be updated, you can create aresponse fi le wi th the update information and use that response fi le wi th theConfiguration Wizard to automatical ly update your metadata. For moreinformation about using a response fi le to update the metadata, see Using aResponse Fi le wi th Configuration Wizard.

If you do not have access to the GUI mode of Configuration Wizard, you mustuse a response file to update your metadata.

Prerequisites for Updating a MicroStrategy Metadata

Before attempting to update your MicroStrategy metadata to the latestversion, make sure you meet the fol lowing prerequisi tes:

l The metadata update process can be executed only by a MicroStrategyuser who is ei ther a member of the System Administrators user group, oris the out-of-the-box Administrator user. Having al l administrativeprivi leges is not sufficient: the user must be a member of the SystemAdministrators user group.

l The project's metadata version from which you update must be older than,or the same as, the version of the machine where Configuration Wizard isinstal led that wi l l be performing the metadata update An older version of

Up grad e Gu id e

https://www2.microstrategy.com/producthelp/current/SystemAdmin/WebHelp/Lang_1033/Content/list_of_privileges.htm



the product is not able to perform an update on a newer version ofmetadata.

l The language settings of the cl ient, project, and Intel l igence Server mustal l be the same.

l The projects to be updated must not be locked. To unlock a project'smetadata, in Developer, from the Administration menu, go to Locking >Unlock Project.

Database-Speci fic Prerequisi tes

The fol lowing prerequisi tes are speci fic to the RDBMS that your projectmetadata is stored in:

l If you are using Oracle for your metadata database, make sure that theMaximum Open Cursors parameter for the database is set to at least1500.

l If you are using SQL Server for your metadata database, MicroStrategyrecommends setting the transaction log to the Simple Recovery Modelbecause the Bulk or Ful l Recovery Models may fi l l the transaction logduring the upgrade and cause an error.

l If you are using DB2 for your metadata database, make sure that theDynamic Sections property for the database is set to 999.

Metadata Update Process

If you attempt to update a project through the Configuration Wizard and theupdate fails , the project is locked. You must unlock the project before youattempt to upgrade the project again. To unlock a project, in Developer, fromthe Administration menu, go to Locking > Unlock Project.

Up grad e Gu id e


To Make Met ad at a Up d at es Usin g t h e Co n f igu r at io n Wizar d

1. Select the Upgrade existing environment to MicroStrategy SecureEnterprise option. Cl ick Next.

2. Select the Intelligence Server components option. Cl ick Next.

3. On the MicroStrategy Authentication page, type the username andpassword of a MicroStrategy system administrator. Cl ick Next.

4. On the metadata Connection page, enter the database password toaccess the MicroStrategy metadata. Cl ick Next.

The DSN and Login ID are provided based on the server configurationthat you did previously.

5. On the Select Components page, select the check boxes for eachIntel l igence Server you want to upgrade.

6. Under each selected Intel l igence Server, select the systemcomponents you want to upgrade:

l Upgrade metadata repository: The metadata reposi tory containsthe defini tions of your MicroStrategy appl ications and supportingobjects. An upgrade of your metadata is required to provide supportfor al l new and updated features in the most recent version ofMicroStrategy.

l Lean Objects migration : MicroStrategy 9.3.1 introduced LeanObjects, a new, signi ficantly more compact form of objectrepresentation in the metadata tables. Lean Objects are typical ly 25-50% smal ler and wi l l never be larger than the originalrepresentation. Migrating existing objects to Lean Objects alsoal lows for faster loading of objects compared to the oldrepresentation.

Al l new objects are created in this format, and existing objects areconverted to the new format as they are saved. Selecting Lean

Up grad e Gu id e


Objects migration converts al l objects in the reposi tory to the newformat at once. This option is automatical ly selected i f you selectUpgrade metadata reposi tory.

The Lean objects migration modifies all objects in your MicroStrategyprojects to use the new object representation. This migration canrequire a significant amount of time and resources to complete.

Lean Objects migration decreases the amount of disk space used byyour objects. However, the migration causes all objects in yourprojects to be resaved. Depending on your database transactionlogging policy, this may cause a temporary increase in the size of yourmetadata database.

l Update privileges: Updating the privi leges ensures that users haveaccess to the same functional i ty that they had in previous versions ofMicroStrategy.

By default, priv ileges are upgraded based on the version of yourMicroStrategy metadata. However, if you previously upgraded yourMicroStrategy metadata and did not upgrade priv ileges along with themetadata upgrade, you must identify the MicroStrategy version youmost recently upgraded your priv ileges for.

To do this, to the right of Update privileges , c lick Advanced . TheSelect Priv ilege Version dialog box opens, with the version of yourMicroStrategy metadata selected by default. From the drop-down list,select the version of MicroStrategy that priv ileges were most recentlyupgraded for and click OK .

l Migrate History List messages: Select this check box to migrateyour existing History List reposi tory to a new format for improvedsearch resul ts, scalabi l i ty, and performance. A fi le-based reposi torycan be migrated to a database-based reposi tory or a hybrid

Up grad e Gu id e


reposi tory, and a database-based reposi tory can be migrated to ahybrid reposi tory.

l If you select this check box, addi tional configuration options forthis migration are provided later, on the History List Migrationpage. During the upgrade process this Intel l igence Server and anyother Intel l igence Servers in the cluster are stopped and restarted.

l If you are using a fi le-based History List reposi tory and want tocontinue using that format, clear this check box. The reposi tory isupdated, but i ts format is not affected, when you restart theIntel l igence Server after the upgrade.

l If you are using a database-based or hybrid History List reposi toryand want to continue using the same type of reposi tory, forinformation about upgrading the History List database, see 2.Update the Metadata.

l Update Distribution Services Objects: Select this check box toupgrade Distribution Services subscription objects. This update isrequired to ensure that your Distribution Services subscriptions cansupport the new features and enhancements included in the mostrecent release. If you select this option, ensure that the metadatareposi tory has been upgraded or is selected to be upgraded as partof this update.

l Database Instance Update: Select this checkbox to update anyMDX database instances which currently use JCO 2.x to JCO 3.x. Asof MicroStrategy 10.x the Java Virtual Machine used does notsupport JCO 2.x. This option wi l l only affect MDX databaseinstances which are set to use JCO 2.x.

7. Select each project you want to update. Only projects that are loadedon Intel l igence Server can be updated. Project updates can includeany of the fol lowing options:

Up grad e Gu id e


l Execute project logical upgrade: Updates the project to the mostrecent version of MicroStrategy. This option also updates the report,document, and dossier defini tions to improve the performance andreduce the memory usage and storage requirements of reports anddocuments that were created with a previous version ofMicroStrategy.


l If this update has already been completed, this option is named Re-execute project logical upgrade .

l This upgrade is required to execute any additional project upgradeoptions.

l Updated Report Services documents cannot be run in previousversions of MicroStrategy.

l Depending on the number of reports and documents in the project,this update may take significant time.

l Lean Objects migration : Selecting Lean Objects migration convertsal l objects in this project to the new format at once.

The Lean objects migration modifies all objects in this project to usethe new object representation. This migration can require significanttime and resources to complete.

Lean Objects migration decreases the amount of disk space used byyour objects. However, the migration causes all objects in this projectto be resaved. Depending on your database transaction logging policy,this may cause a temporary increase in the size of your metadatadatabase.

l Update Schedules: Makes previous subscriptions viewable inMicroStrategy 2020.

Up grad e Gu id e


l Update MDX Source Objects: Updates the MDX data source objects(MDX Cubes) that were created in earl ier versions of MicroStrategyto take advantage of improved performance.

By default, if you update multiple projects and the update fails for oneproject, the update process continues for other projects. This allowsyou to complete all possible updates and then review any errors. Toabort the update process for other projects when one project fails , c learthe Update the remaining projects, even when one projectupdate fails check box.

Depending on the number of MDX source objects in the project, thisupdate may take significant time.

l Update OLAP Services Cube caches to PRIME : Select this checkbox to update al l Intel l igent Cubes to the PRIME archi tecture. Thisarchi tecture can improve the performance of publ ishing Intel l igentCube resul ts through the use of paral lel processing and otheroptimizations. This update is appl ied to al l Intel l igent Cubes for theproject.

l Update data import cubes (definition and cache) to PRIME : Selectthis check box to update al l Data Import datasets to the PRIMEarchi tecture. This archi tecture can improve the performance ofpubl ishing Data Import resul ts through the use of paral lel processingand other optimizations. This update is appl ied to data sets includedin your project through the use of Data Import.

It is easier to update OLAP Services Cube caches and data importcubes to PRIME during the upgrade process. If you do not update themnow, each cube is updated when it is used. Doing the upgrade all atonce ensures consistent performance for end users.

8. Cl ick Next.

Up grad e Gu id e


9. If you selected the Migrate History List messages option, on theHistory List Target Database page, speci fy the necessary informationfor the History List database.

10. Cl ick Next.

11. On the Summary page, review your upgrade choices and cl ick Finish .

3. History List Database Repository

If you are using a database-based History List, when upgrading toMicroStrategy 2020 you must upgrade the History List database tables.MicroStrategy recommends using the Configuration Wizard to upgrade theHistory List reposi tory.

To Upgrade the History List Repository

1. In Windows, go to Start > All Programs > MicroStrategy Tools >Configuration Wizard . The Configuration Wizard opens.

2. Select Upgrade existing environment to MicroStrategy SecureEnterprise and cl ick Next.

3. Select History List Repositories and cl ick Next. .

4. Select the DSN for the History List database, and speci fy the logininformation.

5. To upgrade existing History List messages to the current format, selectthe Copy History List content check box.

If this check box is cleared, existing History List messages are notupgraded. The new tables required to support History List messages arestill created.

6. If you select to upgrade your existing History List messages, you can

Up grad e Gu id e


also select the Compress data check box to compress al l existingHistory List messages. This compression can improve the performanceof using History List messages. However, the compression of yourHistory List messages can require signi ficant system resources duringthe upgrade.

To avoid the overhead of compressing your existing History Listmessages, clear the Compress data check box. Existing History Listmessages are not modi fied, but any newly created History Listmessages are created with the new compressed format.

7. Cl ick Next.

8. Review the avai lable information, and cl ick Finish .

4. MicroStrategy Web and Mobile Server

Once you have upgraded Intel l igence Server and updated the projectmetadata, upgrade your MicroStrategy Web and Mobi le Server instal lations.

.NET:

Upgrading a Windows machine (IIS) wi th MicroStrategy Web and Mobi leServer directly from an older version to a newer version upgrades bothdeployments automatical ly. In-place upgrades require no addi tional steps.To upgrade MicroStrategy Web and Mobi le Server, Administrators shouldfol low the detai led instructions in Deploying with IIS (Windows).

J2EE:

Upgrading MicroStrategy Web and/or Mobi le for JSP, whether i t's onWindows or Linux, only creates a new MicroStrategy.war and/orMicroStrategyMobile.war fi le. Deployments are not done by theMicroStrategy Instal ler and must be done by the administrator on asupported appl ication server.

Before upgrading MicroStrategy Web and Mobi le Server, be aware of thefol lowing considerations:

Up grad e Gu id e


l Note your current Web customizations and review the information inMicroStrategy Web Customizations to learn how to successful ly migratethese customizations.

l If you have created any mobi le device configurations or saved any imagesfrom the MicroStrategy Photo Uploader widget, those configurations andimages are deleted during the upgrade unless you manual ly back them upbefore the upgrade and restore them after the upgrade.

l To back up your configuration fi les, make a copy of the directory<MicroStrategyMobileServer>/WEB-INF/xml/mobile/ and al li ts contents, where <MicroStrategyMobileServer> is theinstal lation location of MicroStrategy Mobi le Server. By defaul t, thislocation is C:\Program Files (x86)\MicroStrategy\Mobile

Server ASPx or \Mobile Server JSP . Then, after you haveupgraded Mobi le Server, copy the contents of the backed-up directory tothe same corresponding location in the new Mobi le Server deployment.

l Photo Uploader images are stored in MicroStrategy Mobi le Server. Toback up your Photo Uploader images, make a copy of the directory<MicroStrategyMobileServer>/WEB-INF/SavedImages/ andal l i ts contents, where <MicroStrategyMobileServer> is theinstal lation location of MicroStrategy Mobi le Server. By defaul t, thislocation is C:\Program Files (x86)\MicroStrategy\Mobile

Server ASPx or \Mobile Server JSP .

l If you secure your MicroStrategy Mobi le connections through Certi ficateServer, you must upgrade your Certi ficate Server to support MicroStrategy2020 Mobi le appl ications. Enhancements to MicroStrategy Certi ficateServer require this step.

l After upgrading MicroStrategy Web or Mobi le Server, restart the web andappl ication servers along with clearing the web and appl ication servercaches.

For steps speci fic to your J2EE environment, see:

Up grad e Gu id e


l Deploying with Tomcat (Windows)

l Deploying with JBoss (Windows)

l Deploying with Oracle 10g (Windows)

l Deploying with SAP NetWeaver (Windows)

4.1 MicroStrategy Web Customizations

MicroStrategy Web customizations are developed as plugins that are storedin the plugins folder of the environment. When upgrading to a newer versionof MicroStrategy Web, the plugin upgrade di ffers depending on whether youare using a .NET environment on Windows or a J2EE environment onWindows or Linux.

.NET EnvironmentWhen you upgrade MicroStrategy Web in a .NET environment (IIS), theexisting plugins are automatical ly copied to the plugins folder of the newinstal lation directory.

J2EE EnvironmentWhen you upgrade MicroStrategy Web in a J2EE environment, you mustmanual ly copy your existing plugins to the plugins folder in your newdeployment folder.

1. Make a copy of your existing plugins.

2. Deploy the new MicroStrategy Web WAR fi le.

3. Copy your existing plugins to the new plugins folder in deploymentfolder.

For information about the plugin structure used for MicroStrategy Webcustomizations, refer to MicroStrategy Web SDK in the MicroStrategyDeveloper Library.

Up grad e Gu id e

https://lw.microstrategy.com/msdz/MSDL/GARelease_Current/docs/projects/WebSDK/Content/topics/webcusteditor/WCE_Plug-in_Architecture.htm


5. MicroStrategy Library

In MicroStrategy 10.9 through 11.0, MicroStrategy Library was automatical lydeployed in Tomcat and the MicroStrategyLibrary.war fi le instal ledin the <INSTALL_PATH>\LibraryWebMobile directory. MicroStrategy2019 and above requires administrators to perform the upgrade for theirLibrary deployment.

You must manually deploy a new Library WAR File after upgradingMicroStrategy Library.

This section contains high level steps and considerations for performing anupgrade or migrating MicroStrategy Library to a new environment.

Windows Environments

In MicroStrategy 10.9 to 11.0, MicroStrategy Library is automatical lydeployed in Tomcat and the Library.war fi le is instal led in the <INSTALL_

PATH>\LibraryWebMobile directory. Starting in MicroStrategy 2019,administrators can choose Tomcat as an option under "Other Components"to deploy Library to Tomcat, or deselect i t so that only the WAR fi le iscreated in the directory referenced above.

Perform the fol lowing steps when doing a direct upgrade of MicroStrategyLibrary 10.9 - 11.0 to MicroStrategy 2020.

1. Within the Tomcat directory, the fol lowing fi les are backed up:

l webapps folder

l server.xml

l tomcat-users.xml

2. Uninstal l old Tomcat.

3. Instal l new Tomcat 9.0.12.

4. Al l backed up fi les are restored to the new Tomcat instal lation.

Up grad e Gu id e


5. Start Tomcat.

6. The new Library.war fi le is only instal led in <INSTALL_

PATH>\LibraryWebMobile .

Deploying the New WAR File

A new Library WAR File must be manually deployed after upgradingMicroStrategy Library, even between service packs.

You should backup the webapps folder as they are overwritten whendeploying new .war files.

Use the fol lowing steps to deploy a new WAR fi le for both Windows andLinux.

1. Use the MicroStrategy instal ler to create a new MicroStrategy 2020Library.war fi le by doing a direct upgrade or new instal lation.

2. Redeploy the new Library.war fi le from the Library instal l di rectoryto the J2EE server being used. See the l ist of supported servers.

3. Migrate your customizations to the new environment, such as:

l .../webapps/MicroStrategyLibrary/images/

l .../webapps/MicroStrategyLibrary/plugins/

l .../webapps/MicroStrategyLibrary/WEB-

INF/classes/auth/

l Customized authentication configuration, such as SAMLauthentication



l Make sure MicroStrategy Library is pointing to the correctIntel l igence Server and Col laboration Server wi th correct

Up grad e Gu id e

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


authentication setting by going to the Library AdministrationControl Panel .


INF/classes/logback.xml


4. Veri fy that MicroStrategy Library functional i ty including col laboration,sharing, exporting, printing, and al l other features are workingproperly. Ensure dossiers and documents are appearing.

The Col laboration Server is a separate component of MicroStrategy that isupgraded independently of Library. See Upgrade MicroStrategyCol laboration for more information.

6. MicroStrategy Collaboration

MicroStrategy Col laboration has been enhanced to use a central datareposi tory instal led as part of the MicroStrategy Platform. Starting inMicroStrategy 2020 the Col laboration Server constructs the connectionstring to the MicroStrategy Data Reposi tory during runtime. After performingthe upgrade, Col laboration Server wi l l only support connections to theMicroStrategy Data Reposi tory.

After upgrading Col laboration Server, the previous data reposi tory remainsunchanged but i t wi l l not be used by the new version of Col laborationServer. Any comments stored in the previous data reposi tory wi l l need to bemoved to the new reposi tory to be accessible.

Migrating Comments to the MicroStrategy Data Repository

The Col laboration Server Administration Tool provides a way for systemadministrators to migrate comments from the previous data reposi tory to thenew data reposi tory. The Col laboration Administration Page wi l l display awarning message when i t detects that a previous data reposi tory was usedby the Col laboration Server before the upgrade.

Up grad e Gu id e


The Col laboration Server Administration Tool is a console appl ication andwi l l connect to the data reposi tory using the same configuration as theCol laboration Server so no user input is required to connect. The tool wi l lprovide feedback as data is being migrated and wi l l show a message whenthe migration is complete.

In order to recover col laboration messages that were stored in the previousversion of the MicroStrategy Platform please fol low these steps:

1. Cl ick Start > Windows Administrative Tools > Services.

2. Stop the service MicroStrategy Col laboration/Real time Service.

3. Start the service Mongo DB.

4. Run the Data Migration Command:

l Enter the three fi le locations in the fol lowing format:

$ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>"

"<PATH_TO_CONFIG_FILE>"

"C:\Program Files\Common Files\MicroStrategy\nodejs\node.exe"

"C:\Program Files\MicroStrategy\Collaboration Server\node_

modules\mstr-collab-svc\admintool.js" "C:\Program

Files\MicroStrategy\Collaboration Server\config.json"

l Use the migrate command to run the data migration:

cmd> migrate

l Enter quit to close the Col laboration Server Administration Tool .

5. Stop the service Mongo DB.

6. Start the service MicroStrategy Col laboration/Real time Service.

The Col laboration Admin Page wi l l stop displaying the warning message atthis point.

Up grad e Gu id e


7. Updating the Enterprise Manager Project

Upgrading from MicroStrategy 9 to 2020 includes major enhancements andupdates to the Enterprise Manager project; whereas upgrading fromMicroStrategy 10 to 2020 does not have major enhancements and upgradesto the Enterprise Manager project. In both scenarios, you should use thelatest versions of Enterprise Manager projects wi th MicroStrategy 2020.

l To retain customizations created in previous Enterprise Manager projects,make separate copies of these customized copies of the out-of-the-box objects,or as brand-new objects. Any modifications you made to the out-of-the-boxobjects for an Enterprise Manager project are replaced as part of the upgradeprocess.

l To upgrade your Enterprise Manager statis tics and warehouse, ensure yourEnterprise Manager Data Loader service is pointing to your Statistics andEnterprise Manager Repository. For more information, see KB483298 .

l Use the Project Duplication Wizard to make a backup of your existingEnterprise Manager project. For detailed information about using ProjectDuplication, see the Managing Your Projects chapter of the SystemAdministration Guide .

1. Open Configuration Wizard.

2. Select Upgrade existing environment to MicroStrategy SecureEnterprise, and cl ick Next.

3. Select Upgrade Enterprise Manager Project, and cl ick Next.

4. Provide the fol lowing information:

l User Name: Type the MicroStrategy user name that can access andadminister the Enterprise Manager project.

l Password : Type the password for the MicroStrategy user that canaccess and administer the Enterprise Manager project.

Up grad e Gu id e

https://community.microstrategy.com/s/article/Note-on-upgrading-Enterprise-Manager-Statistics-and-Warehouse-from-10-x-to-2019?language=en_US




5. If you have an Enterprise Manager project package fi le (.mmp) to useinstead of the defaul t fi le, cl ick Advanced >>. For the Packagelocation field, cl ick ... (the Browse button) to navigate to and selectthe package fi le.

6. Cl ick Next.


l DSN : Select the data source name for your statistics reposi tory orcl ick New to open the MicroStrategy Connectivi ty Wizard and createa new DSN.

l User Name: Type the database user name for the user that canconnect to the statistics data source.

l Password : Type the password for the user that can connect to thestatistics data source.

8. Cl ick Next.

9. Review the summary information.

You can click Save to save the configuration as a response (.ini) file toupgrade your Enterprise Manager projects on other systems or to runsilent configurations at a later time. For information on running theConfiguration Wizard with a response file, see Using a Response Fi lewi th Configuration Wizard .

10. Cl ick Finish .

8. Upgrade the Platform Analytics Project

As of 2019, you can upgrade your Platform Analytics project in themetadata of your connected Intel l igence Server. Upgrading the project isrecommended with each platform and update release in order to brings inthe latest dossiers, attributes, metrics and reporting optimizations to thePlatform Analytics project.

Up grad e Gu id e




3. Select Upgrade Platform Analytics Project, and cl ick Next.


l User Name: Enter the MicroStrategy user name that can access theIntel l igence Server.

If this is your first time connecting to the MicroStrategy IntelligenceServer, use the user name Administrator without a password.

l Password : Enter the password for the MicroStrategy user that canaccess the Intel l igence Server.

5. Choose the Platform Analytics Reposi tory.

Select the MySQL/PostgreSQL DSN for the Platform AnalyticsRepository that was used to create Platform Analytics.

6. Enter your User Name and Password for the DSN.

7. Cl ick Next.

8. Cl ick Apply. The Configuration Wizard automatical ly appl ies thefol lowing configuration fi les:

l PlatformAnalyticsConfigurationNew.scp

l PlatformAnalyticsConfigurationNew_PostgreSQL.scp

l PlatformAnalyticsConfigurationUpgrade.scp

l PlatformAnalyticsConfigurationUpgrade_PostgreSQL.scp

Up grad e Gu id e


9. If an error appears about being unable to automatical ly apply projectsettings to Platform Anal tyics, you must manual ly update the projectsettings. For instructions, see Configure the Platform Analytics Project.

9. Upgrade the Platform Analytics Repository

After instal l ing Platform Analytics, there is a Platform Analytics Reposi tory(Platform Analytics warehouse table) where you can create the PlatformAnalytics project on your local machine. Upgrading the reposi tory isrequired with each platform and update release in order to benefi t fromPlatform Analytics warehouse new features, defect fixes and databasestructure optimizations.

The Configuration Wizard provides the fol lowing options:

l Host: Type the host name of the Platform Analytics warehouse. Bydefaul t, this is set to the last successful connection value.

l Port: Type the port number of the Platform Analytics warehouse. Bydefaul t, this is set to the last successful connection value.

l User Name: Type the user name for the Platform Analytics warehouse. Bydefaul t, this is set to the value from PAConsumerConfig.yaml fi le

l Password : Type the password for the Platform Analytics warehouse user.

Depending on the warehouse type you choose for the Host and Port, you mustset the parameter whDbType to either "postgresql" or "mysql" in thePAConsumerConfig.yaml file.

The default path is:

l Linux: /opt/MicroStrategy/PlatformAnalytics/Conf

l Windows: C:\Program Files

(x86)\MicroStrategy\Platform Analytics\conf

Click Next to proceed.

Up grad e Gu id e

http://www2.microstrategy.com/producthelp/current/PlatformAnalytics/en-us/Content/tuning_platform_analytics_project.htm


You can also update the Platform Analytics reposi tory using theConfiguration Wizard in interactive mode.

How to Update the Repository in Interactive Mode

To update the Platform Analytics reposi tory using the ConfigurationWizard in interactive mode on Windows:

1. In a Windows console, enter one of the fol lowing commands:

l For 64-bi t, enter MACfgWiz_64 .

l For 32-bi t, enter MACfgWiz .

2. Cl ick Enter.

3. Type 2 and cl ick Enter to create a new response.ini fi le.

4. Type 5 and cl ick Enter to upgrade your existing environment toMicroStrategy Analytics Enterprise.

5. Type 3 and cl ick Enter to upgrade your Platform Analyticsreposi tory.

6. Enter your Platform Analytics warehouse database credentials. Bydefaul t, the server name, port number, and user name are set to thelast successful connection value.

If you did not change the values, leave as default. The defaultpassword can be found at C:\Program Files (x86)\CommonFiles\MicroStrategy\express_password.txt

7. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leavethe field blank to use the defaul t name or type a di fferent name,

Up grad e Gu id e


and then cl ick Enter. The response.ini fi le is generated, and youare prompted whether to run the configuration immediately.

8. Type Y and cl ick Enter to run the configuration.

To update the Platform Analytics reposi tory using the ConfigurationWizard in interactive mode on Linux:

1. In a Linux console window, browse to HOME_PATH where HOME_

PATH is the speci fied home directory during instal lation.

2. Browse to the bin directory.

3. At the command prompt, type mstrcfgwiz-editor , then cl ickEnter. The Configuration Wizard opens in command l ine mode.

4. Cl ick Enter.





9. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leavethe field blank to use the defaul t name or type a di fferent name,and then cl ick Enter. The response.ini fi le is generated, and you

Up grad e Gu id e


are prompted whether to run the configuration immediately.


10. Activate Your Installation

Al l MicroStrategy 2020 instal lations must be activated within 30 days. Onceyou receive the activation code you wi l l need to enter i t into MicroStrategyLicense Manager.

In st r u ct io n s

1. Open MicroStrategy License Manager from Start menu > Programs >MicroStrategy Tools > License Manager.

2. Go to the License Administration tab > Activate Server Installationand cl ick Next .

3. Select the Server Activation using Activation Code option and enteryour Activation Code in the text field. Cl ick Next .

4. Cl ick OK .

Performing an In-Place Upgrade on a Linux DeploymentThis section covers the procedure for di rectly upgrading your currentlydeployed Linux environment to MicroStrategy 2020. Careful ly review thePlanning Your Upgrade section before proceeding with your upgrade.

1. Upgrade Preparation

Before you begin the upgrade to MicroStrategy 2020 take care of thefol lowing i tems:

l Log in as root user.

l Backup the current configuration fi les for Intel l igence Server, Web,

Up grad e Gu id e


Mobi le, Library, and Col laboration.

List of Fi les:

Intelligence Server

l MSIReg fi les

l odbcinst.ini

l odbc.ini

MicroStrategy Library

l ../webapps/MicroStrategyLibrary/images/

l ../webapps/MicroStrategyLibrary/plugins/

l ../webapps/MicroStrategyLibrary/WEB-

INF/classes/auth/






MicroStrategy Collaboration

When upgrading the Col laboration Server, the MicroStrategy Instal lerpreserves the config.json fi le for the service; however, i t does notback up the noti fication config.json fi le. If you have modi fied anynoti fication properties, you need to backup the fol lowing and restore i tonce the upgrade is complete:

Backup Col laboration Server Noti fications

Up grad e Gu id e


When upgrading the Col laboration Server, the MicroStrategy Instal lerpreserves the config.json fi le for the service; however, i t does notback up the noti fication config.json fi le. If you have modi fied anynoti fication properties, you need to backup the fol lowing and restore i tonce the upgrade is complete:

Back up the Col laboration Server noti fication fi les in the fol lowingdirectory:

<INSTALL_PATH>\MicroStrategy\Collaboration

Server\node_modules\mstr-collab-

svc\pluginConfig\dossier

List of fi les:

l config.json

l email-Invite.template

l email-Mention.template

Backup Col laboration Store

The Col laboration Server uti l izes MongoDB as i ts reposi tory database.MongoDB has a bui l t-in command for database backup, transfer, andrestoration.

MicroStrategy recommends that the MongoDB database be backed up ona regular basis.

Gather the following information from the dburl field in the config.jsonfile from each server:

l Username

l Password

l Collaboration database name

Up grad e Gu id e


l Admin database name

1. Stop the Col laboration Server and the MongoDB service.

2. Execute the fol lowing command from the destination server:

mongodump --host <source_server_name> --db <source_db_name> --username

<source_username> --password <source_password> --

authenticationDatabase admin --excludeCollection sessions --archive |

mongorestore --username <target_username> --password<target_password>

--authenticationDatabase admin --drop --archive

3. Restart the Col laboration Service and the MongoDB service.

l Send an emai l to your users to inform that Intel l igence Server and WebServer wi l l be down during the upgrade process.

l Halt any moni toring alerts in case false alarm triggered during upgrades.

l Check the MicroStrategy Web Administration page and delete any definedTrust Relationships.

l Restart al l services for the machines to be upgraded.

l Execute service mstr stop to stop Tomcat, MicroStrategy Listener,and Intel l igence Server.

l Unmount al l current mounts to any MicroStrategy deployment.

Unmounting is necessary to prevent the instal ler from attempting toremove other i tems in the mounted locations such as the image shares.

l To view the related mounts and locations, run:

mount | grep MicroStrategy

l To unmount each folder, run umount /<path>/<to>/<folder> . Forexample:

umount /opt/mstr/MicroStrategy/install/images

Up grad e Gu id e


l Stop puppet i f the service is running.

Use the fol lowing commands:

l Stop puppet: service puppet stop

l Get process id for any additional puppet processes: ps -ef |

grep puppet

l Kill any remaining processes: kill -9 <processID>

l Remove MicroStrategy directory and .war fi les from tomcat webapps andwork folders.

1. cd /opt/apache/tomcat/latest/webapps/

2. rm -rf MicroStrategy*

3. cd

/opt/apache/tomcat/latest/work/Catalina/localhost

4. rm -rf MicroStrategy*

l Use df -h to check that at least 5GB of disk space is avai lable under/opt/mstr


The MicroStrategy Instal lation Wizard can be used in ei ther in graphicaluser interface (GUI) mode or in command l ine mode for Linux.

1. Navigate to your MicroStrategy 2020 download folder and thenQueryReportingAnalysis_Linux .

2. Run the Instal lation Wizard:

l For GUI mode:./setup.sh

l For command l ine mode: ./setup.sh -console

After each step of the install process click Next, or type 1 and press

Up grad e Gu id e


Enter, to proceed.

To quit the installation at any time during the setup, c lick Cancel, or type3 and press Enter.

3. Step through each of the Instal lation Wizard windows/prompts:

1. Accept the MicroStrategy License Agreement.

2. Update your l icense key.

3. Review the l ist of products included in your l icense.

4. Review the products to be instal led.

If your l icense includes new products or services select them forinstal lation in this window.

5. The instal ler displays any running services that need to bestopped. Cl ick Yes to stop them now.

6. Configure MicroStrategy Topology.

7. Server activation information

8. Enter your contact information for server activation.

9. Choose to have an activation code sent you to now or at a laterdate.

10. Review the l ist of components selected for instal lation.

Choose i f you would l ike the instal ler to automatical ly reboot themachine i f necessary.

11. Cl ick Install to begin.

3. Upgrade the Drivers for Your Data Source Connections

MicroStrategy 2020 requires 64-bi t drivers for al l data source connections.

Upgrading from versions prior to MicroStrategy 10.4...

If you are using a version prior to MicroStrategy 10.4 and connect to your

Up grad e Gu id e


data source using a MicroStrategy-branded driver , the drivers are upgradedfrom 32-bi t to 64-bi t drivers automatical ly when Intel l igence Server isupgraded. You must manual ly update the MicroStrategy odbc.ini

configuration fi le to point to the location for the 64-bi t driver.

Al l MicroStrategy-branded drivers are upgraded during the instal lationprocess. Simply replace the newly instal led odbc.ini with the backuptaken before the upgrade.

If you connect to your data source using a driver provided by a thi rd-partyvendor, you must instal l the 64-bi t version of the driver from your thi rd-partyvendor, and then create a new DSN that uses that driver to connect to yourdata source. You must also update the MicroStrategy odbc.ini

configuration fi le.

After you upgrade the drivers, continue the upgrade process with 4.Connect the Intel l igence Server to the Metadata.

4. Connect the Intelligence Server to the Metadata

Use the Configuration Wizard to establ ish a connection betweenIntel l igence Server and your metadata reposi tory.

Configure Metadata Connection

1. Run the MicroStrategy Configuration Wizard:

cd /opt/mstr/Microstrategy/bin

./mstrcfgwiz

2. Select Configure Intelligence Server, and cl ick Next.

3. From the DSN drop-down l ist, select the DSN used to connect to themetadata reposi tory. Enter the User Name and Password for thedatabase.

4. Cl ick Next.

Up grad e Gu id e


5. Select Use the selected Server Definition as active.

6. Choose the server defini tion to use from the Existing ServerDefinitions pane.

7. Cl ick Next.

Def in e t h e In t el l igen ce Ser ver p o r t n u m b er an d o t h er set t in gs

1. Define the Intel l igence Server settings described below:

l Port number: You can use the defaul t port number (34952) orspeci fy another port number. The port number is how a serverprocess identi fies i tsel f on the machine on which i t is running. If theport number is used by another process, such as in a sharedenvironment, speci fy an avai lable port number.

l REST port number: You can use the defaul t port number (34962) orspeci fy another port number for the REST API Server insideIntel l igence Server. This port number should not be same with theIntel l igence Server port number.

You can configure REST API Server logging with the Diagnostics andPerformance Logging Tool. Select the Performance Configurationtab, and find the dispatcher REST Trace under component NetworkClasses . For more information, see the Configuring What is Loggedsection in the System Administration Guide .

l Register Intelligence Server as a Service: Select this check box toregister Intel l igence Server as a service.

l Projects to load at startup : This pane displays al l the projects thatare in the metadata reposi tory. You can select projects to use withthe server defini tion that you have chosen. The projects that youselect are loaded on the server at startup.

Up grad e Gu id e



l Start Intelligence Server when finished : Select this check box tohave Intel l igence Server start once you complete this configuration.

l Identify missing DSNs: Select this check box to veri fy that al lDSNs, which are used for database instances created inMicroStrategy, are local ly avai lable. This helps to ensure that yourdatabase instances in MicroStrategy can connect successful ly totheir associated data sources.

By defaul t, this check box is cleared, which means the avai labi l i ty ofal l local DSNs used in database instances is not veri fied. Whi le thismay mean that al l DSNs used in database instances are notavai lable, i t can save system resources required for the Intel l igenceServer configuration process.

2. Cl ick Next.

3. Secure socket layer (SSL) protocol encrypts communications betweenIntel l igence Server and Developer:

Configure SSL : This option speci fies whether to enable Intel l igenceServer and Developer to communicate using the SSL protocol . Clearthis check box to disable the use of the SSL protocol for Intel l igenceServer and Developer communications. This option also appl ies SSLprotocol to the REST port number.

When you select to enable the SSL protocol , you must provide thefol lowing information:

l Certificate: The SSL certi ficate fi le you created for Intel l igenceServer. Cl ick the browse button to navigate to and select thecerti ficate fi le.

l Key: The private key fi le you created whi le requesting the certi ficatefor Intel l igence Server. Cl ick the browse button to navigate to andselect the private key fi le.

Up grad e Gu id e


l Password : The password that you used whi le creating the privatekey for the SSL certi ficate.

l SSL Port: The port number to use for SSL access. By defaul t, theport is 39321.

To enable SSL protocol communication in Developer, you must use theProject Source Editor. For steps to complete the other tasks required toenable SSL protocol communications, refer to the SystemAdministration Guide .

Configuring port requires Client Certificate: If selected, the SSLcommunications with cl ient certi ficate veri fication wi l l be configured inthe Intel l igence Server, but does not apply to REST port number.Provide the fol lowing information:

l SSL Port: The port number the Intel l igence Server wi l l use for SSLcommunications with cl ient certi ficate veri fication.

l Truststore: The location to the cl ient certi ficate truststore.

4. Cl ick Next.

5. To speci fy the defaul t statistics reposi tory for the local Intel l igenceServer and enable basic statistics logging for projects:

l Make this my default Statistics Database Instance for the localIntelligence Server metadata: Select this check box to define whichstatistics reposi tory to use for recording statistics. If you clear thischeck box, a defaul t statistics database instance is not defined foryour Intel l igence Server.

l When defining the defaul t statistics reposi tory, you must provide thefol lowing configuration detai ls:

Up grad e Gu id e




l DSN : Select the data source name for your statistics reposi tory.

If a DSN for your statistics reposi tory does not exist, you can cl ickNew to open the MicroStrategy Connectivi ty Wizard and create anew DSN.



l Enable Basic Statistics (For newly created projects andexisting projects not logging statistics): Basic statistics for newprojects and any projects that are not currently logging statisticswi l l be enabled. You can al ter the settings in Project ConfigurationEdi tor in MicroStrategy Developer to:

o Enable addi tional statistics for a project.

o Enable basic and addi tional statistics for a project i f you clearedthis check box.

6. Enable and configure the Messaging Services host and port settings.

Messaging Services Host(s)/Port(s): Provide host name or IPaddress of Messaging Services.

Format for this setting should be: server1.acme.com:9092

7. Cl ick Next.

8. Review the summary information and cl ick Save.

9. Cl ick Finish.

5. Update the Metadata

After upgrading the Intel l igence Server, update the metadata by performingthe procedure that fol lows. This procedure creates and updates metadata

Up grad e Gu id e


tables to support new features avai lable in MicroStrategy 2020.




l If you have made any changes to the priv ileges assigned to the out-of-the-box MicroStrategy user groups and security roles, updating the metadatamay overwrite those changes. In particular, if you have made any changesto groups that use any priv ileges mentioned in the List of updatedprivi leges, updating the metadata will overwrite those changes.



As an al ternative to stepping through each page of the ConfigurationWizard for each project source that needs to be updated, you can create aresponse fi le wi th the update information and use that response fi le wi th theConfiguration Wizard to automatical ly update your metadata. For more

Up grad e Gu id e




information about using a response fi le to update the metadata, see Using aResponse Fi le wi th Configuration Wizard.





l The project's metadata version from which you update must be older than,or the same as, the version of the machine where Configuration Wizard isinstal led that wi l l be performing the metadata update An older version ofthe product is not able to perform an update on a newer version ofmetadata.





l If you are using Oracle for your metadata database, make sure that theMaximum Open Cursors parameter for the database is set to at least

Up grad e Gu id e


1500.







4. On the Metadata Connection page, enter the database password toaccess the MicroStrategy metadata. Cl ick Next.





Up grad e Gu id e


l Lean Objects migration : Lean Objects are a signi ficantly morecompact form of object representation in the metadata tables. LeanObjects are typical ly 25-50% smal ler and wi l l never be larger thanthe original representation. Migrating existing objects to LeanObjects also al lows for faster loading of objects compared to the oldrepresentation.

Al l new objects are created in this format, and existing objects areconverted to the new format as they are saved. Selecting LeanObjects migration converts al l objects in the reposi tory to the newformat at once. This option is automatical ly selected i f you selectUpgrade metadata reposi tory.





To do this, to the right of Update privileges , c lick Advanced . TheSelect Priv ilege Version dialog box opens, with the version of your

Up grad e Gu id e


MicroStrategy metadata selected by default. From the drop-down list,select the version of MicroStrategy that priv ileges were most recentlyupgraded for and click OK .

l Migrate History List messages: Select this check box to migrateyour existing History List reposi tory to a new format for improvedsearch resul ts, scalabi l i ty, and performance. A fi le-based reposi torycan be migrated to a database-based reposi tory or a hybridreposi tory, and a database-based reposi tory can be migrated to ahybrid reposi tory.



l If you are using a database-based or hybrid History List reposi toryand want to continue using the same type of reposi tory, forinformation about upgrading the History List database, see 5.Update the Metadata.


Up grad e Gu id e












Up grad e Gu id e








l Update data import cubes (definition and cache) to PRIME : Selectthis check box to update al l Data Import datasets to the PRIMEarchi tecture. This archi tecture can improve the performance ofpubl ishing Data Import resul ts through the use of paral lel processing

Up grad e Gu id e


and other optimizations. This update is appl ied to data sets includedin your project through the use of Data Import.


8. Cl ick Next.


10. Cl ick Next.



If you are using a database-based History List, when upgrading toMicroStrategy 2020 you must upgrade the History List database tables.

To Up gr ad e t h e Hist o r y List Rep o si t o r y

1. From the Configuration Wizard Welcome page select Upgradeexisting environment to MicroStrategy Secure Enterprise and cl ickNext.

2. Select History List Repositories and cl ick Next. .

3. Select the DSN for the History List database, and speci fy the logininformation.

4. To upgrade existing History List messages to the current format, selectthe Copy History List content check box.

Up grad e Gu id e


If this check box is cleared, existing History List messages are notupgraded. The new tables required to support History List messages arestill created.

5. If you select to upgrade your existing History List messages, you canalso select the Compress data check box to compress al l existingHistory List messages. This compression can improve the performanceof using History List messages. However, the compression of yourHistory List messages can require signi ficant system resources duringthe upgrade.

To avoid the overhead of compressing your existing History Listmessages, clear the Compress data check box. Existing History Listmessages are not modi fied, but any newly created History Listmessages are created with the new compressed format.

6. Cl ick Next.

7. Review the avai lable information, and cl ick Finish .

7. MicroStrategy Web and Mobile Server

Upgrading MicroStrategy Web and Mobi le Server JSP wi l l only create newMicroStrategy.war and MicroStrategyMobile.war fi les in theinstal lation directory. You wi l l sti l l need to deploy the new .war fi le to asupported appl ication server.

Before upgrading MicroStrategy Web and Mobi le Server, be aware of thefol lowing considerations:

l Backup any changed MicroStrategy Web configuration fi les:

l ../WEB-INF/xml/config/mapConfig.xml

l ../WEB-INF/xml/sys_defaults.properties

Up grad e Gu id e


l ../WEB-INF/xml/sys_defaults.xml

l ../WEB-INF/web.xml

l Backup any changed MicroStrategy Mobi le configuration fi les:

l /WEB-INF/xml/sys_defaults.properties

l /WEB-INF/xml/sys_defaults.xml

l /WEB-INF/web.xml

l Backup any mobi le device configurations or saved any images from theMicroStrategy Photo Uploader widget, manual ly back them up beforeproceeding with your upgrade.

l /WEB-INF/xml/mobile

l /WEB-INF/SavedImages

l If you deploy any Web or Mobi le customizations and review the fol lowingSDK documentation to learn how to successful ly migrate thesecustomizations:

l MicroStrategy Web

l MicroStrategy Mobi le

l If you secure your MicroStrategy Mobi le connections through Certi ficateServer, you must upgrade your Certi ficate Server to support MicroStrategy2020 Mobi le appl ications.

For steps speci fic to your appl ication server, see:

l Deploying with Tomcat (Linux)

l Deploying with Oracle Glassfish Server (Solaris)

l Deploying with WebLogic and Apache (Solaris)

l Deploying with WebSphere and IBM HTTP Server (AIX)

Up grad e Gu id e

https://lw.microstrategy.com/msdz/MSDL/GARelease_Current/docs/projects/WebSDK/Content/topics/upgrade/UP_Upgrading_to_a_newer_version.htm

https://lw.microstrategy.com/msdz/MSDL/GARelease_Current/docs/projects/MobileSDK/Content/topics/iOS/iOS_Upgrading.htm


8. MicroStrategy Library

In MicroStrategy 10.9 through 11.0, MicroStrategy Library was automatical lydeployed in Tomcat and the MicroStrategyLibrary.war fi le instal ledin the <INSTALL_PATH>\LibraryWebMobile directory. MicroStrategy2019 and above requires administrators to perform the upgrade for theirLibrary deployment.

You must manually deploy a new Library WAR File after upgradingMicroStrategy Library.

This section contains high level steps and considerations for performing anupgrade or migrating MicroStrategy Library to a new environment.

Linux Environments

In MicroStrategy 10.9 to 11.0, the MicroStrategy instal ler asks theadministrator to enter a path to the Tomcat folder in order to deploy theLibrary.war fi le and instal ls the WAR fi le in the <INSTALL_

PATH>/LibraryWebMobile directory. Starting in 2019, administrators areno longer prompted with the Tomcat directory and can deploy the WAR fi leto the JEE server of choice.

Deploying the New WAR File

A new Library WAR File must be manually deployed after upgradingMicroStrategy Library, even between service packs.

You should backup the webapps folder as they are overwritten whendeploying new .war files.

Use the fol lowing steps to deploy a new WAR fi le for both Windows andLinux.

Up grad e Gu id e


1. Use the MicroStrategy instal ler to create a new MicroStrategy 2019Library.war fi le by doing a direct upgrade or new instal lation.

2. Redeploy the new Library.war fi le from the Library instal l di rectoryto the J2EE server being used. See the l ist of supported servers.

3. Migrate your customizations to the new environment, such as:

l .../webapps/MicroStrategyLibrary/images/

l .../webapps/MicroStrategyLibrary/plugins/


INF/classes/auth/

l Customized authentication configuration, such as SAMLauthentication



l Make sure MicroStrategy Library is pointing to the correctIntel l igence Server and Col laboration Server wi th correctauthentication setting by going to the Library AdministrationControl Panel .




4. Veri fy that MicroStrategy Library functional i ty including col laboration,sharing, exporting, printing, and al l other features are workingproperly. Ensure dossiers and documents are appearing.

The Col laboration Server is a separate component of MicroStrategy that isupgraded independently of Library. See step 9. MicroStrategy Col laborationfor more information.

Up grad e Gu id e

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


9. MicroStrategy Collaboration

MicroStrategy Col laboration has been enhanced to use a central datareposi tory instal led as part of the MicroStrategy Platform. Starting inMicroStrategy 2020 the Col laboration Server constructs the connectionstring to the MicroStrategy Data Reposi tory during runtime. After performingthe upgrade, Col laboration Server wi l l only support connections to theMicroStrategy Data Reposi tory.

After upgrading Col laboration Server, the previous data reposi tory remainsunchanged but i t wi l l not be used by the new version of Col laborationServer. Any comments stored in the previous data reposi tory wi l l need to bemoved to the new reposi tory to be accessible.

Migrating Comments to the MicroStrategy Data Repository



In order to recover col laboration messages that were stored in the previousversion of the MicroStrategy Platform please fol low these steps:

1. Stop the Col laboration service:

cd

Up grad e Gu id e


/opt/mstr/MicroStrategy/install/CollaborationServer/

./collaborationServer.sh stop

2. Start the previous data reposi tory:

cd/opt/mstr/MicroStrategy/install/CollaborationServer/MongoDB/

./mongod.sh start





/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


cmd> migrate


4. Stop the service Mongo DB.


The Col laboration Admin Page wi l l stop displaying the warning message atthis point.

Up grad e Gu id e













Up grad e Gu id e






6. Cl ick Next.





8. Cl ick Next.



10. Cl ick Finish .



Up grad e Gu id e












7. Cl ick Next.






Up grad e Gu id e



12. Upgrade the Platform Analytics Repository

After instal l ing Platform Analytics, there is a Platform Analytics Reposi tory(Platform Analytics warehouse table) where you can create the PlatformAnalytics project on your local machine. Upgrading the reposi tory isrequired with each platform and update release in order to benefi t fromPlatform Analytics warehouse new features, defect fixes and databasestructure optimizations.

The Configuration Wizard provides the fol lowing options:

l Host: Type the host name of the Platform Analytics warehouse. Bydefaul t, this is set to the last successful connection value.

l Port: Type the port number of the Platform Analytics warehouse. Bydefaul t, this is set to the last successful connection value.

l User Name: Type the user name for the Platform Analytics warehouse. Bydefaul t, this is set to the value from PAConsumerConfig.yaml fi le

l Password : Type the password for the Platform Analytics warehouse user.

Depending on the warehouse type you choose for the Host and Port, you mustset the parameter whDbType to either "postgresql" or "mysql" in thePAConsumerConfig.yaml file.

The default path is:

l Linux: /opt/MicroStrategy/PlatformAnalytics/Conf

l Windows: C:\Program Files

(x86)\MicroStrategy\Platform Analytics\conf

Click Next to proceed.

Up grad e Gu id e



You can also update the Platform Analytics reposi tory using theConfiguration Wizard in interactive mode.

How to Update the Repository in Interactive Mode

To update the Platform Analytics reposi tory using the ConfigurationWizard in interactive mode on Windows:

1. In a Windows console, enter one of the fol lowing commands:

l For 64-bi t, enter MACfgWiz_64 .

l For 32-bi t, enter MACfgWiz .

2. Cl ick Enter.





If you did not change the values, leave as default. The defaultpassword can be found at C:\Program Files (x86)\CommonFiles\MicroStrategy\express_password.txt

7. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leavethe field blank to use the defaul t name or type a di fferent name,

Up grad e Gu id e


and then cl ick Enter. The response.ini fi le is generated, and youare prompted whether to run the configuration immediately.


To update the Platform Analytics reposi tory using the ConfigurationWizard in interactive mode on Linux:

1. In a Linux console window, browse to HOME_PATH where HOME_


2. Browse to the bin directory.

3. At the command prompt, type mstrcfgwiz-editor , then cl ickEnter. The Configuration Wizard opens in command l ine mode.

4. Cl ick Enter.





9. By defaul t, the configuration is saved as Response.ini in the/HOME_PATH/ directory, where HOME_PATH is the directory youspeci fied as the Home Directory during instal lation. You can leavethe field blank to use the defaul t name or type a di fferent name,and then cl ick Enter. The response.ini fi le is generated, and you

Up grad e Gu id e


are prompted whether to run the configuration immediately.




Instructions

1. Launch MicroStrategy License Manager:

l Command line: In a Linux console window, browse to/opt/mstr/MicroStrategy/bin and run:

./mstrlicmgr -console

l GUI: In a Linux console window, browse to/opt/mstr/MicroStrategy/bin and run:

./mstrlicmgr

2. Update your l icense key:

l Command line:

1. Choose option 2. Update local License key.

2. Enter your MicroStrategy 2020 l icense key when prompted andpress Enter.

l GUI

1. Open the License Administration tab > Activate Installationand cl ick Next.

Up grad e Gu id e


2. Select Server Activation Using Code and enter your activationcode in the text box. Cl ick Next

3. Cl ick OK .

Performing a Parallel Upgrade

Configuring an Upgrade Test EnvironmentYour MicroStrategy environment includes multiple variables, such assecuri ty requirements, performance requirements, and VLDB settings, thatare unique. MicroStrategy cannot anticipate al l the ways these variablesmay interact wi th the upgrade process. Thus, MicroStrategy recommendsyou create a test environment and upgrade that environment fi rst, thenthoroughly test the upgraded instal lation. Once the tests are complete, thenupgrade your production environment. This ensures that the upgrade ofyour production environment proceeds smoothly and any unexpecteddi fficul ties do not require addi tional downtime.

For detai led information on testing your upgraded environment, see Chapter, Val idating the Upgrade.

If you do not want to create a test environment, MicroStrategy recommendsthat you create and save an Integrity Manager integrity test baseline of yourreports and documents. You can then execute an integrity test against thisbaseline when the upgrade is complete, to ensure that the upgrade has notaltered any of your report results. For detailed information about using IntegrityManager to execute integrity tests, see the Integri ty Manager chapter of theSystem Administration Guide .

Best Practices for Configuring an Upgrade Test Environment

MicroStrategy recommends that you fol low these best practices forconfiguring your upgrade test environment:

Up grad e Gu id e



l Do not modi fy any existing configuration objects. If you need addi tionalconfiguration objects for testing, you can ei ther create addi tional objects,or dupl icate an existing object and modi fy i t. This appl ies to databaseinstances, connections and logins, securi ty fi l ters, users and user groups,and securi ty roles.

l If your production environment is clustered, then your test environmentshould also be clustered.

l If your test and production data warehouses have di fferent database tableprefixes, make sure you are using the correct prefixes in the testenvironment's Warehouse Catalog.

l Create an integri ty test comparing reports from the upgraded testenvironment wi th the same reports in the production environment, so thatyou can easi ly see where any di fferences are.

l If possible, plan to execute data integri ty and performance load testsagainst the production warehouse. This ensures that the test scenariosare as representative of the production environment as possible.

l If you are creating reports and documents speci fical ly for an upgradeintegri ty test, create those reports and documents before you dupl icatethe production metadata.

l If you are using connection mapping for users to access the datawarehouse, check to be sure that al l users can log in to the test datawarehouse, since user passwords may di ffer between the test warehouseand the production warehouse.

One way to manage this is to create a new generic database login, and then usethe following sample Command Manager script to change users ' connectionmappings to use this new login:

ALTER CONNECTION MAP FOR USER "username" DBINSTANCE "production_warehouse_

instance" DBLOGIN "test_login" ON PROJECT "project";

Up grad e Gu id e


l If you are planning to upgrade Enterprise Manager, run a data load beforeyou upgrade Intel l igence Server. If you do not run a data load beforeupgrading Enterprise Manager and the projects on the Intel l igenceServers, you may lose access to some statistics data. Al l EnterpriseManager upgrades require that you also upgrade your statistic tables,Enterprise Manager reposi tory, and your Enterprise Manager metadata.

l If you are using Narrowcast Server, make sure that the database copy ofthe Narrowcast reposi tories is not used when setting up the NarrowcastServer test environment. Instead, make a copy of the reposi tories wi th theCopy Reposi tory uti l i ty included with Narrowcast Administrator and usethis copy. This ensures that the test environment does not accidental lyrefer to a production server. For detai led instructions on creating a copyof the Narrowcast reposi tories, see the Narrowcast Server UpgradeGuide.

High-Level Steps to Configure an Upgrade Test Environment

To ensure that your tests accurately reflect the upgrade experience, theupgrade test environment should reflect the production environment asclosely as possible.

To Configure a Test Environment

1. Set up the hardware for the environment. MicroStrategy recommendsthat this hardware dupl icate the configuration of the productionenvironment as closely as possible.

2. Instal l your current version of MicroStrategy in the test environment.

3. Using the Project Dupl ication Wizard, dupl icate the productionmetadata into the test environment. For instructions on using theProject Dupl ication Wizard, see the Managing Your Projects chapter ofthe System Administration Guide, or see the Project Dupl icationWizard Help.

Up grad e Gu id e



4. Make sure that your test environment Intel l igence Server is connectedto your test environment metadata, and not your production metadata.

5. Using the Project Dupl ication Wizard, dupl icate the productionmetadata into the test environment.

For instructions on using the Project Duplication Wizard, see theManaging Your Projects chapter of the System AdministrationGuide , or see the Project Duplication Wizard Help.

6. Ensure your test environment Intel l igence Server is connected to yourtest environment metadata.

7. If you do not intend to execute your tests against a productionwarehouse, dupl icate the production warehouse, and ensure that thetest environment points to the dupl icate warehouse and not theproduction warehouse.

8. Upgrade the test environment, fol lowing the procedures laid out inPerforming a Paral lel Upgrade on a Windows Deployment, page 71

9. Test the upgrade, fol lowing the guidel ines laid out in Val idating theUpgrade, page 155.

Performing a Parallel Upgrade on a Windows DeploymentThis section covers the procedure for executing a paral lel upgrade of yourWindows environment to MicroStrategy 2020. Careful ly review the PlanningYour Upgrade and Configuring an Upgrade Test Environment sectionsbefore proceeding with your upgrade.


Fol low the procedures outl ined in the Instal lation and Configuration Guideto perform a fresh instal lation of MicroStrategy 2020 on your testenvironment.

Up grad e Gu id e



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


Once you have instal led and configured your test environment, proceedwith Step 2. Connect the Intel l igence Server to a Copy of Your Metadata.

2. Connect the Intelligence Server to a Copy of Your Metadata

Before connecting your new Intel l igence Server to the metadata, make acopy of your production metadata in your database. You wi l l connect theIntel l igence Server to this metadata copy in the fol lowing steps.

Repeat these steps for each Intelligence server node in a clusteredenvironment.


1. In Windows, go to Start > All Programs > MicroStrategy Tools >Configuration Wizard . The Configuration Wizard opens.



4. Cl ick Next.



7. Cl ick Next.



l Port number: You can use the defaul t port number (34952) orspeci fy another port number. The port number is how a server

Up grad e Gu id e


process identi fies i tsel f on the machine on which i t is running. If theport number is used by another process, such as in a sharedenvironment, speci fy an avai lable port number.






l Identify missing DSNs: Select this check box to veri fy that al lDSNs, which are used for database instances created inMicroStrategy, are local ly avai lable. This helps to ensure that yourdatabase instances in MicroStrategy can connect successful ly totheir associated data sources.

By defaul t, this check box is cleared, which means the avai labi l i ty ofal l local DSNs used in database instances is not veri fied. Whi le thismay mean that al l DSNs used in database instances are not

Up grad e Gu id e



avai lable, i t can save system resources required for the Intel l igenceServer configuration process.

2. Cl ick Next.









Up grad e Gu id e







4. Cl ick Next.








l Enable Basic Statistics (For newly created projects andexisting projects not logging statistics): Basic statistics for new

Up grad e Gu id e


projects and any projects that are not currently logging statisticswi l l be enabled. You can al ter the settings in Project ConfigurationEdi tor in MicroStrategy Developer to:






7. Cl ick Next.


9. Cl ick Finish.

3. Update the Metadata Copy

After upgrading the Intel l igence Server, update the copy of your metadataby performing the procedure that fol lows. This procedure creates andupdates metadata tables to support new features avai lable in MicroStrategy2020.


During the metadata update process, the Configuration Wizard generatesaddi tional SQL for tasks such as managing indexes and primary keys. Toview this SQL during the update process, on the Summary Page of theConfiguration Wizard, in the Summary pane, cl ick SQL Preview. Inaddi tion, once you have completed the update process, the generated SQL

Up grad e Gu id e


is saved in the MicroStrategy common fi les directory. The fi le name isOriginalScript_generated.sql , where OriginalScript is thename of the original SQL update script. For example, i f you are updating anOracle database, the original SQL update script is mdorcl.sql and thegenerated SQL fi le is mdorcl_generated.sql .


l If you have made any changes to the priv ileges assigned to the out-of-the-box MicroStrategy user groups and security roles, updating the metadatamay overwrite those changes.







l The metadata update process can be executed only by a MicroStrategyuser who is ei ther a member of the System Administrators user group, or

Up grad e Gu id e


is the out-of-the-box Administrator user. Having al l administrativeprivi leges is not sufficient: the user must be a member of the SystemAdministrators user group.









Up grad e Gu id e












Al l new objects are created in this format, and existing objects areconverted to the new format as they are saved. Selecting LeanObjects migration converts al l objects in the reposi tory to the new

Up grad e Gu id e


format at once. This option is automatical ly selected i f you selectUpgrade metadata reposi tory.






l Migrate History List messages: Select this check box to migrateyour existing History List reposi tory to a new format for improvedsearch resul ts, scalabi l i ty, and performance. A fi le-based reposi torycan be migrated to a database-based reposi tory or a hybridreposi tory, and a database-based reposi tory can be migrated to a

Up grad e Gu id e


hybrid reposi tory.



l If you are using a database-based or hybrid History List reposi toryand want to continue using the same type of reposi tory, forinformation about upgrading the History List database, see 4.History List Database Reposi tory.




Up grad e Gu id e












Up grad e Gu id e








8. Cl ick Next.

Up grad e Gu id e



10. Cl ick Next.



If you are using a database-based History List, when upgrading toMicroStrategy 2020 you must create the History List database tables in thetest environment.

To Cr eat e t h e Tab les in t h e Hist o r y List Rep o si t o r y

1. Open the MicroStrategy Configuration Wizard.

2. Select Metadata, History List and Statistics Repository Tables andcl ick Next.

3. Select the History List Tables check box and cl ick Next.

4. From the DSN drop-down l ist, select the DSN for your History Listreposi tory.

If a DSN for your History List reposi tory does not exist, you can selectNew to open the Connectivi ty Wizard and create a new DSN.

5. Type a User Name and Password that can connect to the data source.

The database user you provide becomes the owner of al l History Listtables and objects. The database user is required to have the Select,Create, Insert, and Drop permissions.

6. After providing a val id user name and password, you can cl ick SQLPreview to open the SQL Preview dialog box. This dialog box providesthe SQL statements that wi l l be executed on your data source to createthe History List tables. Cl ick Close once you are done reviewing the

Up grad e Gu id e


SQL statements to return to the Configuration Wizard.

If you use the advanced options to change the SQL script, you cancl ick SQL Preview after selecting the new script to see an updatedl isting of the SQL statements that wi l l be executed.

7. Cl ick Advanced .

8. In the Table Prefix field, you can speci fy a prefix to be used whenHistory List tables are created in the database you select. This is anoptional configuration. However, you must use di fferent prefixes foryour metadata tables and your History List tables i f you store them inthe same database.

Most databases use a prefix of two characters. However, you cansupply as many letters, numbers, underscores (_), and periods (.) asrequired to support your database prefixes. To determine characterl imi ts for a prefix, refer to your thi rd-party database vendordocumentation.

If you use a table prefix for your History List tables, you must alsodefine this table prefix when you create a database instance toconnect to the History List tables.

9. In the Script field, a SQL script to create History List tables optimizedfor your database is selected. If you want to speci fy a di fferent script,cl ick ... to browse to and select a customized script

10. Cl ick Next.


You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure History List reposi tories on other systems or to run si lentconfigurations at a later time.

12. Cl ick Finish to apply the configuration and create the History Listreposi tory.

Up grad e Gu id e


5.1 Updating the Enterprise Manager Project











Up grad e Gu id e






6. Cl ick Next.





8. Cl ick Next.



10. Cl ick Finish .



Up grad e Gu id e












7. Cl ick Next.






Up grad e Gu id e



7. Migrate Platform Analytics Data to MicroStrategy Repository

The Platform Analytics Data Migration tool is used to help existingcustomers migrate their data from MySQL to the newly supportedPostgreSQL reposi tory. This tool can help migrate both new and oldversions of MySQL dump fi les to the latest version of Platform Analytics.

Backup Prerequisites :

l C:\Program Files (x86)\MicroStrategy\Platform

Analytics\PAConsumerConfig.yaml populated with:

warehouseDbConnection :

l whHost : 127.0.0.1

l whUser : root

l whPasswd : encrypted_password

l whPort : 3306

l whDb : platform_analytics_wh

l mysql-connector-java.jar is present inPlatformAnalytics\lib directory.

l Disk space suffic ient to hold a backup of your MySQL platform_analytics_wh database.

Restore Prerequisites :

l PAConsumerConfig.yaml populated with:

pgWarehouseDbConnection :

Up grad e Gu id e



l pgWhHost : 127.0.0.1

l pgWhUser : postgres

l pgWhPasswd : encrypted password

l pgWhPort : 5432

l pgWhDb : platform_analytics_wh

l Path to .csv files from a previous backup of platform_analytics_wh .

l Enough disk space available to PostgreSQL to restore the backed up ..csvfiles from MySQL.

Launching the Platform Analytics Data Migration Tool

1. Navigate to your Platform Analytics home directory and go into the bindirectory:

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

Analytics\bin

2. Cal l the fol lowing script:

platform-analytics-data-migration-tool.bat

3. You wi l l then be prompted with the fol lowing :

This is the Platform Analytics Data Migration Tool. The purpose of this

tool is to help migrate your data from an existing Mysql Warehouse to a

new PostgreSQL Warehouse.

Please select from the following options:

1) Backup

2) Restore

3) Backup and Restore

0) Exit

Up grad e Gu id e


Migration Workflow

Backu p

1. Provide the path to the directory where the MySQL backup wi l l bestored.

2. The tool wi l l then begin backing up the MySQL platform_

analytics_wh speci fied in your PAConsumerConfig.yaml fi le,placing the backup in your speci fied path.

Rest o r e

1. Provide the path to the directory where the MySQL backup is stored.

2. The tool wi l l prompt you again i f you are sure you are okay to dropyour PostgreSQL platform_analytics_wh schema.

3. If yes is selected, the platform_analytics_wh schema wi l l bedropped and recreated matching the version of your MySQL dump.

4. The backup data is then imported into the newly created platform_

analytics_wh schema.

5. The platform_analytics_wh schema wi l l then be upgraded to thelatest version of Platform Analytics.

Recommended Upgrade Procedures

1. On your new MicroStrategy 2020 machine, populate thePAConsumerConfig.yaml has the MySQL and PostgreSQLinformation shown in the prerequisi tes above.

2. Copy the mysql-connector-java.jar from your previousinstal lation to the Platform Analytics\lib directory on the newmachine.

Up grad e Gu id e


3. Go to your Platform Analytics bin directory and cal l the platform-

analytics-data-migration-tool.bat fi le.

4. Select the Backup and Restore option (3).

5. Enter the ful l desired directory path for the database to be backed upto and restored from.

6. Wait unti l the backup is complete. The tool you wi l l then prompt i f i t isokay to recreate the PostgreSQL warehouse and select yes.

7. The program wi l l then restore your MySQL backup fi les into your newPostgreSQL warehouse and the data migration wi l l be complete.

8. Migrate Comments to a New Installation of Collaboration Server

In MicroStrategy 2020, Col laboration Server uses MicroStrategy Reposi toryto store user comments. When performing a paral lel upgrade, the newinstal lation of Col laboration Server wi l l be automatical ly configured toMicroStrategy Reposi tory during instal lation. After performing the upgrade,Col laboration Server wi l l only support connections to the MicroStrategyData Reposi tory. Any existing user comments wi l l need to be migrated tothe new reposi tory to remain accessible.



Up grad e Gu id e

https://www2.microstrategy.com/producthelp/2020/InstallConfig/en-us/Content/collaboration_admin_tool.htm


On t h e exist in g Co l lab o r at io n Ser ver :

1. Edi t the mongod.cfg fi le under the C:\Program

Files\MicroStrategy\Collaboration Server\MongoDB

directory, add a new section net with bindIpAll: true . It wi l lal low the MongoDB to be accessible outside of the machine so we canuse the Col laboration Server Administration Tool to connect to theMongoDB from another machine.

Make sure to use four spaces instead of a tab for the indentation becausethe mongod.cfg is in YAML format.

...

processManagement:

windowsService:

serviceName: MSTR_mongodb

displayName: MongoDB

security:

authorization: enabled

net:

bindIpAll: true


3. Restart the Mongo DB service to apply the modi fied configuration.

4. Open the config.json fi le under the C:\Program

Files\MicroStrategy\Collaboration Server directory, copythe whole l ine of the dburl property.

On t h e n ew Co l lab o r at io n Ser ver m ach in e:


2. Stop the MicroStrategy Col laboration/Real time Service.

3. Open the config.json fi le under the C:\Program

Up grad e Gu id e


Files\MicroStrategy\Collaboration Server directory, pastethe dburl l ine at the top of the content. Replace the localhost

string in the dburl with the IP of the existing 2019 machine. Makesure the content is in val id JSON format. Here is an example of themodi fied config.json fi le.

{

"dburl": "mongodb://mstr:xxxx@{IP of the existing 2019

machine}:27017/mstr_collab?authSource=admin",

"port": 3000,

"logging": false,

"authorizationServerUrl":

"http://localhost:8080/MicroStrategyLibrary/api",

"dataSource": {

"username": "mstr_collab",

"password": "xxxxxx"

},

"scaling": "none",

"secretKey": "xxxx",

"enableConfigApi": true

}





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


Up grad e Gu id e


cmd> migrate





In st r u ct io n s

1. Open MicroStrategy License Manager from Start menu > Programs >MicroStrategy Tools > License Manager.

2. Go to the License Administration tab > Activate Server Installationand cl ick Next .

3. Select the Server Activation using Activation Code option and enteryour Activation Code in the text field. Cl ick Next .

4. Cl ick OK .

Performing a Parallel Upgrade on a Linux DeploymentThis section covers the procedure for executing a paral lel upgrade of yourLinux environment to MicroStrategy 2020. Careful ly review the PlanningYour Upgrade and Configuring an Upgrade Test Environment sectionsbefore proceeding with your upgrade.


Fol low the procedures outl ined in the Instal lation and Configuration Guideto perform a fresh instal lation of MicroStrategy 2020 on your testenvironment. Once you have instal led and configured your test

Up grad e Gu id e

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


environment, proceed with Step 2. Connect the Intel l igence Server to aCopy of Your Metadata.

2. Connect the Intelligence Server to a Copy of Your Metadata

Before connecting your new Intel l igence Server to the metadata, make acopy of your production metadata in your database. You wi l l connect theIntel l igence Server to this metadata copy in the fol lowing steps.

Repeat these steps for each Intelligence server node in a clusteredenvironment.


1. Run the MicroStrategy Configuration Wizard:

cd /opt/mstr/Microstrategy/bin

./mstrcfgwiz



4. Cl ick Next.



7. Cl ick Next.

Up grad e Gu id e




l Port number: You can use the defaul t port number (34952) orspeci fy another port number. The port number is how a serverprocess identi fies i tsel f on the machine on which i t is running. If theport number is used by another process, such as in a sharedenvironment, speci fy an avai lable port number.






l Identify missing DSNs: Select this check box to veri fy that al lDSNs, which are used for database instances created inMicroStrategy, are local ly avai lable. This helps to ensure that yourdatabase instances in MicroStrategy can connect successful ly to

Up grad e Gu id e



their associated data sources.

By defaul t, this check box is cleared, which means the avai labi l i ty ofal l local DSNs used in database instances is not veri fied. Whi le thismay mean that al l DSNs used in database instances are notavai lable, i t can save system resources required for the Intel l igenceServer configuration process.

2. Cl ick Next.








Up grad e Gu id e






4. Cl ick Next.







Up grad e Gu id e





l Enable Basic Statistics (For newly created projects andexisting projects not logging statistics): Basic statistics for newprojects and any projects that are not currently logging statisticswi l l be enabled. You can al ter the settings in Project ConfigurationEdi tor in MicroStrategy Developer to:






7. Cl ick Next.


9. Cl ick Finish.

3. Update the Metadata Copy

After upgrading the Intel l igence Server, update the copy of your metadataby performing the procedure that fol lows. This procedure creates andupdates metadata tables to support new features avai lable in MicroStrategy2020.


Up grad e Gu id e




l If you have made any changes to the priv ileges assigned to the out-of-the-box MicroStrategy user groups and security roles, updating the metadatamay overwrite those changes.





Up grad e Gu id e












Up grad e Gu id e













Up grad e Gu id e


Al l new objects are created in this format, and existing objects areconverted to the new format as they are saved. Selecting LeanObjects migration converts al l objects in the reposi tory to the newformat at once. This option is automatical ly selected i f you selectUpgrade metadata reposi tory.






l Migrate History List messages: Select this check box to migrateyour existing History List reposi tory to a new format for improved

Up grad e Gu id e


search resul ts, scalabi l i ty, and performance. A fi le-based reposi torycan be migrated to a database-based reposi tory or a hybridreposi tory, and a database-based reposi tory can be migrated to ahybrid reposi tory.



l If you are using a database-based or hybrid History List reposi toryand want to continue using the same type of reposi tory, forinformation about upgrading the History List database, see 4.History List Database Reposi tory.



7. Select each project you want to update. Only projects that are loadedon Intel l igence Server can be updated. Project updates can include

Up grad e Gu id e


any of the fol lowing options:










Up grad e Gu id e








It is easier to update OLAP Services Cube caches and data importcubes to PRIME during the upgrade process. If you do not update them

Up grad e Gu id e


now, each cube is updated when it is used. Doing the upgrade all atonce ensures consistent performance for end users.

8. Cl ick Next.


10. Cl ick Next.



If you are using a database-based History List, when upgrading toMicroStrategy 2020 you must create the History List database tables in thetest environment.

To Cr eat e t h e Tab les in t h e Hist o r y List Rep o si t o r y

1. Open the MicroStrategy Configuration Wizard.

2. Select Metadata, History List and Statistics Repository Tables andcl ick Next.

3. Select the History List Tables check box and cl ick Next.

4. From the DSN drop-down l ist, select the DSN for your History Listreposi tory.

If a DSN for your History List reposi tory does not exist, you can selectNew to open the Connectivi ty Wizard and create a new DSN.

5. Type a User Name and Password that can connect to the data source.

The database user you provide becomes the owner of al l History Listtables and objects. The database user is required to have the Select,Create, Insert, and Drop permissions.

Up grad e Gu id e


6. After providing a val id user name and password, you can cl ick SQLPreview to open the SQL Preview dialog box. This dialog box providesthe SQL statements that wi l l be executed on your data source to createthe History List tables. Cl ick Close once you are done reviewing theSQL statements to return to the Configuration Wizard.

If you use the advanced options to change the SQL script, you cancl ick SQL Preview after selecting the new script to see an updatedl isting of the SQL statements that wi l l be executed.

7. Cl ick Advanced .

8. In the Table Prefix field, you can speci fy a prefix to be used whenHistory List tables are created in the database you select. This is anoptional configuration. However, you must use di fferent prefixes foryour metadata tables and your History List tables i f you store them inthe same database.

Most databases use a prefix of two characters. However, you cansupply as many letters, numbers, underscores (_), and periods (.) asrequired to support your database prefixes. To determine characterl imi ts for a prefix, refer to your thi rd-party database vendordocumentation.

If you use a table prefix for your History List tables, you must alsodefine this table prefix when you create a database instance toconnect to the History List tables.

9. In the Script field, a SQL script to create History List tables optimizedfor your database is selected. If you want to speci fy a di fferent script,cl ick ... to browse to and select a customized script

10. Cl ick Next.

Up grad e Gu id e



You can cl ick Save to save the configuration as a response (.ini ) fi le toconfigure History List reposi tories on other systems or to run si lentconfigurations at a later time.

12. Cl ick Finish to apply the configuration and create the History Listreposi tory.









Up grad e Gu id e









6. Cl ick Next.





8. Cl ick Next.



10. Cl ick Finish .

Up grad e Gu id e














7. Cl ick Next.


Up grad e Gu id e







7. Migrate Platform Analytics Data to MicroStrategy Repository

The Platform Analytics Data Migration tool is used to help existingcustomers migrate their data from MySQL to the newly supportedPostgreSQL reposi tory. This tool can help migrate both new and oldversions of MySQL dump fi les to the latest version of Platform Analytics.

Backup Prerequisites :

l /MicroStrategy/install/PlatformAnalytics/PAConsumerCo

nfig.yaml populated with:

warehouseDbConnection :

l whHost : 127.0.0.1

l whUser : root

l whPasswd : encrypted_password

l whPort : 3306

l whDb : platform_analytics_wh

l mysql-connector-java.jar is present inPlatformAnalytics/lib directory.

l Disk space suffic ient to hold a backup of your MySQL platform_analytics_wh database.

Up grad e Gu id e



Restore Prerequisites :

l PAConsumerConfig.yaml populated with:

pgWarehouseDbConnection :

l pgWhHost : 127.0.0.1

l pgWhUser : postgres

l pgWhPasswd : encrypted password

l pgWhPort : 5432

l pgWhDb : platform_analytics_wh

l Path to .csv files from a previous backup of platform_analytics_wh .

l Enough disk space available to PostgreSQL to restore the backed up ..csvfiles from MySQL.

Launching the Platform Analytics Data Migration Tool

1. Navigate to your Platform Analytics home directory and go into the bindirectory:

/opt/mstr/MicroStrategy/PlatformAnalytics/bin

2. Run the fol lowing script:

./platform-analytics-data-migration-tool.sh

3. You wi l l then be prompted with the fol lowing :

This is the Platform Analytics Data Migration Tool. The purpose of this

tool is to help migrate your data from an existing Mysql Warehouse to a

new PostgreSQL Warehouse.

Please select from the following options:

1) Backup

2) Restore

3) Backup and Restore

0) Exit

Up grad e Gu id e


Migration Workflow

Backu p

1. Provide the path to the directory where the MySQL backup wi l l bestored.

2. The tool wi l l then begin backing up the MySQL platform_

analytics_wh speci fied in your PAConsumerConfig.yaml fi le,placing the backup in your speci fied path.

Rest o r e

1. Provide the path to the directory where the MySQL backup is stored.

2. The tool wi l l prompt you again i f you are sure you are okay to dropyour PostgreSQL platform_analytics_wh schema.

3. If yes is selected, the platform_analytics_wh schema wi l l bedropped and recreated matching the version of your MySQL dump.

4. The backup data is then imported into the newly created platform_

analytics_wh schema.

5. The platform_analytics_wh schema wi l l then be upgraded to thelatest version of Platform Analytics.

Recommended Upgrade Procedures

1. On your new MicroStrategy 2020 machine, populate thePAConsumerConfig.yaml has the MySQL and PostgreSQLinformation shown in the prerequisi tes above.

2. Copy the mysql-connector-java.jar from your previousinstal lation to the PlatformAnalytics/lib directory on the newmachine.

Up grad e Gu id e


3. Go to your PlatformAnalytics/bin directory and cal l theplatform-analytics-data-migration-tool.sh fi le.

4. Select the Backup and Restore option (3).

5. Enter the ful l desired directory path for the database to be backed upto and restored from.

6. Wait unti l the backup is complete. The tool wi l l then prompt i f i t is okayto recreate the PostgreSQL warehouse and select yes.

7. The program wi l l then restore your MySQL backup fi les into your newPostgreSQL warehouse and the data migration wi l l be complete.

8. Migrate Comments to a New Installation of Collaboration Server

In MicroStrategy 2020, Col laboration Server uses MicroStrategy Reposi toryto store user comments. When performing a paral lel upgrade, the newinstal lation of Col laboration Server wi l l be automatical ly configured toMicroStrategy Reposi tory during instal lation. After performing the upgrade,Col laboration Server wi l l only support connections to the MicroStrategyData Reposi tory. Any existing user comments wi l l need to be migrated tothe new reposi tory to remain accessible.



Up grad e Gu id e

https://www2.microstrategy.com/producthelp/2020/InstallConfig/en-us/Content/collaboration_admin_tool.htm


On t h e exist in g Co l lab o r at io n Ser ver :

1. Edi t the mongod.cfg fi le under the/opt/mstr/MicroStrategy/install/CollaborationServer/

MongoDB/ directory, add a new section net with bindIpAll: true .It wi l l al low the MongoDB to be accessible outside of the machine sowe can use the Col laboration Server Administration Tool to connect tothe MongoDB from another machine.

Make sure to use four spaces instead of a tab for the indentation becausethe mongod.cfg is in YAML format.

...

processManagement:

windowsService:

serviceName: MSTR_mongodb

displayName: MongoDB

security:

authorization: enabled

net:

bindIpAll: true

2. Restart the Mongo DB service to apply the modi fied configuration.

./mongod.sh restart

3. Open the config.json fi le under the/opt/mstr/MicroStrategy/install/CollaborationServer/

directory, copy the enti re dburl property.

On t h e n ew Co l lab o r at io n Ser ver m ach in e:

1. Stop the MicroStrategy Col laboration/Real time Service.

./collaborationServer.sh stop

2. Open the config.json fi le under the

Up grad e Gu id e


/opt/mstr/MicroStrategy/install/CollaborationServer/

directory paste the dburl l ine at the top of the content. Replace thelocalhost string in the dburl with the IP of the existingCol laboration Server machine. Make sure the content is in val id JSONformat. Here is an example of the modi fied config.json fi le.

{

"dburl": "mongodb://mstr:xxxx@{IP of the existing 2019

machine}:27017/mstr_collab?authSource=admin",

"port": 3000,

"logging": false,

"authorizationServerUrl":

"http://localhost:8080/MicroStrategyLibrary/api",

"dataSource": {

"username": "mstr_collab",

"password": "xxxxxx"

},

"scaling": "none",

"secretKey": "xxxx",

"enableConfigApi": true

}





/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


Up grad e Gu id e


cmd> migrate



./collaborationServer.sh start



1. Launch MicroStrategy License Manager:

l Command line: In a Linux console window, browse to/opt/mstr/MicroStrategy/bin and run:

./mstrlicmgr -console

l GUI: In a Linux console window, browse to/opt/mstr/MicroStrategy/bin and run:

./mstrlicmgr

2. Update your l icense key:

l Command line:

1. Choose option 2. Update local License key.

2. Enter your MicroStrategy 2020 l icense key when prompted andpress Enter.

l GUI

1. Open the License Administration tab > Activate Installationand cl ick Next.

Up grad e Gu id e


2. Select Server Activation Using Code and enter your activationcode in the text box. Cl ick Next

3. Cl ick OK .

Using MicroStrategy Backup and Restore

MicroStrategy Backup is an appl ication that al lows you to easi ly back upessential MicroStrategy configurations, databases, and fi les. It also al lowsyou to back up on-premises environments and restore your information tonew MicroStrategy Cloud Platform for AWS or MicroStrategy Cloud Platformfor Azure environments.

Upgrading with MicroStrategy Backup al lows users to create mirrorenvironments to test new projects, create disaster recovery environments,migrate current MicroStrategy deployment to the cloud, and more.

How To Perform an Upgrade with MicroStrategy Backup1. MicroStrategy Backup Preparations

2. Instal l MicroStrategy Backup

3. Run MicroStrategy Backup

4. Restore MicroStrategy Backup

1. MicroStrategy Backup PreparationsBefore you begin the upgrade with MicroStrategy Backup, take care of thefol lowing i tem:

l Intel l igence Server must run on a Linux Operating System (preferably RedHat Enterprise Linux or equivalent).

l Instal l Pigz Package on your environment.

Use the fol lowing command:

sudo yum install pigz -y

Up grad e Gu id e


l If you intend to restore an archive onto MicroStrategy Cloud Platform forAWS or MicroStrategy Cloud Platform for Azure:

l Projects must be unlocked i f you intend to restore an archive ontoMicroStrategy Cloud Platform for AWS or MicroStrategy CloudPlatform for Azure.

By defaul t, projects are unlocked. To unlock a project:

1. Open Developer.

If you are running MicroStrategy Developer on Windows for thefirst time, run it as an administrator.

Right-c lick the program icon and select Run as Administrator.

This is necessary in order to properly set the Windows registrykeys. For more information, see KB43491 .

2. From the folder l ist, select a project name.

3. In the menu bar, cl ick Administration > Locking > Unlock.

l Scheduler must be turned on.

Steps to enable Scheduler:

1. Open Developer.

If you are running MicroStrategy Developer on Windows for thefirst time, run it as an administrator.

Right-c lick the program icon and select Run as Administrator.

This is necessary in order to properly set the Windows registrykeys. For more information, see KB43491 .

2. Right-cl ick a project source and select Configure MicroStrategyIntelligence Server.

Up grad e Gu id e

https://community.microstrategy.com/s/article/KB43491-What-access-does-the-Microsoft-Windows-User-need-to-have

https://community.microstrategy.com/s/article/KB43491-What-access-does-the-Microsoft-Windows-User-need-to-have


3. Under Server Defini tion, select Advanced .

4. Select the Use MicroStrategy Scheduler check box.

l Switching from an Enterprise environment to a Team or Departmentenvironment only al lows you to choose a maximum of two nodes toback up cubes and caches. Be aware of the di fferences in RAM usagewhen moving from a di fferent environment.

l Ensure you have an S3 bucket or Azure Storage Account (wi thStandard Performance Type) set up.

Be aware of the restrictions of MicroStrategy Backup:

l MicroStrategy metadata can be on a MySQL or PostgreSQL database.MicroStrategy environments prior to MicroStrategy 2020 use MySQL.MicroStrategy environments 2020 and onward use PostgreSQL.

l Addi tional flat fi les wi l l be restored to a single directory. The back up andrestoration of fi les requires your discretion.

l Addi tional DSNs require the same credential and server location as themetadata.

l You can only back up a maximum of four nodes in a cluster.

l You cannot back up OS configurations, such as timezone and heap size.

Once you have the above settings and instal lations, you can begininstal l ing MicroStrategy Backup.

2. Install MicroStrategy BackupTo instal l MicroStrategy Backup, fol low the instructions below:

1. Create a new directory for MicroStrategy Backup in your MicroStrategyInstal lation directory using the command:

mkdir mstrbak

Up grad e Gu id e

https://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-bucket.html

https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal


2. Download the MicroStrategy Backup Tool using the command:

wget https://s3.amazonaws.com/mstrbak/internal/mstrbak.zip

3. Unzip and extract the fi le.

4. Change the directory to the MicroStrategy Backup cl ient executableusing the fol lowing command:

cd Mstrbak-client

5. Run the fol lowing command in the MicroStrategy Backup directory toensure the executable permissions are set for the fi les.

chmod +x fix-permissions.sh

Now that MicroStrategy Backup is downloaded and you are in the correctdi rectory, you can move on to 3. Run MicroStrategy Backup.

3. Run MicroStrategy BackupYou are now posi tioned to run the MicroStrategy Backup cl ient. You can runMicroStrategy Backup in one of three modes and, depending on the modeyou select, running the MicroStrategy Backup cl ient wi l l di ffer.

ModeFlag

Behavior

HowtoRuninPromptedMode

-

p

Runs the client in Prompted mode. This mode asks the user forinformation about the location of var ious MicroStrategy items.

This is an interactive mode for users running MicroStrategy Backup forthe first t ime.

How - Runs the client in Cloud Only mode. This flag indicates that the system

Up grad e Gu id e


ModeFlag

Behavior

toRuninCloudMode

c

you are running the client on was originally provisioned by theMicroStrategy Cloud Platform. This flag is a simplif ied version ofprompted mode, and will only ask a subset of questions limited tocredentials and storage location (S3 Bucket or Azure Storage Blob).

This is an express backup mode specif ically for users with MSTR Cloudenvironments. This mode is ideal for users who want to quickly backuptheir entire environment in the default location. This mode is also idealfor upgrading by creating a parallel environment.

What are the default install locations?

Value Default File Path

BakFileLocation

/opt/mstr/mstrbak/

CachePath/opt/mstr/MicroStrategy/IntelligenceServe

r/Caches/cloud_10s/

CubePath/opt/mstr/MicroStrategy/IntelligenceServe

r/Cube/cloud_10s/

InboxPath/opt/mstr/MicroStrategy/IntelligenceServe

r/Inbox/cloud_10s/

LibraryImagesPath

/opt/apache/tomcat/latest/webapps/MicroSt

rategyLibrary/images/

LibraryPluginsPath


rategyLibrary/plugins/

MSTRInstallPath

/opt/mstr/MicroStrategy/

MobileConf /opt/apache/tomcat/latest/webapps/MicroSt

Up grad e Gu id e


ModeFlag

Behavior

Value Default File Path

igPath rategyMobile/WEB-INF/xml/mobile/

MobileImagesPath


rategyMobile/images/

MobilePluginsPath


rategyMobile/plugins/

MySQLbin /usr/bin/mysqldump

TomcatPath

/opt/apache/tomcat/latest/

WebConfigPath

/opt/apache/tomcat/latest/webapps/MicroStrategy/WEB-

INF/xml/sys_defaults.properties

WebImagesPath

/opt/apache/tomcat/latest/webapps/MicroStrategy/image

s/

WebPluginsPath


rategy/plugins/

HowtoRuninSilentMode

-

r

Runs the client in Silent mode. This reads from a JSON file forinformation about the location of var ious MicroStrategy items.

This mode is for automated processes or development operations. Thismode works as a back up client in case you need to restore yourinformation.

How to Run in Prompted Mode

Prompted mode is an interactive mode that asks you for information aboutyour MicroStrategy environment, such as the path to the instal lationdirectory, cubes, caches, images, plugins, etc. Prompts beginning with

Up grad e Gu id e


[REQUIRED] must be answered. You can skip prompts beginning with[OPTIONAL] .

1. Enter the fol lowing command to run prompted mode. See Addi tionalFlags for addi tional parameters to add to your execution command.

./mstrbak -p

2. Answer the prompted questions. To find the correct input for eachentry, see How to Obtain MicroStrategy Backup Inputs.

Prompted mode questions:

1. Enter the instal l path /opt/mstr/MicroStrategy .

2. Enter the project source name.

3. Enter your credentials from your cloud environment's welcomeemai l .

4. Enter the name of the metadata DSN.

5. Enter your credentials from your cloud environment's welcomeemai l .

6. Enter the path to the dump bin.

7. Enter your metadata prefix.

8. Enter yes to keep the same projects loaded.

Enter no i f you don't want to keep your projects loaded and enterthe names of the projects to register and unregister.

9. Enter yes to backup your Platform Analytics warehouse and enteryour Platform Analytics DSN name.

Enter no i f you don't want to backup your Platform Analyticswarehouse.

10. Enter yes to backup your Col laboration Server database and

Up grad e Gu id e


enter your server defini tion.

Enter no i f you don't want to backup your Col laboration Serverdatabase.

11. Enter yes to backup your History List. You wi l l be asked whereyour history l ist is stored.

l Enter 1 for Metadata

l Enter 2 for External warehouse

l Enter 3 for File .

Enter no i f you don't want to backup your History List.

12. Enter yes to backup addi tional warehouses.

Enter no i f you don't want back up any addi tional warehouses.

13. Enter yes to backup any of your cubes and enter the ful l path toyour cubes.

Enter no i f you don't want to backup your cubes.

14. Enter yes to backup any of your caches and enter the ful l path toyour caches.

Enter no i f you don't want to backup your caches.

15. Enter yes to backup the WSRM and enter the ful l path to theWSRM.

Enter no i f you don't want to backup the WSRM.

16. Enter yes to backup your MicroStrategy Web, Library, and Mobi leimages. The fol lowing questions appear:

Up grad e Gu id e


l Enter the path to MicroStrategy Web.

l Enter the path to MicroStrategy Library.

l Enter the path to MicroStrategy Mobi le.

Enter no i f you don't want to backup your images.

17. Enter yes to backup your MicroStrategy Web, Library, and Mobi leplugins. The fol lowing questions appear:

l Enter the path to MicroStrategy Web.

l Enter the path to MicroStrategy Library.

l Enter the path to MicroStrategy Mobi le.

Enter no i f you don't want to backup your plugins.

18. Enter yes to backup your MicroStrategy Web, Library, and Mobi leconfigurations.

Enter no i f you don't want to backup your configurations.

19. Enter yes to backup addi tional flat fi les and enter the fi le path(s)separated by commas. Addi tional fi les are backed up, but notrestored. During restore, addi tional fi les are stored in theopt/mstr/mstrbak/additional_files directory.

Enter no i f you don't want to backup addi tional flat fi les.

20. Enter yes to upload your backed up fi les to cloud storage. Youwi l l be asked which cloud storage option to upload to.

l Enter 1 to upload to your AWS S3 Bucket and enter the S3bucket name. If prompted, provide the S3 access keys andsecret key.

Up grad e Gu id e


l Enter 2 to upload to your Azure Blob Storage and enter yourStroage Account Name and Container Name. If prompted,provide the Storage Account access key.

Enter no i f you don't want to upload them to your cloud storageand enter the fi le path to save your response fi le and the fi le pathto save your backup fi les.

3. The cl ient runs and prints messages to the Terminal as i t proceeds.

4. The execution is complete when the fol lowing message appears:

MSTRBak has finished successfully.

Archive created locally at:path/to/backup/ARCHIVE.tar.gz

Archive uploaded to S3 at:https://link/to/ARCHIVE.tar.gz

Your MicroStrategy Backup is located in the directory l isted in the messageand in speci fied S3 bucket or Azure Blob, i f selected. A si lent responseJSON fi le is created at the conclusion of the execution, even i f the backupwas not successful . You may use this response fi le to run al l subsequentexecutions in Si lent mode.

Addit ional Flags

Append any of the fol lowing flags to the execution command as desired.

l To show verbose logging, enter the parameter -v .

l To dump the database, enter the parameter -d . It is not recommended touse this parameter i f you plan to use MicroStrategy Backup to upgrade.The -d parameter should be used when backing up MicroStrategy 2019and restoring on MicroStrategy 2019.

l To receive emai l noti fications about the backup process, enter theparameter -m <your email> .

For example,

Up grad e Gu id e


./mstrbak -p -v -d -m [email protected] [email protected]

How to Obtain MicroStrategy Backup Inputs

The fol lowing l ist detai ls where you can locate answers to promptedquestions.

Input Location

BakFileLocationThis is any location on the Linux machine where the file iswritten.

MSTRInstallPath

By default, on cloud environments it is/opt/mstr/MicroStrategy/ .

I f this is not the correct path, you can find the path byrunning locate MSIReg.reg as this file will only existin the MicroStrategy install path.

ServerDefOpen the MSIReg.reg f ile in your text editor and searchfor ServerInstanceName .

CubePath

Open Project Configuration for one of your projects andchoose Intelligent Cubes > General. The path appearsin the top window beginning with MSTRInstallPath .

For example,./Cube/env-31097laiouse1 =

/opt/mstr/MicroStrategy/Cube/env-laiouse1

CachePath

Open Project Configuration for one of your projects andchoose Caching > Result Caches > Storage. The pathappears in the top window beginning withMSTRInstallPath .

For example, ./Caches/env-31097laiouse1 =

/opt/mstr/MicroStrategy/Caches/env-

laiouse1

Up grad e Gu id e


Input Location

MobileConfigPath

Most often it will be in /tomcat/

{version}/webapps/MicroStrategyMobile/WE

B-INF/xml/mobile .

WebConfigPath


{version}/webapps/MicroStrategy/WEB-

INF/xml/sys_defaults.properties .

LibraryImagesPath


{version}/webapps/MicroStrategyLibrary/im

ages .

MobileImagesPath


{version}/webapps/MicroStrategyMobile/ima

ges .

WebImagesPathMost often it will be in /tomcat/

{version}/webapps/MicroStrategy/images .

LibraryPluginsPath


{version}/webapps/MicroStrategyLibrary/pl

ugins .

MobilePluginsPath


{version}/webapps/MicroStrategyMobile/plu

gins .

WebPluginsPathMost often it will be in /tomcat/

{version}/webapps/MicroStrategy/plugins .

MySQLbin Run the command which mysqldump as root.

MongoDBbin Run the command which mongodump as root.

MetadataDSN

Open the MSIReg.reg f ile and search Location . Usethe location in [HKEY_LOCAL_

MACHINE\SOFTWARE\MicroStrategy\Data

Sources\CastorServer] .

Up grad e Gu id e


Input Location

HistoryListDSN

Open the Intelligence Server Configuration in Developer.Take note of the Database Instance name. Close theIntelligence Server Configuration and chooseAdministration > Configuration Managers >Database Instances. Right-click and edit the databaseinstance you found in the Intelligence ServerConfiguration. Click Modify. The HistoryListDSN isthe name of the ODBC data source in the DatabaseConnections window.

StatisticsDSN

Open Project Configuration for one of your projects thatis logging statistics. Choose Database Instances >Statistics. Take note of the database instance name.

MySQLUserThis is the username of an administrator user in thedatabase.

MySQLPwdThis is the password of an administrator user in thedatabase.

MSTRUserThe username of a metadata user with full administrativepr ivileges (Administrator is recommended).

MSTRPwdThe password of a metadata user with full administrativepr ivileges (Administrator is recommended).

AdditionalDSNs

List the names of any addit ional DSNs that will be neededin the new environment. These names can be found in theodbc.ini f ile located in the MSTRInstallPath .

ProjectsToRegiste

r

For all projects, enter * . For multiple projects, addbrackets with each project name in quotations separatedby commas.

For example, [“MicroStrategy Tutorial”,

“Enterprise Manager”]

ProjectsToUnregister For all projects, enter * . For multiple projects, add

Up grad e Gu id e


Input Location

brackets with each project name in quotations separatedby commas.

For example, [“MicroStrategy Tutorial”,

“Enterprise Manager”]

MainProject

A Main Project is the project that will be defaulted to whenclicking Create Dossier on the new cloud landing page.

This can be any of the projects in theProjectsToRegister section.

ProjectSourceName

Open License Manager on the Intelligence Servermachine and open Audit . Note the project source thatconnects the Intelligence Server. If there is not a projectsource, create one using the Configuration Wizard.

ClusteredCubesEnter true or false . Only enter true if the oldenvironment is a clustered environment.

CubeHostnames

I f ClusteredCubes is true, then this section will be alist of the Intelligence Servers in brackets with eachserver name in quotations separated by commas.

For example, [“env-1000”, “env-2000”]

UploadToCloudStor

age

Enter Yes or No . Enter Yes to upload the MicroStrategyBackup file to AWS S3 or Azure Blob.

S3BucketName This is the name of the S3 bucket (without S3://) .

S3AccessKey The S3 access key used to access the S3 bucket.

S3SecretKey The S3 secret key used to access the S3 bucket.

AccountName This is the name of the Storage Account in Azure.

AccountKeyThe Access Key used to access the Storage Account inAzure.

Up grad e Gu id e


How to Run in Cloud Mode

Cloud mode is an express backup mode speci fical ly for users wi thMicroStrategy cloud environments. This mode is ideal for users who want toquickly back up their enti re environment. Cloud mode can handle al lenterprise appl ications.

1. Enter the fol lowing command to run cloud mode. See Addi tional Flagsfor addi tional parameters to add to your execution command.

./mstrbak -c

2. Enter your credentials from your cloud environment's welcome emai l .

Your backup fi le is located in /opt/mstr/mstrbak/ and yourresponse fi le is located in/opt/mstr/mstrbak/mstrbakResponseFile.json .

3. Enter your credentials to the database.

4. Enter the SQL dump bin path.

5. Enter y to upload to a cloud storage. When prompted, choose whichcloud storage option to upload to. Enter n i f you don't want to upload toa cloud storage and complete the backup.

l Enter 1 to upload to your AWS S3 Bucket and enter the S3 bucketname. If prompted, provide the S3 access keys and secret key.

l Enter 2 to upload to your Azure Blob Storage and enter your StorageAccount Name and Container Name. If prompted, provide theStorage Account access key.



MSTRBak complete. Operation successful? True


Up grad e Gu id e



The cl ient in cloud mode wi l l attempt to backup al l DSNs in theodbc.ini . If some data warehouses fai l to backup, an error messageappears and operation success? reads as false . However, i f theDSNs are successful ly backed up, you can use the backup package.

If you have uploaded MicroStrategy Backup to S3 or Azure Blob, you cannow restore your archive onto a new MicroStrategy Cloud Platform for AWSor MicroStrategy Cloud Platform for Azure environment. You can restoreyour MicroStrategy Backup archives on the same MicroStrategy version asyour archive or a newer version to automatical ly update your MicroStrategyassets. MicroStrategy Cloud Platform for AWS or MicroStrategy CloudPlatform for Azure offers upgrading MicroStrategy 10.4.5 to the latestMicroStrategy Platform release.

Addit ional Flags



l To dump the database, enter the parameter -d . It is not recommended touse this parameter i f you plan to use MicroStrategy Backup to upgrade.


For example,

./mstrbak -c -v -d -m [email protected] [email protected]

Up grad e Gu id e


How to Run in Silent Mode

Si lent mode al lows you to speci fy a JSON fi le wi th prepared responses forinformation pertaining to the MicroStrategy environment. Before running,you need to create a si lent response fi le.

1. Create a response fi le based on the fol lowing template. See ResponseFi le Schema Template for schema reference.

{

"mstrbak": {

"mstrbak_version": 1.0,

"backup_path": "/opt/mstr/mstrbak",

"response_file_path": "/opt/mstr/mstrbak/response.json"

},

"mstr": {

"mstr_version": "11.1.000.123",

"install_path": "/opt/mstr/MicroStrategy",

"driver_paths": {

"mysql": "/usr/share/java/mysql-connector-java-8.0.12.jar"

},

"hostnames": ["env-12345laiouse1"],

"username": "mstr",

"password": "",

"history_list_storage": "external",

"project_source_name": "mstr_metadata",

"server_definition": "cloud_10s",

"cube_path":

"/opt/mstr/MicroStrategy/IntelligenceServer/Cube/cloud_10s",

"cache_path":

"/opt/mstr/MicroStrategy/IntelligenceServer/Caches/cloud_10s",

"inbox_path":

"/opt/mstr/MicroStrategy/IntelligenceServer/Inbox/cloud_10s",

"wsrm_path": "",

"projects": {

"main_project": "MicroStrategy Tutorial",

"projects_to_register": [

"MicroStrategy Tutorial"

Up grad e Gu id e


],

"projects_to_unregister": [

],

"projects_locked": [

]

},

"configuration_locked": false,

"scheduler_on": true

},

"collaboration_server": {

"backup": false,

"db_type": "",

"username": "",

"password": "",

"bin_path": ""

},

"dsns": {

"metadata": {

"prefix": "",

"dsn_name": "METADATA",

"db_type": "MySQL",

"username": "mstr",

"password": "",

"bin_path": "/usr/bin"

},

"platform_analytics": {

"backup": false,

"dsn_name": "",

"db_type": "",

"username": "",

"password": "",

"bin_path": ""

},

"history_list": {

"backup": true,

Up grad e Gu id e


"dsn_name": "HISTORYLIST",

"db_type": "MySQL",

"username": "mstr",

"password": "",

"bin_path": "/usr/bin"

},

"additional_dsns": [

]

},

"library": {

"path":

"/opt/apache/tomcat/latest/webapps/MicroStrategyLibrary",

"backup_contents": {

"backup_images": true,

"backup_plugins": true,

"backup_configuration_files": {

"mapConfig.xml": true,

"configOverride.properties": true

}

}

},

"web": {

"path": "/opt/apache/tomcat/latest/webapps/MicroStrategy",





"sys_defaults.properties": true,

"mapConfig.xml": true

}

}

},

"mobile": {

"path": "/opt/apache/tomcat/latest/webapps/MicroStrategyMobile",




Up grad e Gu id e



"WEB-INF/xml/mobile": true,

"mapConfig.xml": true

}

}

},

"aws": {

"upload": false,

"s3_bucket_name": "mstrbak",

"s3_access_key": "",

"s3_secret_key": ""

},

"azure": {

"upload": false,

"account_name": "",

"account_key": "",

"container_name": "mstrbak"

},

"additional_files": []

}

2. For the history_list_storage parameter, enter metadata ,external , or file .

3. For the db_type parameter, enter MySQL , PostgreSQL , or MongoDB .

4. Save the JSON fi le, ensure the fi le extension is .json.

5. (Optional) Create a backup of the newly created JSON fi le.

This is recommended because, after the Si lent Mode execution, thepasswords in the response fi le are hidden for securi ty reasons. Toavoid losing any passwords, keep a back up of the JSON fi le.

6. Enter the fol lowing command to run si lent mode. See Addi tional Flagsfor addi tional parameters to add to your execution command.

./mstrbak -r /path/to/response.json

Up grad e Gu id e




MSTRBak complete. Operation successful? True



Your MicroStrategy Backup archive is located in the directory l isted inthe message and in the speci fied S3 bucket or Azure Blob, i f selected.

If you have uploaded MicroStrategy Backup to S3 or Azure Blob, you cannow restore your archive onto a new MicroStrategy Cloud Platform for AWSor MicroStrategy Cloud Platform for Azure environment. You can restoreyour MicroStrategy Backup archives on the same MicroStrategy version asyour archive or a newer version to automatical ly update your MicroStrategyassets. MicroStrategy Cloud Platform for AWS or MicroStrategy CloudPlatform for Azure offers upgrading MicroStrategy 10.4.5 to the latestMicroStrategy Platform release.

Addit ional Flags



l To dump the database, enter the parameter -d . It is not recommended touse this parameter i f you plan to use MicroStrategy Backup to upgrade.


For example,

./mstrbak -r /path/to/response.json -v -d [email protected] -m [email protected]

Up grad e Gu id e


Response File Schema Template

The fol lowing is a template for response fi le schema. This template is to beused in tandem with the JSON fi le template on How to Run in Si lent Mode

{

"$schema": "http://json-schema.org/draft-07/schema#",

"type": "object",

"properties": {

"mstrbak": {

"type": "object",

"properties": {

"mstrbak_version": {

"type": "number"

},

"backup_path": {

"type": "string"

},

"response_file_path": {

"type": "string"

}

},

"required": [

"mstrbak_version",

"backup_path",

"response_file_path"

]

},

"mstr": {

"type": "object",

"properties": {

"mstr_version": {

"type": "string"

},

"install_path": {

"type": "string"

},

"driver_paths": {

"type": "object",

"properties": {

Up grad e Gu id e


"mysql": {

"type": "string"

}

},

"required": [

"mysql"

]

},

"hostnames": {

"type": "array",

"items": [

{

"type": "string"

}

]

},

"username": {

"type": "string"

},

"password": {

"type": "string"

},

"project_source_name": {

"type": "string"

},

"server_definition": {

"type": "string"

},

"cube_path": {

"type": "string"

},

"cache_path": {

"type": "string"

},

"history_list_storage": {

"type": "string"

},

"inbox_path": {

"type": "string"

Up grad e Gu id e


},

"projects": {

"type": "object",

"properties": {

"main_project": {

"type": "string"

},

"projects_to_register": {

"type": "array",

"items": [

{

"type": "string"

}

]

},

"projects_to_unregister": {

"type": "array",

"items": {}

},

"projects_locked": {

"type": "array",

"items": {}

}

},

"required": [

"main_project",

"projects_to_register",

"projects_to_unregister",

"projects_locked"

]

},

"configuration_locked": {

"type": "boolean"

},

"scheduler_on": {

"type": "boolean"

}

},

"required": [

Up grad e Gu id e


"mstr_version",

"install_path",

"driver_paths",

"hostnames",

"username",

"password",

"history_list_storage",

"project_source_name",

"server_definition",

"cube_path",

"cache_path",

"inbox_path",

"hybrid_path",

"wsrm_path",

"projects",

"configuration_locked",

"scheduler_on"

]

},

"collaboration_server": {

"type": "object",

"properties": {

"backup": {

"type": "boolean"

},

"db_type": {

"type": "string"

},

"username": {

"type": "string"

},

"password": {

"type": "string"

},

"bin_path": {

"type": "string"

}

},

"required": [

Up grad e Gu id e


"backup",

"db_type",

"username",

"password",

"bin_path"

]

},

"dsns": {

"type": "object",

"properties": {

"metadata": {

"type": "object",

"properties": {

"prefix": {

"type": "string"

},

"dsn_name": {

"type": "string"

},

"db_type": {

"type": "string"

},

"username": {

"type": "string"

},

"password": {

"type": "string"

},

"bin_path": {

"type": "string"

}

},

"required": [

"prefix",

"dsn_name",

"db_type",

"username",

"password",

"bin_path"

Up grad e Gu id e


]

},

"platform_analytics": {

"type": "object",

"properties": {

"backup": {

"type": "boolean"

},

"dsn_name": {

"type": "string"

},

"db_type": {

"type": "string"

},

"username": {

"type": "string"

},

"password": {

"type": "string"

},

"bin_path": {

"type": "string"

}

},

"required": [

"backup",

"dsn_name",

"db_type",

"username",

"password",

"bin_path"

]

},

"history_list": {

"type": "object",

"properties": {

"backup": {

"type": "boolean"

},

Up grad e Gu id e


"dsn_name": {

"type": "string"

},

"db_type": {

"type": "string"

},

"username": {

"type": "string"

},

"password": {

"type": "string"

},

"bin_path": {

"type": "string"

}

},

"required": [

"backup",

"dsn_name",

"db_type",

"username",

"password",

"bin_path"

]

},

"additional_dsns": {

"type": "array",

"items": [

{

"type": "object",

"properties": {

"backup": {

"type": "boolean"

},

"dsn_name": {

"type": "string"

},

"username": {

"type": "string"

Up grad e Gu id e


},

"password": {

"type": "string"

},

"bin_path": {

"type": "string"

}

},

"required": [

"backup",

"dsn_name",

"username",

"password",

"bin_path"

]

}

]

}

},

"required": [

"metadata",

"platform_analytics",

"history_list",

"additional_dsns"

]

},

"library": {

"type": "object",

"properties": {

"path": {

"type": "string"

},


"type": "object",

"properties": {

"backup_images": {

"type": "boolean"

},

"backup_plugins": {

Up grad e Gu id e


"type": "boolean"

},


"type": "object",

"properties": {

"mapConfig.xml": {

"type": "boolean"

},

"configOverride.properties": {

"type": "boolean"

}

},

"required": [

"mapConfig.xml",

"configOverride.properties"

]

}

},

"required": [

"backup_images",

"backup_plugins",

"backup_configuration_files"

]

}

},

"required": [

"path",

"backup_contents"

]

},

"web": {

"type": "object",

"properties": {

"path": {

"type": "string"

},


"type": "object",

"properties": {

Up grad e Gu id e


"backup_images": {

"type": "boolean"

},

"backup_plugins": {

"type": "boolean"

},


"type": "object",

"properties": {

"sys_defaults.properties": {

"type": "boolean"

},

"mapConfig.xml": {

"type": "boolean"

}

},

"required": [

"sys_defaults.properties",

"mapConfig.xml"

]

}

},

"required": [

"backup_images",

"backup_plugins",


]

}

},

"required": [

"path",

"backup_contents"

]

},

"mobile": {

"type": "object",

"properties": {

"path": {

"type": "string"

Up grad e Gu id e


},


"type": "object",

"properties": {

"backup_images": {

"type": "boolean"

},

"backup_plugins": {

"type": "boolean"

},


"type": "object",

"properties": {

"WEB-INF/xml/mobile": {

"type": "boolean"

},

"mapConfig.xml": {

"type": "boolean"

}

},

"required": [

"WEB-INF/xml/mobile",

"mapConfig.xml"

]

}

},

"required": [

"backup_images",

"backup_plugins",


]

}

},

"required": [

"path",

"backup_contents"

]

},

"aws": {

Up grad e Gu id e


"type": "object",

"properties": {

"upload": {

"type": "boolean"

},

"s3_bucket_name": {

"type": "string"

},

"s3_access_key": {

"type": "string"

},

"s3_secret_key": {

"type": "string"

}

},

"required": [

"upload",

"s3_bucket_name",

"s3_access_key",

"s3_secret_key"

]

},

"azure": {

"type": "object",

"properties": {

"upload": {

"type": "boolean"

},

"account_name": {

"type": "string"

},

"account_key": {

"type": "string"

},

"container_name": {

"type": "string"

}

},

"required": [

Up grad e Gu id e


"upload",

"account_name",

"account_key",

"container_name"

]

},

"additional_files": {

"type": "array",

"items": {}

}

},

"required": [

"mstrbak",

"mstr",

"collaboration_server",

"dsns",

"library",

"web",

"mobile",

"aws",

"azure",

"additional_files"

]

}

4. Restore MicroStrategy BackupMicroStrategy Backup is a MicroStrategy appl ication that al lows users toeasi ly back up essential MicroStrategy configurations, databases, and fi les.The backed-up package created by the cl ient can ei ther be stored local ly orthey can be via the MicroStrategy Cloud Platform for AWS or MicroStrategyCloud Platform for Azure with the MicroStrategy Backup restorationcapabi l i ty. Restoring your MicroStrategy Backup al lows you to restorecubes, caches, ODBC DSNs, update projects, and more.

To restore MicroStrategy Backup in AWS, you must have uploaded your backupto an S3 bucket (directly inside the bucket and not inside any folder) in 3. RunMicroStrategy Backup .

Up grad e Gu id e


To restore MicroStrategy Backup in Azure, you must have uploaded your backupto an Azure Storage account which can be accessed by the new environment in 3.Run MicroStrategy Backup .

1. Log in to the MicroStrategy Cloud Platform.

2. Provision a new environment as ei ther Team, Department, orEnterprise.

3. Under Restore an Environment, select the Restore environment fromMicroStrategy Backup check box.

4. Enter the S3 bucket or Azure Blob URL.

The Backup file can only be restored to environments with the same orhigher version numbers.

5. Cl ick Validate.

6. Cl ick Create Environment. Your MicroStrategy Backup is restored onyour new environment.

Up grad e Gu id e

https://provision.customer.cloud.microstrategy.com/


Validat ing t he Upgr adeIt is essential that you ful ly test your new MicroStrategy system to see howit wi thstands the kind of typical day-to-day system usage your usercommunity requires. If you have upgraded fi rst in a test environment, youcan run these tests in the test environment and correct any problems youmay find there. Then when you upgrade your production environment, youalready have an idea of the kinds of di fficul ties you may encounter. Forinformation about setting up an upgrade test environment, see Configuringan Upgrade Test Environment, page 68.

During the test, make sure you are satisfied with the status and efficiency ofyour MicroStrategy system. If you need help, see the Readme or contactMicroStrategy Technical Support.

URL Scanner - Identify URLs for Export

As of MicroStrategy 2020 Update 1, administrators can speci fy which URLsor URL paths are permitted when fetching content to be included in anexport. This concept, where only certain URLs are permitted, is largelyreferred to as whi tel isting. To easi ly identi fy which URLs belong in this l istafter upgrading, i t's recommended to use the URL Scanner.

The URL Scanner tool al lows you to scan MicroStrategy metadatas (10.4.xand higher) for URLs accessed by the exporting workflows on theIntel l igence Server. It l ists al l the URLs referenced by reports, documents,and dossiers and al lows you to make an informed decision about whichURLs are safe to be used in your environment. Combined with the newwhitel isting functional i ty in MicroStrategy 2020 Update 1, this tool can beused to whi tel ist only those safe URLs to protect against Server SideRequest Forgery attacks.

The recommended workflow for using the URL Scanner is as fol lows:

Up grad e Gu id e



1. Review the prerequisi tes and system requirements.

2. Run the URL Scanner.

3. Review the scan resul ts.

4. Add URLs and URL paths from the scan resul ts to the whi tel ist.

Get StartedFirst, download the zip fi le from the MicroStrategy Download si te and unzipi t to a folder. We wi l l refer to this as “URL Scanner Folder” going forward.

URL Scanner System Requirements

The URL Scanner supports al l Microsoft Windows Systems (exceptMicrosoft Vista) supported by MicroStrategy Developer.

The fol lowing systems are certi fied for use with this tool :

l Windows Server 2016 Enterprise

l Windows Server 2019 Enterprise

l Windows 10

MicroStrategy Prerequisites

l You must have the Bypass all object security access checks privi legeto use the tool .

l You must connect through a 2-tier (di rect) or 3-tier project source withStandard authentication mode.

l Your machine must have MicroStrategy Developer instal led.

Compatibility

The URL Scanner is compatible wi th metadata versions 10.4.x and above.

Up grad e Gu id e

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


Run the URL Scanner

You must perform the prerequis ites on Get Started before proceeding.

1. Double-cl ick the URLScanner.exe fi le.

2. Use the drop-down to choose an avai lable project source. It'srecommended to use a 2-tier project source.

3. Enter the username and password for the selected project source.

4. Cl ick Connect.

5. In the project box, select the project(s) that you want to scan. It'srecommended to choose the Select all projects checkbox.

6. Cl ick Scan . After the URL scan has completed, a dialog appears wi ththe directory of the output fi les. The output fi les are located in theURL Scanner Folder.

7. Cl ick Exit. You can exi t the scan at any point. Since the scan resul tsare incremental ly generated, you can sti l l check the scan resul t i f thescan is canceled.

Review Scan ResultsThe scan resul ts are generated in the same folder as the URL Scannerexecutable.

The fi le name fol lows the pattern URLs_YYMMDD_TIMESTAMP.csv andcontains the fol lowing information:

l Object name

l Object path

l Object owner

l URL type

Up grad e Gu id e


l URL text location

l URL text

For example, a scan resul t could appear as:

"2.0 Book of Business" ,"MERIT System\Public Objects\Reports\W. Work In

Progress\Old Reports\2.0 Book of

Business","Administrator","FieldImage","Content > Layout: Opportunity

Overview","http://www.microstrategy.com/cmstemplates/microstrategy/images/mic

rostrategy_logo.png"

Once you have the generated .csv fi le, add the URLs and URL paths to theAl low URLs to Export l ist.

Add URLs to WhitelistNow that you have a l ist of URLs, you can add them to the Al low URLs toExport l ist.

Adding URLs or URL paths to this l ist permits the content to be fetchedwhen exporting a report, document, or dossier to PDF or Excel .

To modi fy this field, you must have the Web Administration privi lege,Configure Server Basic privi lege, and read/wri te access for the serverdefini tion.

If you are using MicroStrategy Web ASP, please see Addi tional Step forMicroStrategy Web ASP Customers in KB484127 before proceeding.

Relative paths are case sensitive.

1. Log in to a project using an account wi th administrative privi leges.

2. From the upper right of any page, cl ick the username drop-down andselect Preferences. The Preferences page opens.

3. From the pane on the left, select Project Defaults.

4. From the pane on the left, select Security. The Securi ty project

Up grad e Gu id e

https://community.microstrategy.com/s/article/Securing-PDF-and-Excel-Export-with-Whitelists?language=en_US#limitations

https://community.microstrategy.com/s/article/Securing-PDF-and-Excel-Export-with-Whitelists?language=en_US#limitations


defaul ts page opens.

5. From Allow URLs to Export, enter a URL or URL path.

Use a relative path or the fol lowing protocols: https:// , http:// ,or file:/// .

6. Cl ick Add .

7. Cl ick Apply. This setting appl ies to al l projects in your environmentand affects al l MicroStrategy products that have export functional i ty.

8. Clear your Export cache.

1. In Developer, log in to a project source. You must have theMoni tor Caches privi lege.

2. Expand Administration > SystemMonitors > Caches >Documents.

3. Select a project and cl ick OK .

4. Locate caches with the format PDF or Excel and delete them.

Once you have whi tel isted the URLs found in your metadata, i t isrecommended to perform Integri ty Manager testing to val idate the upgradeimpact.

Thereafter, administrators should review any URLs or URL paths that aresti l l blocked from export.

Related Articles

KB484127: Securing PDF and Excel Export wi th Whitel ists

Integrity Manager - Upgrade Impact Testing

After upgrading your production environment, you should ensure that thechanges involved do not al ter any of your report, document, or dossier

Up grad e Gu id e

https://www2.microstrategy.com/producthelp/Current/WebAdmin/WebHelp/Lang_1033/Content/specify_url_and_url_paths_to_export.htm

https://www2.microstrategy.com/producthelp/Current/WebAdmin/WebHelp/Lang_1033/Content/specify_url_and_url_paths_to_export.htm

https://community.microstrategy.com/s/article/Securing-PDF-and-Excel-Export-with-Whitelists


resul ts. If changes have occurred, you can understand why usingMicroStrategy Integri ty Manager.

MicroStrategy Integri ty Manager is designed to execute and comparereports, documents, and dossiers from different versions by examining theirdata and SQL. Starting in 11.0, administrators can compare data down tothe visual ization level of al l content objects. Changes found duringcomparison testing are logged automatical ly and can be viewed using theUpgrade Analysis Dossier. See Upgrade Analysis Dossier for moreinformation.

For detai led information about Integri ty Manager, including instructions, seethe Integri ty Manager chapter in the System Administration Guide.

Best Practices for Integrity TestingMicroStrategy recommends the fol lowing best practices when testing yourupgrade with Integri ty Manager:

l Create al l basel ines using Integri ty Manager 2020.

For example, i f you are going to upgrade from 10.4.x to 2020 and you wi l lnot have a l ive 10.4.x and 2020 both avai lable at the same time to do aProject vs Project comparison, then upgrade a developer machine to 2020with Integri ty Manager to capture the basel ine for 10.4.x before upgradingi t to 2020. Basel ines that are created with older versions of Integri tyManager are not compatible and administrators can expect “does notcontain tags” or “does not contain relations” errors. This is due tointentional archi tecture changes to support new functional i ty.

l Create an integri ty test comparing reports, documents, and dossiers fromthe upgraded test environment wi th the same objects in the currentproduction environment, so that you can easi ly see where any di fferencesare.

l In a comparative integri ty test, you must have the same OS version andthe same font instal led on your machine to use the Graph view to compare

Up grad e Gu id e



two PDF reports. Font rendering on a PDF is version and OS speci fic, sodi fferences may resul t in formatting issues, which can affect comparisonresul ts.

l Execute the tests against the production data warehouse. If this is notpossible, test against a data warehouse that resembles the productiondata warehouse as closely as possible. Ensure that the tests for both theupgrade environment and the current production environment areexecuted against the same warehouse or unmatched resul ts are returned,which is expected.

l Execute the tests wi th production users, groups, and securi ty roles,instead of special ly-created integri ty test users and groups, so that thetests match the production environment as closely as possible.

l If possible, select content objects wi th at least defaul t prompt answers totest. Otherwise create static copies of content objects that have promptswi th no defaul t prompt answers.

l When executing a performance test, ensure no other usage or testing isbeing performed on the environments as i t can resul t in misleadingresul ts.

Creating a Project BaselineWhen you upgrade to MicroStrategy 2020, you must ensure that reports,report services documents, and dossiers return the same resul ts in both thecurrent environment and the upgraded environment. For customersperforming a paral lel upgrade, the easiest way to do this is to use the“Project versus Project” test which wi l l execute selected content objectsagainst two environments, one your existing production, and the other yourtest upgrade environment. Customers performing an in-place upgrade wi l lneed to create a project basel ine of your current production environment,and then after the upgrade is done, use that basel ine to run the “Basel ineversus Project” option. The steps below provide an example.

Up grad e Gu id e


Create a project baseline

1. In your current MicroStrategy environment, access the Windowsdesktop with MicroStrategy cl ients instal led.

2. Open Start Menu > MicroStrategy Products > Integrity Manager.

3. From the File menu, select Create Test.

4. Select Single Project and cl ick Next.

5. On the Enter Base Project Information page, enter the fol lowingdetai ls about your current environment:

l In the Server Name field, enter the name or IP address of yourIntel l igence Server.

l In the Server Port field, enter the port number your Intel l igenceServer uses. The defaul t port number is 34952.

l From the Authentication Mode field, select the authentication modeyour Intel l igence Server uses.

Up grad e Gu id e


l In the Login ID and Password fields, enter the credentials to log inMicroStrategy Intel l igence Server.

l From the Project drop-down l ist, select the project to test.

6. Cl ick Next.

7. On the Select Objects from the Base Project to be included in Testpage, select objects you want to test.

8. Cl ick Next.

9. On the Select Prompt Settings screen, cl ick Next.

10. On the Select Execution Settings screen, cl ick Next.

11. On the Select Processing Options screen, check the fol lowingoptions for each type of objects:

Reports:

l SQL/MDX

l Data

l Graph

l PDF

Documents:

l Execution

l Data

l PDF

Dossiers:

l Execution

l Data

Up grad e Gu id e


l PDF

12. Cl ick Next.

13. In the Summary screen, cl ick Run .

Up grad e Gu id e


14. In the Save window, cl ick Yes.

15. Save the test and make note of the location. You wi l l need the resul tsto run the test on your new environment.

16. When the test executions are complete, exi t Integri ty Manager.

Compare Project Baseline versus Upgraded ProductionAfter the upgrade is completed, your project basel ine resul ts to run acomparison with your new MicroStrategy 2020 environment.

1. Open Start Menu > MicroStrategy Products > Integrity Manager.

2. From the File menu, select Create Test.

3. Select Baseline versus Project and cl ick Next.

Up grad e Gu id e


4. On the Select Base screen, in the Select Baseline XML file field,select the basel ine fi le you created in the previous Integri ty Managertest.

5. Cl ick Next.

6. On the Enter Target project Information page, enter the fol lowingdetai ls about your MicroStrategy 2020 environment:

l In the Server Name field, enter the name of your 2020 Intel l igenceServer.

l In the Server Port field, enter the port number your Intel l igenceServer uses. The defaul t port number is 34952.

l From the Authentication Mode field, select the authentication modeyour Intel l igence Server uses.

l In the Login ID and Password fields, enter the credentials to log inMicroStrategy Intel l igence Server.

Up grad e Gu id e


l From the Project drop-down l ist, select the project you used in thefi rst test.

7. On the Select Contents to Test page, select the objects you used inthe fi rst test.

8. Cl ick Next.

9. On the Select Prompt Settings screen, keep al l of selected options,cl ick Next.

10. On the Select Execution Settings screen, keep al l of selected options,cl ick Next.

11. On the Select Processing Options screen, keep al l of selectedoptions, cl ick Next.

12. In the Summary screen, cl ick Run .

13. In the Save window, cl ick Yes and save the test.

14. When the test executions are complete, exi t Integri ty Manager andproceed to understanding your resul ts using the Upgrade AnalysisDossier.

MicroStrategy Capacity Testing Tool

Capabilities and RestrictionsThe MicroStrategy Capaci ty Testing Tool is a cl ient appl ication whichconnects to deployments of the MicroStrategy platform (speci fical ly,MicroStrategy Web and MicroStrategy Library i f avai lable) and runs a user-defined set of end-to-end performance tests on content objects includingRSDs (Report Services Documents), reports, Visual Insight dashboards,and Dossiers. The purpose of this tool is to establ ish a basel ine for theperformance of a MicroStrategy appl ication or determine how a particularMicroStrategy appl ication’s performance has been affected by an upgradeto a new version by comparing two environments.

Up grad e Gu id e


Capabilities

l Test the response time of one or many content objects

l Test the response time on one more multiple MicroStrategy environments

l Perform tests by running them once, or many times with savedconfigurations

l Runs against MicroStrategy 10.4.x and above

Restrictions

l Only non-prompted content objects are supported.

l Connecting to versions of MicroStrategy without MicroStrategy Librarywi l l require the user to provide a l ist of which objects to test.

Refer to the section Configuration Fi les: Profi les.csv for more information.

l Connecting to MicroStrategy Web 10.4 Hotfix 5 and earl ier wi l l require theWait Page to be disabled.

Refer to the section Disabl ing the Wait Page in MicroStrategy Web formore information.

l The Capaci ty Testing Tool runs on Windows Server 2012 and WindowsServer 2016.

l The Capaci ty Testing Tool only runs in command-l ine mode

l The Capaci ty Testing Tool only al lows for MicroStrategy users wi thStandard or LDAP authentication

l The Capaci ty Testing Tool requires that the user know some configurationproperties of their MicroStrategy deployment (see GatheringMicroStrategy Configurations for more information).

Up grad e Gu id e


Getting StartedFirst, download the zip fi le from the MicroStrategy Download si te and unzipi t to a folder. We wi l l refer to this as “Capaci ty Testing Tool Folder” goingforward.

Capacity Testing Tool System Requirements

l Windows Server 2012 or 2016

l 1 GB minimum hard drive storage space

l 8 GB RAM

l Network connectivi ty to al l MicroStrategy Web and MicroStrategy Library(i f appl icable) instances that wi l l be used

MicroStrategy Requirements

l MicroStrategy Web connected to your Intel l igence Server

l MicroStrategy Library 10.9 and above (to use the search functional i ty)

l A MicroStrategy user that has execute permission for al l content objectsto be tested

l Non-prompted content objects

l The Web statistics panel must be open on your screen. To enable theWeb statistics panel , see Before Running the Test.

Disabling the Wait Page in MicroStrategy Web

The wait page in MicroStrategy Web needs to be manual ly disabled whenconnecting to MicroStrategy 10.4 Hotfix 5 and earl ier. This is because theURL flag to disable the wai t page didn't exist unti l MicroStrategy 10.4 Hotfix6. Before using the Capaci ty Testing Tool , fol low the steps below to disablethe wai t page:

Up grad e Gu id e

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


Disabling the Wait Page on J2EE Environments

1. Log in to the web server and stop the service.

2. Go to the deployment folder (Ex. webapps in Tomcat) where theMicroStrategy.war fi le was deployed.

3. Navigate to /MicroStrategy/WEB-INF/xml and find the fi lepageConfig.xml .

4. Backup pageConfig.xml as pageConfig.xml.bak .

5. Open pageConfig.xml in a text edi tor and do a search for al lelements named maxWait and set the value to -1 for al l instances.

6. Save the fi le and exi t the edi tor.

7. Restart the web server service.

Disabling the Wait Page on .NET Environments

1. Log in to the web server and stop the Internet Information Services(IIS) Manager service.

2. Go the folder Web ASPx where web server is deployed. Defaul t pathshould be C:\Program Files (x86)\MicroStrategy\Web

ASPx) .

3. Navigate to Web ASPx\WEB-INF\xml and find the fi lepageConfig.xml .

4. Backup pageConfig.xml as pageConfig.xml.bak .

5. Open pageConfig.xml in a text edi tor and do a search for al l of theelements named maxWait and set the value to -1 for al l instances.

6. Save the fi le and exi t the edi tor.

7. Restart the IIS Manager service.

Up grad e Gu id e


Once testing has been done, be sure to stop your web environments, andrevert back the changes by using the .bak fi les or manual ly updating thepageConfig.xml fi le.

Gathering MicroStrategy Configurations

For the Capaci ty Testing Tool to connect successful ly you wi l l need toknow the configuration properties for the environments to be tested. Most ofthis information can be col lected by logging into MicroStrategy Web orMicroStrategy Library pages and observing the fol lowing i tems in the URLof a web browser.

In Chrome, click the URL bar to see the entire URL

l Web Protocol: Highl ighted as 1 in the picture below. It wi l l be ei therhttp or https .

l Web Server Address: Highl ighted as 2 in the picture below.

l Web Server Port: If the port is not defaul t, i t wi l l appear as a numberbetween 2 and 3.

l MicroStrategy Web Path : Highl ighted as 3 in the picture below.

l Intelligence Server IP or FQDN : Highl ighted as 4 in the picture below.

If not v is ible, you can log into Web Administrator and see which IntelligenceServer the Web Server is connected to.

l MicroStrategy Library Path : Appears between .com/ and /auth in thepicture below.

Up grad e Gu id e


l Intelligence Server Authentication Mode: If you are using corporatecredentials to log into MicroStrategy, i t is l ikely that LDAP is being used.If you are using a di fferent login, such as the defaul t one that comes withMicroStrategy Cloud Platform for AWS or MicroStrategy Cloud Platformfor Azure, the login mode is l ikely Standard.

l MicroStrategy Web Type (.NETor JSP): If the MicroStrategy deploymentis running on Linux, i t is l ikely JSP, i f Windows, i t is more l ikely to beASP. Ask your MicroStrategy administrator i f in doubt.

l MicroStrategy Username and Password : The account used must haveExecute permission in MicroStrategy Web for al l content objects beingtested.

l Intelligence Server Port: By defaul t, i t is 34952, but i f in doubt, ask yourMicroStrategy administrator or check the configuration in MicroStrategyWeb Administrator.

Testing an Environment for the First Time

Before Running the Test

1. Log in to your MicroStrategy Web Administrator page.

2. Open Diagnostics > Statistics and set the Mode drop-down toScreen .

3. Cl ick Save to open the Statistics panel :

Up grad e Gu id e


Leave this panel open for the remainder of the Capaci ty Testing Toolprocess.

Executing the Capacity Test

Once MicroStrategy configuration information has been gathered and theStatistics panel is open, navigate to the extracted Capaci ty Testing Toolfolder and double-cl ick on the Capacity Testing Tool.exe fi le toopen the program in a terminal window.

Clicking inside the terminal window while the capacity test is running willcause the test to pause.

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

# Welcome to the #

# MicroStrategy Performance & #

# Capacity Test Tool 2019 #

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

[1] Run test using response file

[2] Start a new test

If a previously saved response fi le has been created, a JSON fi le wi thinstructions for the Capaci ty Testing Tool to automatical ly run your test isused. This is useful i f you’re doing the test repeti tively or automating i t wi tha script. Refer to the section Configuration Fi les: Si lent Response Fi le.

Otherwise, proceed by selecting option 2.

Up grad e Gu id e


The screen wi l l refresh and begin to configure Environment #1. The fi rstquestion that wi l l be presented is what type of MicroStrategy Web isrunning. If your MicroStrategy deployment is running on Linux, i t is l ikelyJSP; i f Windows, i t is more l ikely to be ASP. Ask your MicroStrategyadministrator i f in doubt.

This tool can execute one or multiple capacity tests against your

Intelligence Environment(s)

It is suggested to start with the environment with the most recent

version

Follow the questions below to configure your test

ENVIRONMENT #1

Collecting information about your web server properties...

Select the MicroStrategy Web Server type:

[1] ASP (IIS-Windows)

[2] JSP (Universal)

2

The next question wi l l ask for the platform version for this environment.Only enter numeric values and periods. For example, for 10.4 Hotfix 8, enter10.4.8.

If you enter a version below 10.9, you will not be prompted for MicroStrategyLibrary, which will require you to manually specify which content objects torun.

Fol lowing the platform version, select the web protocol MicroStrategy Webis using, whether i t is http (unsecure) or https (secure). You can inferthis from the URL that is being used when accessing MicroStrategy Web viaa browser.

Enter the MicroStrategy Platform Version: 11.0

Select the web protocol:

[1] http

Up grad e Gu id e


[2] https

2

Enter the web port that is being used. Observe that the number [443] ispresent as the defaul t for https that was selected, meaning that i f youpress Enter, i t wi l l auto-populate wi th that value, which is the defaul t portnumber for https . If you select http , i t wi l l defaul t to port 80. Any valuesthat appear in the prompt that are in brackets are defaul t values, and toselect them, press Enter.

Enter the web port [443]:

Enter the web server address, which you can get from the URL.

Enter the web server address (ex. env-123.us-east-1.elb.amazonaws.com):

Enter the path to MicroStrategy Web, which you can get from the URL (seethe diagram in Testing an Environment for the First Time)

Enter the web path extension [/Microstrategy/servlet/mstrWeb]:

Enter the IP address or Ful ly Qual i fied Domain Name (FQDN) of theIntel l igence Server.

This value is from the perspective of MicroStrategy Web connecting to theIntel l igence Server, not from the perspective of a cl ient machine. Even i fthis IP address or FQDN isn’ t accessible from your machine, i t wi l l sti l lwork. You can see this in the diagram in Testing an Environment for theFirst Time, or by looking at the Intel l igence Servers on your MicroStrategyWeb Administrator page.

Enter the Intelligence Server address (IP or FQDN):

Enter the port that the Intel l igence Server service is running on. By defaul t,i t is 34952, but ask your MicroStrategy administrator or check theconfiguration in MicroStrategy Web Administrator to confi rm.

Enter the Intelligence Server port [34952]:

Up grad e Gu id e


Select ei ther Standard or LDAP connection mode for your Intel l igenceServer to execute content objects.

If you are using your corporate credentials to log into MicroStrategy i t isl ikely that you are using LDAP. If you are using a di fferent login, such asthe defaul t one that comes with MicroStrategy Cloud Platform for AWS orMicroStrategy Cloud Platform for Azure, your login mode is l ikely Standard.

Select the connection mode:

[1] Standard

[2] LDAP

1

Enter the username and password that wi l l execute the content objects forthe test.

The message below wi l l be received when a connection has been made.

Enter the username for the environment: mstr

Enter the password for the environment: ************

Validating connection to Web and the Intelligence environment...

Connection successful!

If you entered a version of MicroStrategy 10.9 and above, you wi l l be askedfor your MicroStrategy Library API path. It is typical ly your web addressfol lowed by /MicroStrategyLibrary/api or /Library/api , but i fyou see something di fferent in your URL bar when logged intoMicroStrategy Library, provide that here.

Enter the full Library API URL

(ex.

https://env1234.customer.cloud.microstrategy.com:443/MicroStrategyLibrary

/api):

Validating API connection...


Up grad e Gu id e


In order to execute the test, a fi le cal led Profi les.csv needs to be created,which has instructions about which content objects to run.

Refer to the section Configuration Fi les: Profi les.csv for more information.

It is only necessary to provide this fi le i f the fi rst connected environmentdoes not have MicroStrategy Library and you do not have aResultsSummary.csv from a previously executed Integri ty Manager test.Select 1 to do so.

If you have previously executed an Integri ty Manager test and want toexecute the same content objects, select 2.

Otherwise, select 3 to enter the search mode and be guided through theprocess of selecting which content objects you would l ike to test.

Collecting information about your test...

Select the situation that best describes you:

I want to...

[1] upload my own Profiles.csv file

[2] upload my ResultsSummary.csv file from Integrity Manager.

[3] search for Reports, Documents, or Dossiers and create a new

Profiles.csv

+------------------------------------------------------------------+

MAIN SEARCH MENU:

Use \IN <PROJECT NAME(S)>

after the keyword to filter on a specific PROJECT

Type \DONE or \D

when you are finished selecting your documents/Reports

Type \VIEW or \V

to view your current selection list

** All commands must include the BACKSLASH **

Up grad e Gu id e

https://www2.microstrategy.com/producthelp/current/UpgradeGuide/Lang_1033/Content/upgrade_cap_tool_retesting.htm#Configur2


+------------------------------------------------------------------+

Enter the name (or a keyword) of the object you are looking for:

You can search two di fferent ways:

1. Search object by name.

This al lows the user to search the enti re metadata for a keywordmatching a content object’s name.

2. Browse project folders for objects.

This al lows the user to traverse through folders seeing what objectsare avai lable to be added.

Start the test by selecting 1.

+------------------------------------------------------------------+

SEARCH OPTIONS:

[ 1 ] Search object by name

[ 2 ] Browse project folders for objects

[ 3 ] Exit search

+------------------------------------------------------------------+

Enter option: 1

Searching by name presents the fol lowing options:

l \IN <Project Names(s)>: Adding this option to the end of thekeyword wi l l search for the keyword in the speci fied project(s) only.Mul tiple project names must be comma separated.

l \VIEW or \V:This option al lows you to see what objects have beenselected so far. Currently the cl ient does not al low the removal of objects

Up grad e Gu id e


from the selection. You can modi fy selections by edi ting the response fi legenerated at the end of the session and re-run the test using the responsefi le.

l \DONE or \D: Wil l end the searching session.

Search for the word supply to see an example of the resul ts returned.

Enter the name (or a keyword) of the object you are looking for: supply

Starting search for objects with name containing 'supply'... ... ... ...

... ... ... ...

+------------------+

SEARCH RESULTS:

+------------------+

Project Name, Type, Item Name

[0] MicroStrategy Tutorial, Document, 1- Supply Chain Management Report

[1] MicroStrategy Tutorial, Document, Supply ChainManagement, MicroStrategy Tutorial/PublicObjects/Reports/Getting Started/Web

[2] MicroStrategy Tutorial, Document, Supply ChainManagement, MicroStrategy Tutorial/PublicObjects/Reports/Getting Started/Mobile

[3] MicroStrategy Tutorial, Document, Supply ChainManagement Report

+-------------------------------------------------+

Use COMMA (,) to separate the indexes

Use DASH (-) to capture a range of indexes

Use STAR (*) to select ALL

Press ENTER to go back

+-------------------------------------------------+

Enter the index(es) of the document(s)/report(s) you wish to select:

Up grad e Gu id e


This is the page where the user searches for an object. The searching toolprints out search resul ts in the fol lowing manner:

l Sorted by Project Name, Object Type, Object Name

l There are two spaces between di fferent projects

l If objects wi th the same name are found in the same project, the resul tmenu wi l l also print out the object’s ful l path so you can distinguishbetween them.

Each set of resul ts have an index assigned to i t (an integer). You selectobjects using the index and the fol lowing modi fiers:

l Select individual indices with commas (,)

l Select indices with a range (-)

l Select al l returned resul ts wi th a star (*)

l User can choose to not select any resul ts and return to main menu bypressing ENTER

For example, i f you only wanted to add “1- Supply Chain ManagementReport” and “Supply Chain Management Report”, then simply enter 1,3.

Enter the Index(es) of the document(s)/report(s) you wish to select: 1,3

Input(s) saved! You can see your saved objects by typing \VIEW in main

search menu

Once you have added al l the content objects searching by name, type \D toexi t and select 2 to search by traversing through folders.

+------------------------------------------------------------------+

SEARCH BY NAME

Use \IN <PROJECT NAME(S)>

after the keyword to filter on a specific PROJECT

Up grad e Gu id e


Type \DONE or \D

when you are finished selecting your documents/Reports

Type \VIEW or \V



+------------------------------------------------------------------+

Enter the name (or a keyword) of the object you are looking for: \d

+------------------------------------------------------------------+

SEARCH OPTIONS:



[ 3 ] Exit search

+------------------------------------------------------------------+

Enter option: 2

+------------------------------------------------+

PROJECTS:

[ 0 ] Consolidated Education Project

[ 1 ] Hierarchies Project

[ 2 ] Human Resources Analysis Module

[ 3 ] MicroStrategy Tutorial

[ 4 ] Platform Analytics

[ 5 ] Relationships Project

Up grad e Gu id e


+------------------------------------------------------------------+

Type \VIEW or \V


Type \DONE or \D

when you are finished selecting your

reports/documents/dossiers


+------------------------------------------------------------------+

Select a project to start drilling down folders:

From here, users can use the index values to fi rst select a project, and onceinside the project, the project name and parent folders wi l l appear. Thisal lows the user to continue down and find the folder that contains theobjects they want to add. For example, when trying to travel to the folder/MicroStrategy Tutorial/Public Objects/Reports/Sample

Dossiers , here are the values that would be selected to get there.

+------------------------------------------------+

PROJECTS:






Up grad e Gu id e



+------------------------------------------------------------------+

Type \VIEW or \V


Type \DONE or \D




+------------------------------------------------------------------+

Select a project to start drilling down folders: 3

+------------------------------------------------+

FOLDERS:

/MicroStrategy Tutorial

[ 0 ] Project Builder

[ 1 ] Project Objects

[ 2 ] Public Objects

[ 3 ] Schema Objects

Up grad e Gu id e


[ 4 ] My Answers

[ 5 ] My Dossiers

[ 6 ] My Favorites

[ 7 ] My Objects

[ 8 ] My Reports

[ 9 ] My Segments

[ 10 ] My Shared Dossiers

+------------------------------------------------+

TO SELECT OBJECTS...





+------------------------------------------------+

Enter the index(es) of the object(s) you wish toselect OR drill further into a folder: 2

+------------------------------------------------+

FOLDERS:

/MicroStrategy Tutorial/Public Objects

[ 0 ] AutoStyles

Up grad e Gu id e


[ 1 ] Consolidations

[ 2 ] Custom Groups

[ 3 ] Documents

[ 4 ] Drill Maps

[ 5 ] Filters

[ 6 ] Metrics

[ 7 ] Prompts

[ 8 ] Reports

[ 9 ] Searches

[ 10 ] Templates

+------------------------------------------------+






+------------------------------------------------+


+------------------------------------------------+

OBJECTS:

Up grad e Gu id e



[0] MicroStrategy Tutorial, Report, I am a Report

[1] MicroStrategy Tutorial, Document, Tutorial Home

+------------------------------------------------+

FOLDERS:

/MicroStrategy Tutorial/Public Objects/Reports

[ 2 ] Business Roles

[ 3 ] Documents and Scorecards

[ 4 ] Enterprise Reporting Documents

[ 5 ] Getting Started

[ 6 ] MicroStrategy Platform Capabilities

[ 7 ] Sample Dossiers

[ 8 ] Subject Areas

[ 9 ] Testing

+------------------------------------------------+






+------------------------------------------------+


+------------------------------------------------+

Up grad e Gu id e


OBJECTS:


[0] MicroStrategy Tutorial, Dossier, Advanced andPredictive Analytics

[1] MicroStrategy Tutorial, Dossier, CustomVisualizations

[2] MicroStrategy Tutorial, Dossier, FinanceExecutives

[3] MicroStrategy Tutorial, Dossier, GeospatialFeatures

[4] MicroStrategy Tutorial, Dossier, InvestmentFirm Dossier

[5] MicroStrategy Tutorial, Dossier, Life as a NewHire

[6] MicroStrategy Tutorial, Dossier, MicroStrategyInk.

[7] MicroStrategy Tutorial, Dossier, MultinationalBank Dossier

[8] MicroStrategy Tutorial, Dossier, Office RoyaleSales

[9] MicroStrategy Tutorial, Dossier, Retail StoreManager

[10] MicroStrategy Tutorial, Dossier, Slot MachinePerfomance

[11] MicroStrategy Tutorial, Dossier, Store ManagerDossier

+------------------------------------------------+

FOLDERS:

Up grad e Gu id e


/MicroStrategy Tutorial/PublicObjects/Reports/Sample Dossiers

+------------------------------------------------+






+------------------------------------------------+

Enter the index(es) of the object(s) you wish toselect OR drill further into a folder:

You can see there are 12 dossiers in this folder wi th the indexes 1 through11. The same options to add objects to your test apply here as they didabove with a common, dash, and star options. Once the objects areselected from the folder, the search wi l l return to the project level to startagain.

Once al l of your objects have been added to your test, use \V to quicklysee what has been added before selecting \D to exi t the folder search,fol lowed by 3 to close the search functional i ty.

Enter the index(es) of the object(s) you wish to select OR drill further

into a folder: *

Input(s) saved! You can see your saved objects bytyping \VIEW in main search menu.

+------------------------------------------------+

PROJECTS:


Up grad e Gu id e







+------------------------------------------------------------------+

Type \VIEW or \V


Type \DONE or \D




+------------------------------------------------------------------+

Select a project to start drilling down folders: \v

+------------------+

YOUR SELECTION:

+------------------+

Up grad e Gu id e



[0] MicroStrategy Tutorial, Document, Supply ChainManagement

[1] MicroStrategy Tutorial, Document, Supply ChainManagement Report

[2] MicroStrategy Tutorial, Dossier, Advanced andPredictive Analytics

[3] MicroStrategy Tutorial, Dossier, CustomVisualizations

[4] MicroStrategy Tutorial, Dossier, FinanceExecutives

[5] MicroStrategy Tutorial, Dossier, GeospatialFeatures

[6] MicroStrategy Tutorial, Dossier, InvestmentFirm Dossier

[7] MicroStrategy Tutorial, Dossier, Life as a NewHire

[8] MicroStrategy Tutorial, Dossier, MicroStrategyInk.

[9] MicroStrategy Tutorial, Dossier, MultinationalBank Dossier

[10] MicroStrategy Tutorial, Dossier, Office RoyaleSales

[11] MicroStrategy Tutorial, Dossier, Retail StoreManager

12] MicroStrategy Tutorial, Dossier, Slot MachinePerfomance

Up grad e Gu id e


[13] MicroStrategy Tutorial, Dossier, Store ManagerDossier

+------------------------------------------------+

PROJECTS:







+------------------------------------------------+

Type \VIEW or \V


Type \DONE or \D




+------------------------------------------------+

Select a project to start drilling down folders: \d

+------------------------------------------------+

Up grad e Gu id e


SEARCH OPTIONS:



[ 3 ] Exit Search

+------------------------------------------------+

Enter option: 3

Now the test execution configuration needs to be set, by setting how manyjobs (threads) to execute simul taneously against the Intel l igence Server,and how many times (cycles) to perform each set of steps.

One cycle would include logging in as the defined user, executing al l of thecontent objects, and then logging out.

Enter y to accept the defaul t test configuration or n to define a custom test.

Collecting properties about your test...

Here are the default threads and cycles:

1. Thread: 1 Cycle: 5






Would you like to keep the default capacity testing properties? (y/n):

Below is an example of defining a custom test.

Fi rst, define the number of simul taneous jobs that wi l l be executed againstthe Intel l igence Server. Second, define the number of times that the test setwi l l be executed. After the fi rst execution is defined, you may continueadding addi tional executions by entering y or n to move forward.

Up grad e Gu id e


TEST CYCLE #1

Enter the number of thread(s): 2

Enter the number of cycle(s): 4

Would you like to add another JMeter test cycle? (y/n): n

Once the test configuration has been completed, another environment canbe selected. For example, the test above was configured with Environment#1 on 2019, and i f the user is upgrading from 10.4.8, for the secondenvironment they wi l l want to input that connectivi ty information. As manyas 10 di fferent environments can be defined within the same test to col lectcapaci ty information from those environments simul taneously.

Would you like to add another environment test?(y/n): y

ENVIRONMENT #2

Collecting information about your web server properties...

Select the MicroStrategy Web Server type:

[1] ASP (IIS-Windows)

[2] JSP (Universal)

2

Enter the MicroStrategy Platform Version: 10.4.8

Select the web protocol:

[1] http

[2] https

2

Enter the web port [443]:

Enter the web server address (ex. env-123.us-east-1.elb.amazonaws.com):

env-113986.customer.cloud.microstrategy.comEnter the web path extension

[/MicroStrategy/servlet/mstrWeb]:

Enter the Intelligence Server address (IP or FQDN): 10.250.144.255

Enter the Intelligence Server port [34952]:

Select the connection mode:

Up grad e Gu id e


[1] Standard

[2] LDAP

1

Enter the username for the environment: mstr

Enter the password for the environment: ************

Validating connection to the environment...


Would you like to add another environment to test (y/n): n

Once al l environments have been added and the user selects n , the testconfiguration wi l l be complete and a JSON response fi le wi l l beautomatical ly created in the same directory where the Capaci ty TestingTool exists. See Testing an Environment for the First Time for instructionson how to re-run your test later.

Select 1 to execute the saved test against the environments defined, orselect 2 to close the Capaci ty Testing Tool , which wi l l close the program.

Would you like to add another environment to test (y/n): n

Prompting finished!

Successfully created response file as: <path to json file displayed here>

Please select from the following options...

[1] EXECUTE all tests

[2] EXIT and run tests later

If there are any problems that occur during the test, jmeter.log wil l becreated under \apache-jmeter-3.1\bin\ and addi tional ly under thefolder Capacity_Results_Analysis for the test’s execution resul ts.

Up grad e Gu id e


Testing an Environment Again

Configuration Files: Profiles.csv

In order to execute tests, the Profiles.csv fi le containing the l ist ofcontent objects to run, is required. It is only necessary to provide this as astandalone fi le i f the fi rst environment does not have MicroStrategy Library.Otherwise users can select 2 and be guided through the process ofselecting content objects. However, i f 1 is selected, or a user does not haveMicroStrategy Library configured, Profiles.csv must be provided.

The CSV fi le speci fies the objects that wi l l be used for the capaci ty test. Asstated above, the Capaci ty Testing Tool supports reports, Report ServicesDocuments, dashboards, and dossiers. Prompted objects of any kind areNOT supported. The fi le is populated with sample data by defaul t to helpi l lustrate the format needed.

There are six columns that need to be populated in the CSV fi le for eachobject to be correctly executed:

Up grad e Gu id e


l Project Name: This needs to be exactly as i t is displayed in Web.

l User login: This is the login for the user that wi l l execute the object wi th.Keep in mind that you can use any combination of users for the test. Inother words, exact object can be executed with the same login, or acombination. The resul ts wi l l inheri t the object securi ty and securi ty fi l tersas i f they were logging into web, so be sure that you pick appropriateusers.

l User password : Password for user’s login. If the password is blank,leave i t empty.

l Name of object to be executed: This is the name of the object that wi l lbe displayed in the capaci ty test resul ts. Whi le i t is recommended that thename used should be exactly how it exists in the project, keep in mindthat special characters are not supported, and therefore remove themhere. You do not need to worry about renaming the actual objects in eachproject.

l Object type: If the object is a report, use “reportID” for this field. If theobject is a Report Services Documents, dashboard, or dossier use“documentID.”

l Object ID: The corresponding ID of the object to be tested. In Web, right-cl ick on the object’s name, and cl ick Properties which wi l l provide you theID that is needed.

Up grad e Gu id e


Configuration Files: Silent Response File

You can provide a JSON fi le wi th instructions for the Capaci ty Testing Toolto automatical ly run a test. This is useful i f you’re doing the rest repeti tivelyor automating i t wi th a script. To use a si lent response fi le, select option 1for the fi rst prompt that is provided.

The tool generates a response fi le after a test is created. This response fi leis a JSON fi le that can be used again by the cl ient to re-run a test. Theresponse fi le by defaul t wi l l be placed under the capaci ty test package andwi l l be named with the format response_full_environment_hostnames_timestamp.json . The user can edi t this at their owndiscretion.

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

# Welcome to the #

# MicroStrategy Performance & #

# Capacity Test Tool #

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

[1] Run test using response file

[2] Start a new test

An example of a response fi le is as fol lows.

{

"Tests": [

{

"WebServerProperties": {

"webServerType": "JSP",

"webServerAddress": "env-1234.customer.cloud.microstrategy.com",

"webPort": 443,

"protocol": "https",

"webPath": "/MicroStrategy/servlet/mstrWeb",

"iServerName": "env-1234laiouse1",

"iServerPort": 33495,

"connMode": 1,

"mstrVersion": "11.0"

},

Up grad e Gu id e


"Profiles": [

{

"projectName": "MicroStrategy Tutorial",

"username": "mstr",

"password": "password123",

"name": "Finance",

"type": "report",

"ID": "RE12344GGDI1123444",

"path": "/MicroStrategy Tutorial/Sample Dossier/Finance/"

},

{

"projectName": "",

"username": "",

"password": "",

"name": "",

"type": "",

"ID": "",

"path": ""

}

],

"JMeterProperties": [

{

"thread": 1,

"cycle": 2

},

{

"thread": 1,

"cycle": 5

},

{

"thread": 5,

"cycle": 5

}

]

}

]

}

Up grad e Gu id e


Troubleshooting the Capacity TestThis section contains common errors encountered whi le executing aCapaci ty Test and how to resolve those errors.

Capaci ty Testing tool times out a report execution

If larger reports or documents are not ful ly executed during the test you wi l lneed to increase the timeout l imi t.

Ho w t o In cr ease t h e Tim eo u t Lim i t

1. In the extracted Capaci ty Testing Tool folder, open jmeter > templates> template_while.

2. In l ine 17, modi fy the parameter parseInt(${counter}) != 300

to a number between 100 and 400.

For example,

WhileController.condition”>${__javaScript( “${DONE}” != “mstr-stats” &&

parseInt(${counter}) != 100 ;)}</stringProp>

Capaci ty Testing Tool pauses during testing

l Capaci ty Testing tool wi l l pause the test i f you cl ick anywhere on theterminal (black screen). If you cl ick on the terminal , to resume the test, hi tEnter on your keyboard.

[HTTPError] 401 Unauthorized

Possible Solutions:

l Double check that the password was entered correctly.

l Ensure that the URL entered is correct.

l IIS users should ensure that Anonymous Authentication is enabled andWindows Authentication is disabled.

Up grad e Gu id e


You can check this by pasting the MicroStrategy Web URL into a browserrunning in Private or Incogni to mode. If you are prompted for credentials,check the above authentication settings.

l Check that the account being used for the Capaci ty Test has permissionsfor the MicroStrategy folder on the Web Server.

[HTTPError] 302

l Check that the account being used for the Capaci ty Test has permissionsfor the MicroStrategy folder on the Web Server.

If your Profiles.csv fi le is in a language other than Engl ish

l Open this csv fi le wi th Notepad++ to ensure that there are no erroneouscharacters in the fi le. These text encoding issues wi l l cause the Capaci tyTesting Tool to report errors.

Test fai led: text expected to contain /Shared Reports/

l This error may appear when your Web language settings are set to alanguage other than Engl ish. To resolve the error, set the Web languageto Engl ish.

Test fai led: text expected to contain /pageWait.css/

l This error may appear when running a Capaci ty Test on environmentsusing MicroStrategy version 10.4 through 10.4.5 or version 10.11. Referto Disabl ing the Wait Page in MicroStrategy Web to resolve this issue.

Upgrade Analysis Dossier

The Upgrade Analysis Dossier consumes the resul ts of comparison testingin MicroStrategy Integri ty Manager and the new MicroStrategy Capaci tyTesting Tool to help Platform Administrators understand the impact ofupgrading from engine changes along with performance improvements.

The most recent dossier can be downloaded here.

Up grad e Gu id e

https://community.microstrategy.com/s/article/Upgrade-Analysis-Dossier


This section wi l l explain how to upgrade the dossier wi th new resul ts fromboth Integri ty Manager and the Capaci ty Testing Tool , along with explainingthe use of each Chapter and i ts corresponding Pages.

Refreshing Upgrade Impact Results1. Navigate to the output folder that was created after comparison testing

was done in Integri ty Manager.

There are five fi les generated after running Basel ine vs Project inIntegri ty Manager:

l BaseObjectDependency.csv

l BaseUpgradeImpact.csv

l ResultsSummary.csv

l TargetObjectDependency.csv

l TargetUpgradeImpact.csv

2. Copy the five fi les to a cl ient machine where Workstation is instal led.Once there, open the Upgrade Analysis Dossier.

3. Enable the Datasets Panel and cl ick the three dots next toResultsSummary.csv and select Edit Dataset.

4. Cl ick on the down-arrow next to the ResultsSummary.csv table andselect Edit Table.

5. When the screen opens, cl ick on Choose files and then select yourResultsSummary.csv fi le and then cl ick Open > Refresh .

6. Repeat steps 3 - 5 with the fol lowing Tables > Files :

l BaseObjectDependency > BaseObjectDependency.csv

l TargetObjectDependency > TargetObjectDependency.csv

Up grad e Gu id e


l TargetObjUpgradeImpact > TargetUpgradeImpact.csv

l TargetDepObjUpgradeImpact > TargetUpgradeImpact.csv

7. Once al l of the fi les have been refreshed, cl ick Update Dataset toupdate the enti re dataset.

Refreshing Capacity Results1. Navigate to the output folder that was created after comparison testing

was done in Integri ty Manager.

Within that folder identi fy two CSV fi les:

l Execution_Details.csv

l Summary.csv

2. Copy the two fi les to a cl ient machine where Workstation is instal led.Once there, open the Upgrade Analysis Dossier.

3. Enable the Datasets Panel and cl ick the three dots next toExecution_Details.csv and select Edit Dataset.

4. Cl ick on the down-arrow next to the Execution_Details.csv tableand select Edit Table.

5. When the screen opens, cl ick on Choose files and then select yourExecution_Details.csv fi le and then cl ick Open > Refresh .

6. Repeat steps 3 - 5 for the Summary.csv table.

7. Once al l of the fi les have been refreshed, cl ick Update Dataset toupdate the enti re dataset.

Examining Testing ResultsOnce the two datasets have been refreshed, the dossier is now ready to beexamined. Keep in mind before getting started that unless the sameenvironments and content objects (reports, Report Services Documents,and dossiers) were used for the Integri ty Manager comparison testing and

Up grad e Gu id e


for Capaci ty Testing Tool , then the resul ts that appear in the two chaptersexplained below wi l l be independent of each other.

Upgrade Impact Results Chapter

Comparison testing with MicroStrategy Integri ty Manager now provideslogging that helps provide a ful l analysis of di fferences found whencomparing MicroStrategy 2020 environments to MicroStrategy 10.xenvironments wi th an explanation of the cause and the reasons for suchchanges. This chapter of the Upgrade Analysis Dossier provides fourdi fferent pages i l lustrating those resul ts. These pages help to identi fyobject mismatches that are affected by version changes. More importantly,objects that have a mismatch but did not encounter a change and contentobjects that should examined in more detai l , are now easi ly identi fiable.

Object Overview Page

The Object Overview page shows the same summary information that iscontained in the ResultsSummary.html fi le. At the top, PlatformAdministrators can see the ful l bui ld version from the Intel l igence Serversthat were tested.

The Object Overview master grid provides al l of the objects that weretested along with their comparison status and performance improvement i fmul tiple executions were done.

Up grad e Gu id e


A simple guide to understanding the resul ts:

Result Explanation

■Executions successful or comparison matched between Baseand Target

♦ Comparison mismatched between Base and Target

Not Tested Option not selected to be tested

ComparisonUnavailable

Comparison is not supported for object type

The master grid is used as a selector for the bottom grids Object Path &Changes and Dependent Objects & Changes. When you select an objecton the master grid, that object wi l l target and fi l ter the two bottom grids. Ifthe object encountered a change, then the Object Path & Changes grid wi l ll ist the object’s name, path, the change identi fier (Ex. US120878) and a“l ink.” This l ink when cl icked wi l l open up the defaul t browser on the

Up grad e Gu id e


machine and navigate to a MicroStrategy Knowledge Base article to helpexplain any mismatches that the object encountered. The “DependentObjects & Changes” is used to identi fy any dependent objects that wereexecuted for the object that was selected that also encountered anychanges.

For example, an object cal led Document1 used three datasets Report1,Report2, and Report3. When you select Document1 from the master grid,the “Object Path & Changes” appears as blank, but Report1 and Report2appear in the “Dependent Objects & Changes” grid, both showing with thechange identi fier DE123456. This means that when Report1 and Report2were executed against the Intel l igence Server to gather the dataset resul tsfor Document1, they encountered a change, however when Document1 wasbeing processed, i t did not encounter a change. This helps to identi fy thespeci fic object where a change was encountered, whether i t is at the parentobject level , or dependent object level .

Changes Encountered Page

The Changes Encountered page quickly provides Platform Administratorswi th the number of changes that were returned from the execution of al lcontent objects and their dependent objects. With the “Changes” grid at thetop, select any change identi fier (fi rst column) or i ts correspondingdescription to fi l ter the bottom grid “Objects Affected” to see exactly whichobjects from the test were affected by the change.

Up grad e Gu id e

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


Keep in mind that as new changes continue to get added, Knowledge Basearticles are being wri tten thereafter so some may not have l inks yet, butthey wi l l avai lable soon.

Object Mismatches without Changes Page

The Object Mismatches w/o Changes page l ists those objects that weretested and returned a comparison mismatch for SQL Comparison or DataComparison but did not encounter any changes that can explain themismatch. Al though these mismatches could be due to explainable thingsincluding di fferent environments pointing to di fferent warehouses, dynamicdate prompts, etc., they should be examined further wi th Integri ty Manager’sResultsSummary.html to see the exact SQL and Data di fferences tohelp explain why they are not matching.

Up grad e Gu id e

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


Performance Evaluation Page

If performance testing was done within Integri ty Manager by runningmultiple executions of content objects, then this bubble graph wi l l helpquickly identi fy i f their performance was better or worse when comparingthe Base versus Target versions.

The bottom grid “Object Performance Cycles” wi l l show the averageperformance gain or loss of objects by type. To see the speci fic gain or lossfor a content object, select a bubble to fi l ter the bottom grid.

Up grad e Gu id e


Capacity Testing Results

The MicroStrategy Capaci ty Testing Tool provides users wi th a quick andeasy way to perform end-to-end performance testing. This chapter providesthree di fferent pages i l lustrating those resul ts, helping to identi fy anythroughput or resource problems, as wel l as comparing di fferent platformreleases to confi rm performance gains, and identi fy any problem areas,down to the step-level .

Summary Page

The Summary page provides with you a high-level overview of the projectstested by users across versions to provide an average response timecomparison for quick analysis. The bubble chart below shows the averageresponse for each version in respect to the number of threads, or jobs, thatwere executing simul taneously from the tool .

Up grad e Gu id e


As the number of threads increases and stress on the Intel l igence Serverincreases, errors wi l l start to be received which increases the size of thebubbles, i l lustrating stress on the server. This helps the PlatformAdministrator when the server is starting to hi t the maximum capaci ty that i tcan handle based on resources and the tuning that has been done.

Performance by Execution Type Page

The end-to-end testing that the tool provides includes logging in andlogging out as part of the execution steps. With the Performance byExecution Type page, Platform Administrators can see the performance ofonly the content objects or the performance of logging in and logging outonly.

Up grad e Gu id e


Execution Details Page

The Execution Detai ls page uses an outl ine grid wi th the same name at thetop to provide every single execution value for every step down to thethread used. Cl icking on a step wi l l target and fi l ter the bottom gridExecution Step Comparison by Version. As with the Summary page graph,Platform Administrators can see the performance for each thread for anexact step for a speci fic user.

This view can help in identi fying outl iers or nuances in performance fromone step for a content object or logging in/logging out that may beperforming poorly.

Up grad e Gu id e


Resolving Problems Encountered During theUpgrade

The Readme contains troubleshooting scenarios aimed to assist you duringor after an upgrade to the latest version of MicroStrategy. If you encounteran issue not covered in the Readme or by the suggestions below, contactMicroStrategy Technical Support for addi tional assistance.

l Make sure you have met the system requirements and other prerequisi tesfor the current version of MicroStrategy, as noted in UpgradePrerequisi tes, page 7.

l Be aware of the level of interoperabi l i ty between the current version ofMicroStrategy and the version you are upgrading from, as noted inCompatibi l i ty and Interoperabi l i ty section of the Readme.

Up grad e Gu id e





l Any errors in the upgrade process are l ikely to be wri tten to theinstal lation log fi le, install.log . This fi le is in the directory that youspeci fy as the instal lation directory during the upgrade.

l When you use the Configuration Wizard to add tables to the metadata orupdate your projects, each SQL statement that is executed is logged tothe Configuration Wizard log fi le, MACfgWiz.xml . This log fi le is in theLog subfolder of the main MicroStrategy directory. You can analyze thelog fi le using a thi rd-party log viewer, such as the Apache Chainsaw logviewer, which can be downloaded fromhttp://logging.apache.org/chainsaw/index.html .

l If MicroStrategy Web users encounter errors after you upgradeMicroStrategy Web, you may need to clear your appl ication and webserver caches, or your users may need to clear their browser caches. Forinstructions on how to clear these caches, see the documentation for yourweb server, appl ication server, and web browser.

l MicroStrategy recommends upgrading to the latest version withoutuninstal l ing the previous version of MicroStrategy. However, in raresi tuations, issues may be encountered as a resul t of an in-place upgrade.In these si tuations, you may need to uninstal l your existing MicroStrategyinstal lation before instal l ing the new version.

Up grad e Gu id e


Supp lem en t al In f o r m at ion

Application Servers

The sections below provide instructions for setting up di fferent appl icationservers to deploy MicroStrategy Web, Mobi le, and Library.

Deploying with IIS (Windows)

Microsoft IIS can be used to deploy MicroStrategy Web and MicroStrategyMobi le Server:

Deploying MicroStrategy Web

sThe ASP.NET version of MicroStrategy Web can be deployed with IIS onlyon Windows.

l You must have administrative priv ileges to deploy MicroStrategy Web for yourproject. If this is the first time you are logging in and you have not changed thedefault MicroStrategy administrative login, you can use Administrator as thelogin with no password. After the first time, the user name and password shouldbe changed for security purposes.

l The Microsoft Windows' Users group must have read and execute permissionsto all of the files within the MicroStrategy common files folder. This ensures thatInternet Information Services has the required permissions to hostMicroStrategy Web. By default, this folder is stored in the following directorylocation:

64-bit Windows environments:

Up grad e Gu id e


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 pagewhere you connect MicroStrategy Web to the Intel l igence Serveropens.

2. Type the name of your Intel l igence Server in the Add a servermanually box on the MicroStrategy Web Administrator page.

3. Cl ick Connect. Al l projects loaded on the Intel l igence Server are nowavai lable from MicroStrategy Web. Cl ick the Home icon to see the l istof projects loaded on the Intel l igence Server you speci fied.

4. Send your users the URL:

http://webservername/MicroStrategy/asp/

where webservername is the name of the computer hosting your Webserver. For example, i f the name of your Web server machine is Web_

Srv1 , then the URL your users would use to access MicroStrategyWeb would be

http://Web_Srv1/MicroStrategy/asp

You have manual ly connected MicroStrategy Web to the Intel l igenceServer.

You can also connect automatical ly whenever MicroStrategy Web Server orIntel l igence Server starts.

Up grad e Gu id e


To make MicroStrategy Web connect to the Intelligence Server

automatically

1. On the MicroStrategy Web Administrator page, cl ick Modify in theProperties column of the Intel l igence Server.

2. Select the Automatically connect to Intelligence Server when WebServer or Intelligence Server is restarted option and cl ick Save.

Deploying Mobile Server

The ASP.NET version of MicroStrategy Mobi le Server can only be deployedwith IIS only on Windows.

l You must have administrative priv ileges to deploy MicroStrategy Mobile Serverfor your project. If this is the first time you are logging in and you have notchanged the default MicroStrategy administrative login, you can useAdministrator as the login with no password. After the first time, the username and password should be changed for security purposes.

l The Users group for Microsoft Windows must have read and executepermissions to all of the files within the MicroStrategy common files folder. Thisensures that IIS has the required permissions to host MicroStrategy MobileServer. By default, this folder is stored in the following directory location:

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

Up grad e Gu id e


2. Type the name of your Intel l igence Server in the Add a servermanually box on the MicroStrategy Mobi le Server Administrator page.

3. Cl ick Connect.

4. Cl ick Mobile Configuration to configure your MicroStrategy Mobi leappl ications to communicate with Mobi le Server and Intel l igenceServer. For steps on how to define this configuration, see theMicroStrategy Mobi le Administration Guide.

You have manual ly connected MicroStrategy Mobi le Server to theIntel l igence Server.

You can also connect automatical ly whenever MicroStrategy Mobi le Serveror Intel l igence Server starts.

To make MicroStrategy Mobile Server connect to the Intelligence

Server automatically

1. On the MicroStrategy Mobi le Server Administrator page, cl ick Modifyin the Properties column of the Intel l igence Server.

2. Select the Automatically connect to Intelligence Server whenMobile Server or Intelligence Server is restarted option.

3. Cl ick Save.

Deploying with JBoss (Windows)

This chapter provides information used to deploy and configureMicroStrategy JSP appl ications in a JBoss environment. You can use thesteps below to deploy MicroStrategy Web (JSP) and MicroStrategy Mobi leServer (JSP):

l Preconfiguration Information, page 217: configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

Up grad e Gu id e

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


l Deploying MicroStrategy Web and Mobi le Server, page 218: instructionsfor deploying, including step-by step procedures.

Preconfiguration Information

This section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications on JBoss on your machine.

In st al l in g t h e JDK

If you have not instal led Oracle JDK yet, download i t here. Be sure to instal lthe JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall the JDK. If you install the JDK to a simple folder path such as C:\ thensetting the system variable is easier and more likely to be correct.

Co n f igu r in g t h e JDK

1. On your Windows machine, go to Start > Computer > Systemproperties > Advanced system settings > Environment Variables.

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these productsis subject to change. Refer to the appropriate Microsoft documentationfor steps to access and modify the environment variables.

2. Under System Variables, cl ick New to create a system variable. TheNew System Variable dialog box opens.

3. In the Variable Name box, type JAVA_HOME .

4. In the Variable Value box, speci fy the destination folder where youinstal led the JDK and cl ick OK .

Up grad e Gu id e

http://www.oracle.com/technetwork/java/index.html


For example, if the fully qualified path to your JDK executable isC:\jsdk1.8.0\bin\java.exe , the value of your JAVA_HOMEvariable is C:\jsdk1.8.0 .

If you have installed JDK under the Program Files folder, typeProgra~1 in the destination folder; otherwise the system does not recognizethe folder. For example, C:\Progra~1\jsdk1.8.0 .

In st al l in g JBo ss

You can download and instal l JBoss here.

Keep track of the location in which you instal l JBoss, as this location isused later (referred to as JBOSS_HOME ) to configure JBoss with aMicroStrategy JSP appl ication deployment.

Deploying MicroStrategy Web and Mobile Server

Assuming you have made al l the necessary configurations described above,you can begin deploying MicroStrategy Web (JSP), Mobi le Server (JSP)(JSP) wi th JBoss.

Dep lo yin g u sin g JBo ss as a st an d -alo n e Web co n t ain er

To deploy MicroStrategy JSP applications using JBoss as a stand-alone

Web container

1. Locate the WAR fi le for your MicroStrategy JSP appl ication.

2. Copy the WAR fi le to the JBOSS_HOME\server\default\deploy

directory.

3. To start JBoss, browse to JBOSS_HOME\bin . Then run the fol lowingcommand:run.bat -b 0.0.0.0

Up grad e Gu id e

http://www.jboss.org/jbossas/downloads


Your MicroStrategy JSP appl ication is deployed automatical ly, based onthe fol lowing:

l If you have configured JBoss to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within the JBOSS_

HOME\server\default\deploy directory:

l When deploying MicroStrategy Web (JSP), the folder is namedMicroStrategy by defaul t.

l When deploying MicroStrategy Mobi le Server (JSP), the folder is namedMicroStrategyMobile by defaul t.

l If you have configured JBoss to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Windows systems, the temporary fi le di rectory is commonlydefined by the TMP environment variable:

l When deploying MicroStrategy Web (JSP), a /microstrategy/web-

Version/ folder is created within the temporary fi le di rectory, whereVersion is the version number for the MicroStrategy Web (JSP)product. Within this folder location, various configuration fi les can befound within the WEB-INF folder and i ts subfolders.

l When deploying MicroStrategy Mobi le Server (JSP), a/microstrategy/mobile-Version/ folder is created within thetemporary fi le di rectory, where Version is the version number for theMicroStrategy Mobi le Server (JSP) product. Within this folder location,various configuration fi les can be found within the WEB-INF folder andi ts subfolders.

Co n f igu r in g ad m in ist r at ive access t o Micr o St r at egy JSP ap p l icat io n s

To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the JBoss user configuration fi les. Thesteps to configure this access are below.

Up grad e Gu id e


To configure administrative access to MicroStrategy JSP applications

1. Browse to the directory JBOSS_HOME\server\default\conf ,where JBOSS_HOME is the location in which you instal led JBoss.

2. Create the fol lowing two fi les wi thin this directory:

l users.properties

l roles.properties

3. Open the users.properties fi le in a text edi tor.

4. Include one l ine for each user to grant administrative access to theWeb Administrator and Mobi le Server Administrator, using thefol lowing syntax:user_id=user_password

For example, you create UserA and UserB with passwords 1234 and5678 respectively using the fol lowing syntax:

UserA=1234

UserB=5678

5. Save your changes and close the users.properties fi le.

6. Open the roles.properties fi le in a text edi tor.

7. Include one l ine for each user you included in theusers.properties fi le and grant them administrative access, usingthe fol lowing syntax:user_id=admin

For example, you define UserA and UserB to have administrativeaccess using the fol lowing syntax:

l UserA=admin

l UserB=admin

Up grad e Gu id e


8. Save your changes and close the roles.properties fi le.

9. To start JBoss, browse to JBOSS_HOME\bin . Then run the fol lowingcommand:run.bat -b 0.0.0.0

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP appl ication administrativepage, page 221.

Accessin g t h e Micr o St r at egy JSP ap p l icat io n ad m in ist r at ive p age

You can use the steps below to access the administrative page for yourMicroStrategy JSP appl ication.

To access the MicroStrategy JSP application administrative page

1. In a Web browser, access the administrative page by speci fying thefol lowing URL:

l For Web (JSP):http://

localhost:8080/MicroStrategy/servlet/mstrWebAdmin

l For Mobi le Server (JSP):http://

localhost

:8080/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URLs l isted above are case-sensi tive. Make sure to use the correct case when typing the servletname. If the appl ication server is enabled with securi ty, a dialog boxrelated to the administrator authentication opens.

2. When prompted for a user name and password, type the user name forthe administrator user you created in the roles.properties fi le andthe login information in the users.properties fi le.

Up grad e Gu id e


3. After you are authenticated:

l If you are deploying MicroStrategy Web (JSP), the MicroStrategyWeb Administrator page appears. Add and connect to an Intel l igenceServer.

l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl icationsto communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy Web project page. In a Web browser, accessMicroStrategy Web project using this URL:

http://localhost:8080/MicroStrategy/servlet/mstrWeb

Deploying with Oracle 10g (Windows)

This chapter provides information used to deploy and configureMicroStrategy JSP appl ications with Apache as the Web server and OracleAppl ication Server 10g R3 as the appl ication server. You can use theprocedure below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP): For detai led deployment instructions, please see

For detai led deployment instructions, please see: Deploying MicroStrategyWeb and Mobi le Server, page 222


After your machine is configured, you can start the deployment of yourMicroStrategy JSP appl ication with Oracle Appl ication Server 10g R3.

Up grad e Gu id e




Dep lo yin g u sin g t h e Or acle En t er p r ise Man ager

You can access Oracle Enterprise Manager from the fol lowing URL:

http://MachineName:PortNumber/em

Where MachineName is the machine name or IP address of the Oraclemachine, and PortNumber is the port number of Oracle EnterpriseManager.

1. Start the Apache Web Server. From the Start menu, go to OracleAS10g - DEFAULT_HOME1 > StartApplicationServerName.MachineName.domain .

2. To veri fy that the Apache Web Server has started, open OracleEnterprise Manager, select HTTP Server, and then cl ick Start.

3. Select the OC4J instance where you want to deploy your MicroStrategyJSP appl ication. This procedure assumes you are using the defaul tinstance name home. Cl ick home. The OC4J: home page opens.

4. Select the Applications tab.

5. Cl ick Deploy.

6. In the Archive area, select Archive is present on local host.

7. Cl ick Browse to navigate to and select the WAR fi le for yourMicroStrategy JSP appl ication.

8. In the Deployment Plan area, select Automatically create a newdeployment plan and cl ick Next.

9. Enter the Application Name and Context Root. This section ondeploying MicroStrategy Web (JSP) with Oracle 10g usesMicroStrategy as the Appl ication Name and /MicroStrategy as theContext Root. For Mobi le Server (JSP), this section usesMicroStrategyMobile as the Appl ication Name and

Up grad e Gu id e


/MicroStrategyMobile as the Context Root.

10. Cl ick Next.

To map a user to the admin securi ty role

To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must assign users thesecuri ty role of admin . In Oracle 10g, the securi ty users and groups aredefined in the Oracle Enterprise Manager.

1. In the Map Security Roles task name, cl ick the Go To Task (penci l )icon.

2. For the admin securi ty role, select the Map Role (penci l ) icon.

3. Select Map selected users and groups to this role.

4. In the Map Role to Users area, in the User field, type the user name tomap to the admin securi ty role and cl ick Add .

Repeat this step to add al l users for whom you want to grantpermission to work in the MicroStrategy Web Administrator and Mobi leServer Administrator pages.

5. Cl ick Continue and OK .

6. Cl ick Deploy .

7. Stop and restart the Apache Web Server.

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP administrative pages, page224.

Accessin g t h e Micr o St r at egy JSP ad m in ist r at ive p ages


Up grad e Gu id e


To access the MicroStrategy JSP administrative pages

1. In a Web browser, access the administrative page by speci fying thefol lowing URL:


IPAddress:PortNumber

/MicroStrategy/servlet/mstrWebAdmin



/MicroStrategyMobile/servlet/mstrWebAdmin

Where IPAddress is the IP address of the Oracle machine andPortNumber is the port number used by the Oracle Appl icationServer. The servlet name at the end of the URLs l isted above are case-sensi tive, so be sure to use the correct case when typing the servletname.

2. When prompted for a user name and password, speci fy the values youused earl ier when creating the user mapped to the admin securi ty role(see Deploying using the Oracle Enterprise Manager, page 223above).



l If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications

Up grad e Gu id e


to communicate with Mobi le Server and Intel l igence Server. Forsteps on how to define this configuration, see the MicroStrategyMobi le Administration Guide. Creating a configuration completes thesteps required to deploy Mobi le Server (JSP).

4. If you are deploying MicroStrategy Web (JSP), you can now launch theMicroStrategy project. In a Web browser, access MicroStrategy Web(JSP) using this URL:

http://

IPAddress:PortNumber/MicroStrategy/servlet/mstrWeb

Where IPAddress is the IP address of the Oracle machine andPortNumber is the port number used by the Oracle Appl icationServer.

Deploying with SAP NetWeaver (Windows)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on a Windows machine using the SAPappl ication server. You can use the procedure below to deployMicroStrategy Web (JSP) and MicroStrategy Mobi le Server (JSP):

For detai led deployment instructions, please see: Deploying MicroStrategyWeb and Mobi le Server, page 226


Once your machine has the necessary settings configured, you can deployMicroStrategy Web (JSP), Mobi le Server (JSP) (JSP) on the SAP-Windowsmachine.

Dep lo yin g Micr o St r at egy JSP ap p l icat io n s wit h t h e SAP Net WeaverAp p l icat io n Ser ver

Fol low the steps provided in this section to deploy MicroStrategy JSPappl ications as a WAR fi le.

Up grad e Gu id e




To deploy MicroStrategy JSP applications as a WAR file


2. Copy the WAR fi le to the Windows machine hosting your appl icationserver. The location in which you store the fi le is used later andreferred to as path_to_war_file .

3. From the Windows Start menu, select Run .

4. In the Open drop-down l ist, type cmd , and cl ick OK .

5. Using the command prompt, browse to the fol lowing directory wi thinthe SAP Appl ication Server instal lation directory:

/usr/sap/SID/Instance_Number/j2ee/deployment/scripts/

The SIDand Instance_Number parameters are defined duringinstal lation and configuration of the SAP Appl ication Server. The portnumber above refers to the P4 port number. The defaul t port number is50004.

6. Type the fol lowing command and press Enter to deploy the WAR fi le:Deploy.bat

user_name:password@localhost:port_number path_to_war_file

The user name and password must have administrative access. Theport number above refers to the P4 port number. The defaul t portnumber is 50004.

7. Access NetWeaver web admin console using the fol lowing URL:

http://localhost:PortNumber/nwa

The PortNumber above refers to the J2EE engine port number. Thedefaul t port number is 50000.

8. Log in as an administrative user.

9. Go to Operation Management > Systems > Start & Stop .

Up grad e Gu id e


10. Select Java EE Applications.

11. Select the MicroStrategy JSP appl ication just deployed from the l ist.

12. Go to Application Details > Status > Start.

13. Select On all instances and Set "Started" as Initial State.


To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must map users or groupsto the admin securi ty role. This securi ty role is defined in the MicroStrategyJSP appl ication deployment, wi thin the web-j2ee-engine.xml fi le. Youcan modi fy this fi le to map users or groups to this admin securi ty role, orinclude users in the administrators user group.

Accessin g t h e Micr o St r at egy JSP ap p l icat io n s


You must have administrative priv ileges to access the MicroStrategy WebAdministrator or Mobile Server Administrator page. For more information, seeConfiguring administrative access to MicroStrategy JSP appl ications,page 228 .

To access the MicroStrategy Web Administrator or Mobile Server

Administrator page

1. Access the servlet by typing the fol lowing URL in a Web browser:


MachineName

Up grad e Gu id e


:PortNumber/MicroStrategy/servlet/mstrWebAdmin


MachineName

:

PortNumber

/MicroStrategyMobile/servlet/mstrWebAdmin

The servlet names at the end of the URLs listed above are case-sensitive. Use the correct case when typing the servlet name.

The login dialog box opens.

2. Speci fy a user name and password.




4. If you are deploying MicroStrategy Web (JSP), access theMicroStrategy Web Appl ication on SAP Web Server by speci fying thefol lowing URL in the Web browser:

http://

MachineName:PortNumber/MicroStrategy/servlet/mstrWeb

Up grad e Gu id e




Deploying with Tomcat (Windows)

This section provides information used to deploy and configureMicroStrategy JSP appl ications in a Tomcat-only environment. Forinformation on how to configure Tomcat to work with IIS, seeiishowto.html (Tomcat 6.0) in the Tomcat documentation. You can usethe steps below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP):

l Preconfiguration Information, page 230: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 232: Instructionsfor deploying, including step-by-step procedures.


This section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications on Tomcat on your machine.


If you have not instal led the Oracle JDK yet, download the fi le from thewebsi te. Be sure to instal l the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall the JDK. If you install the JDK to a simple folder path such as C:\setting the system variable is easier and more likely to be correct.


The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these products issubject to change. Refer to the appropriate Microsoft documentation for stepsto access and modify the environment variables.

Up grad e Gu id e



1. From the Start menu, go to Computer > System properties >Advanced system settings > Environment Variables > SystemVariables.

2. Under , cl ick New to create a system variable.

3. In the Variable Name field, type JAVA_HOME .

4. In the Variable Value field, type the path of the folder where youinstal led the JDK and cl ick OK .

For example, i f the ful ly qual i fied path to your JDK executable isC:\jdk1.6.0\bin\java.exe , the value of your JAVA_HOME variableis C:\jdk1.6.0 .

If you have installed JDK under the Program Files folder, typeProgra~1 when specify ing the folder name in the Variable Value box;otherwise the system does not recognize the folder. For example, typeC:\Progra~1\jdk1.6.0 in the Variable Value box.

Co n f igu r in g To m cat

This procedure assumes that you have downloaded and instal led Tomcaton your machine. You can download Tomcat from the Apache websi te;depending on the version you want to download, you may need to locatethe appropriate fi le in Apache's Archive area. Instructions for downloadingand instal l ing Tomcat are also avai lable on the Apache websi te.

To configure Tomcat, a system variable must point to the folder where youinstal l Tomcat. Instal l ing Tomcat to a simple folder path such asC:\Tomcat makes i t easier to define the system variable.

The third-party products discussed below are manufactured by vendorsindependent of MicroStrategy, and the steps to configure these products issubject to change. Refer to the appropriate Microsoft documentation for stepsto access and modify the environment variables.

Up grad e Gu id e


1. From the Start menu, go to Computer > System properties >Advanced system settings > Environment Variables > SystemVariables.

2. Cl ick New to create a system variable.

3. In the Variable Name field, type CATALINA_HOME .

4. In the Variable Value field, speci fy the path of the folder where youinstal led Tomcat and cl ick OK . For example, i f you instal led Tomcatdirectly to the C drive, the destination folder is C:\Tomcat .

If you installed Tomcat under the Program Files folder, type Progra~1when specify ing the folder in the Variable Value box. Otherwise, the systemdoes not recognize the folder. For example, type C:\Progra~1\Tomcat inthe Variable Value box.

Set t in g t h e Java h eap size

The Java heap size for the Tomcat can be modi fied by defining the JAVA_

OPTS parameter in the catalina.bat fi le. For example, you can definethis parameter as fol lows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Java heapsize for your environment.


Assuming you have made al l the necessary configurations described above,you can begin deploying MicroStrategy Web (JSP), Mobi le Server (JSP)(JSP) wi th Tomcat.

Up grad e Gu id e


Dep lo yin g u sin g To m cat as a st an d -alo n e Web co n t ain er

To deploy MicroStrategy JSP applications using Tomcat as a stand-

alone Web container


2. Copy the WAR fi le to the Tomcat\webapps folder.

3. From the Start menu, select Run .

4. Type cmd in the Open drop-down l ist and cl ick OK .

5. Browse to the Tomcat\bin folder, where Tomcat is the folder inwhich you instal led Tomcat. For example, in the command prompt, type

cd C:\Tomcat\bin

6. Cl ick Enter. C:\Tomcat\bin> is displayed at the command prompt.

7. Type the required commands to start and stop Tomcat, which dependson your version of Tomcat. For example, for Tomcat 7, type Tomcat7

start to start Tomcat and type Tomcat7 stop to stop Tomcat. Referto your thi rd-party Apache documentation for information on thecommands to start and stop Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1when you change folders in the command prompt. Otherwise, the system doesnot recognize the folder. For example, type C:\Progra~1\Tomcat\bin inthe command prompt.

Your MicroStrategy JSP appl ication is deployed automatical ly, based onthe fol lowing:

l If you have configured Tomcat to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within theTomcat\webapps folder:

Up grad e Gu id e




l If you have configured Tomcat to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Windows systems, the temporary fi le di rectory is commonlydefined by the TMP environment variable:




Co n f igu r in g ad m in ist r at ive access yo u r Micr o St r at egy JSP ap p l icat io n s

To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the Tomcat user configuration fi le. Thesteps to configure this access are below.

Up grad e Gu id e


To configure administrative access to your MicroStrategy JSP

applications

1. In the Tomcat\conf folder, open the tomcat-users.xml fi le in aprogram that al lows you to edi t the fi le, such as Notepad.

2. Add the fol lowing tag and save the fi le:

<user name="administrator" password="administrator"

roles="admin"/>

You can specify any value in the user name and password fields.

3. Stop and start Tomcat from the command l ine.







localhost


The servlet names at the end of the URL are case-sensi tive. Make sureto use the correct case when typing the servlet name. If the appl icationserver is enabled with securi ty, a dialog box related to theadministrator authentication opens.

Up grad e Gu id e


If you are using Tomcat integrated with IIS, you do not need to speci fythe port number in the URL. However, when using Tomcat as a stand-alone Web container, you must speci fy the port number. The defaul tport for Tomcat is 8080.

2. When prompted for a user name and password, use the same valuesyou speci fied in the tomcat-users.xml fi le.

3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy WebAdministrator page appears. Add and connect to an Intel l igenceServer.

4. If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications tocommunicate with Mobi le Server and Intel l igence Server. For steps onhow to define this configuration, see the MicroStrategy Mobi leAdministration Guide. Creating a configuration completes the stepsrequired to deploy Mobi le Server (JSP).

Lau n ch in g t h e p r o ject

In a Web browser, access MicroStrategy Web (JSP) using this URL:


Deploying with Oracle Glassfish Server (Solaris)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on an Oracle Glassfish Server 3.1.x in aLinux environment. You can use the steps below to deploy MicroStrategyWeb (JSP) and MicroStrategy Mobi le Server (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 237: Instructionsfor deploying MicroStrategy Web (JSP), Mobi le Server (JSP).

Up grad e Gu id e




l Undeploying MicroStrategy JSP Appl ications, page 246: Instructions forundeploying MicroStrategy JSP appl ications.


Once your machine has been configured, you can deploy MicroStrategyWeb (JSP, Mobi le Server (JSP) (JSP) with Oracle Glassfish Server 3.1.x.

The administration and deployment tools in Oracle Glassfish Server have thesame interface regardless of the operating system on which they run.Therefore, the deployment process is the same for all operating systems, andis described below. There are some minor changes in the Windowsenvironment, which are highlighted where necessary.

Lau n ch in g t h e Or acle Glassf ish Ser ver Ad m in ist r at io n Co n so le

This procedure describes the steps to launch the Oracle Glassfish Server.

The Oracle Glassfish Server is installed. This installation should also include adefault domain, commonly named domain1 . If you plan to use a differentdomain, refer to your third-party Oracle documentation for creating a domain.

Copy the WAR file for your MicroStrategy JSP application to the same machine asthe Oracle Glassfish Server, or to a location that is accessible to the OracleGlassfish Server machine.

To launch the Oracle Glassfish Server Administration Console

1. Navigate to the fol lowing directory in the command prompt:InstallDir/bin

where InstallDir is the directory where you instal led OracleGlassfish Server.

Up grad e Gu id e


2. Type the fol lowing command to start the domain:

asadmin start-domain --domaindir

DomainDirectoryDomainName

where:

l DomainDirectory is the path you defined when creating thedomain. You can remove the --domaindir option i f the domainuses the defaul t di rectory.

l DomainName is the name of the domain you created in the previoussteps.

For example, to start domain1, which is the defaul t domain, type thefol lowing command:

asadmin start-domain domain1

3. Access the Oracle Glassfish Server Administration Console by typingthe fol lowing URL:http://MachineName:PortNumber

where:

l MachineName is the IP address or the name of the machine whereyou instal led Oracle Glassfish Server.

l PortNumber is the port number you provided when creating thedomain. The defaul t port number is 4848.

4. If prompted, type the user name and password that you provided whencreating the domain.

Dep lo yin g yo u r Micr o St r at egy JSP ap p l icat io n

After launching the Oracle Glassfish Server Administration Console, fol lowthe steps below to deploy MicroStrategy JSP appl ications as a WAR fi le.

Save the WAR file to the same machine as the Oracle Glassfish Server, or to a

Up grad e Gu id e


location that is accessible to the Oracle Glassfish Server machine.

Access to the administrative pages for MicroStrategy Web (JSP) and MobileServer (JSP) can be granted by using the admin security role and the associatedmstradmin group. Granting this access to users can be done within the OracleGlassfish Server Administration Console after deploying the WAR file. While thisdefault behavior supports most deployment requirements, if you have specificsecurity requirements for your system, you must modify the security role detailsprior to deploying the WAR file, as described in Deploying MicroStrategy Weband Mobi le Server, page 237 .

To deploy MicroStrategy JSP applications as a WAR file

1. Access the Administration Console by typing the fol lowing URL:

http://MachineName:PortNumber

where:

l MachineName is the IP address or the name of the machine whereyou instal led Oracle Glassfish Server.

l PortNumber is the port number you provided when creating thedomain. The defaul t port number is 4848.

2. If prompted, type the user name and password that you used to createthe domain.

3. Expand theTree pane on the left side of the Administration Console.

4. Cl ick Applications.

5. Cl ick Deploy.

6. Select Local Packaged File or Directory That Is Accessible fromGlassFish Server, and then cl ick Browse Files.

Up grad e Gu id e


Selecting the WAR file in this manner is recommended as the PackagedFile to Be Uploaded to the Server option uploads the WAR file via HTTP,which can require considerable time and system resources.

7. Browse to the location where you saved the MicroStrategy JSPappl ication WAR fi le.

8. Once you select the appropriate WAR fi le, cl ick Choose File.

9. From the Type drop-down l ist, select Web Application .

10. In the Context Root field, type the context root for the appl ication,which is included in various URLs for the appl ication:

l The URL to access MicroStrategy Web (JSP)(http://

IPAddress:PortNumber/ContextRoot/servlet/mstrWeb)

includes the appl ications context root, which should be replaced byany name of your choice. For example, you can use the defaul t nameof the WAR fi le, which is MicroStrategy .

l The URL to access the MicroStrategy Mobi le Server AdministratorPage(http://


/ContextRoot/servlet/mstrWebAdmin) includes theappl ications context root, which should be replaced by any name ofyour choice. For example, you can use the defaul t name of the WARfi le, which is MicroStrategyMobile .

11. In the Application Name field, type a descriptive name to distinguishthe appl ication from within the Administration Console.

12. In the Virtual Servers l ist, select the appropriate server.

Up grad e Gu id e


13. Select or clear the addi tional deployment option check boxesaccording to your requirements.

It is recommended you select the Precompile JSPs check box to quicklyload the Web pages in the application server when you access it for thefirst time.

14. Cl ick OK .


For securi ty purposes, you must only assign certain users theadministrative authorization to access the MicroStrategy Web Administrator,Mobi le Server Administrator. To do this, users need to be assigned to themstradmin group, which is part of the admin securi ty role.

Oracle Glassfish Server supports the fol lowing authentication realms out-of-the-box:

l Fi le realm

l Administration realm

l Certi ficate realm

A realm, also called a security policy domain or security domain, is a scopeover which a common security policy is defined and enforced by the securityadministrator of the security service. For more information, see the followingresource:

http://docs.oracle.com/cd/E18930_01/html/821-2435/ggkuk.html#gkbiy

In Oracle Glassfish Server, the fi le realm is the defaul t realm. Forcontrol l ing access to the Administration pages, you can create users anduser groups and assign the mstradmin group to users in your securi tyrealm.

Up grad e Gu id e

http://docs.oracle.com/cd/E18930_01/html/821-2435/ggkuk.html#gkbiy


To create users that are assigned to the mstradmin group in the file

realm

1. In the Administration Console, from the Tree pane on the left, cl ickserver (Admin Server). Ensure that the server is running or cl ick Startto start the server.

2. From the Tree pane on the left, go to Configuration > server-config >Security > Realms and select file..

3. Cl ick Manage Users.

4. Cl ick New.

5. Type the fol lowing information for the new user:

l User ID : The ID that the user provides when authenticating with thesystem.

l Group List: The groups that the user is a member of. Typemstradmin to provide the user administrative access toMicroStrategy Web Administrator and MicroStrategy Mobi le ServerAdministrator.

l New Password : The password used to authenticate a user.

l Confirm New Password : A confi rmation of the password, requiredwhen creating a new user.

6. Cl ick OK .

7. In the Administration Console, from the Tree pane on the left, selectserver (Admin Server).

8. Cl ick Restart.

Up grad e Gu id e


Managing the admin security role for specialized groupauthentication requirementsMicroStrategy provides a descriptor fi le, glassfish-web.xml , whichenables Oracle Glassfish Server to map the existing users or groups tosecuri ty roles. This fi le is located within the MicroStrategy JSP appl icationWAR fi les, and after deployment can be found in theWebApplicationRootDir/WEB-INF folder.

By defaul t, the admin securi ty role and i ts mstradmin group defined inthis glassfish-web.xml fi le can be used to grant administrative accessto the MicroStrategy Web Administrator and Mobi le Server Administrator.This provides administrative access without having to make anymodi fications to glassfish-web.xml . In these scenarios, you can usethe steps provided in Deploying your MicroStrategy JSP appl ication, page238 and Configuring administrative access to MicroStrategy JSPappl ications, page 241 to complete the deployment and authenticationrequirements.

Whi le this defaul t behavior supports most deployment requirements, youcan modi fy this glassfish-web.xml fi le i f you have special ized groupauthentication requirements to use a group other than the defaul tmstradmin group defined for the admin securi ty role. Any groups that areused must be included as part of the admin securi ty role.

Any changes made to the glassfish-web.xml file must be done prior todeploying the MicroStrategy JSP application.

The contents of this fi le are as fol lows, which may di ffer depending on yourinstal lation of Oracle Glassfish Server:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD

GlassFish Application Server 3.1 Servlet 3.0//EN"

"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">

<glassfish-web-app>

Up grad e Gu id e


<security-role-mapping>

<role-name>admin</role-name>

<group-name>mstradmin</group-name>

</security-role-mapping>

</glassfish-web-app>

Once you make any changes to this fi le, you must deploy the appl ication(see Deploying your MicroStrategy JSP appl ication, page 238) and assignthe securi ty role to the necessary user accounts (see Configuringadministrative access to MicroStrategy JSP appl ications, page 241).



To access the MicroStrategy JSP application administrative page



IPAddress

:PortNumber/ContextRootWeb/servlet/mstrWebAdmin

In the URL l isted above, ContextRootWeb is the name youprovided for the ContextRoot for Web Module box in the sectionDeploying your MicroStrategy JSP appl ication, page 238. Forexample, you can use the defaul t name of the WAR fi le, which isMicroStrategy . The defaul t port number is 8080.


IPAddress

:PortNumber/ContextRootMobile/servlet/mstrWebAdmin

Up grad e Gu id e


In the URL l isted above, ContextRootMobile is the name youprovided for the ContextRoot for Web Module box in the sectionDeploying your MicroStrategy JSP appl ication, page 238. Forexample, you can use the defaul t name of the WAR fi le, which isMicroStrategyMobile . The defaul t port number is 8080.

The servlet names are case-sensitive. Use the correct case when typingthe mstrWebAdmin name. If the application server is enabled withsecurity, a dialog box related to the administrator authentication opens.

2. Type the user ID and password for a user who is a member of themstradmin group, as described in Configuring administrative access toMicroStrategy JSP appl ications, page 241.




4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy project. For more information, see Connecting to theWeb (JSP) project page, page 245 immediately below.

Co n n ect in g t o t h e Web (JSP) p r o ject p age

After restarting the appl ication server, fol low the steps described here toconnect to the project page.

Up grad e Gu id e




To connect to the Web (JSP) project page

In a Web browser, type the fol lowing URL:

http://MachineName:PortNumber/ContextRoot

If you have used al l the defaul t values, you can access the fol lowing URLs:

http://localhost:8080/MicroStrategy/

or


Undeploying MicroStrategy JSP Applications

Oracle recommends undeploying an appl ication before deploying a newerversion. The steps below show you how to undeploy an existingMicroStrategy JSP appl ication, using the Oracle Glassfish ServerAdministration Console.

To u n d ep lo y Micr o St r at egy JSP ap p l icat io n s

1. In the Administration Console, from the Tree pane on the left, cl ickApplications. The Appl ications page is displayed.

2. Select the check box for the MicroStrategy JSP appl ication.

3. Cl ick Undeploy.

4. After the undeployment is finished, stop and restart the appl icationserver for the changes to take effect.

Deploying with WebLogic and Apache (Solaris)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on the Oracle Solaris operating system,using Apache as the Web server and Oracle WebLogic Server as theappl ication server. It provides information for WebLogic 12.2.1.3. You can

Up grad e Gu id e


also the steps below to deploy MicroStrategy Web (JSP) and MicroStrategyMobi le Server (JSP).

This section includes the fol lowing information:

l WebLogic Paths and Folder Locations, page 247: Defaul t folder structurefor each version of WebLogic

l Preconfiguration Information, page 248: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP) and Mobi le Server(JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 249: Instructionsfor deploying the appl ication

l Re-deploy the Appl ication, page 259: Instructions for re-deploying theappl ication

l Performance-Based Setup Information, page 259: Optional configurationsettings to increase the appl ication's performance.

The additional configuration steps are not required for MicroStrategy Web(JSP) to run, but these settings can increase its performance. Review theperformance-based setup information prior to deploying the system to see ifthese changes are of interest to you.

WebLogic Paths and Folder Locations

This section presents the defaul t folder structure for each version ofWebLogic, and provides the variable used throughout the rest of thischapter to represent the WebLogic mydomain folder path.

Each version of WebLogic is instal led with a di fferent defaul t path to theWebLogic mydomain folder. When deploying MicroStrategy Web (JSP), youmust make some changes within the WebLogic folders. Thus, i t is importantto understand the WebLogic folder structure for the version of WebLogicyou are using. The fol lowing path reflects the defaul t folder structure for

Up grad e Gu id e


WebLogic 12.2.1.3: WEBLOGIC_HOME/user_projects/domains/mydomain/

l WEBLOGIC_HOME is the WebLogic Server home path.

l The folder structures are configurable and your organization may havechanged the default names or path.

Throughout this chapter, the WebLogic mydomain folder is referred to asWEBLOGIC_MYDOMAIN_FOLDER . This variable refers to the WebLogicmydomain folder in whatever location i t resides on your system. Thelocation of this variable is based on the version of WebLogic and whetheryour organization has changed the version's defaul t name or path.


This section provides the preconfiguration information necessary to deployyour MicroStrategy JSP appl ications on your machine.

This section supports the configuration outl ined in the fol lowing table.Whi le your setup may vary sl ightly, for example, you may have di fferentversions of these appl ications, the overal l process remains the same.

Requirement Recommended

Operat ing system Oracle Solaris 10.x or 11.x (on SPARC)

Web server Apache 2.x

Applicat ion server WebLogic 12.2.1.3

JDKOracle JDK 1.6.0 or 1.7.0

You can download the JDK here.

For information on the version numbers supported or certified byMicroStrategy, see the MicroStrategy Readme .

Up grad e Gu id e



For information on installing these products, seehttp://www.oracle.com/technology/products/weblogic/i

ntegration/index.html

Before you start the deployment process, locate the machine name and IPaddress.

Set t in g u p Ap ach e Web Ser ver t o Pr o xy Req u est s t o Web Lo gic

You can have the Apache Web server and WebLogic Server runningindependently on the same machine, but to configure Apache to proxy thedesired requests to the WebLogic Server, you must instal l a plug-inprovided by WebLogic. Complete the instructions at the fol lowing URLs toinstal l and configure the plug-in.

For WebLogic 12.2.1.3, the URL is:

https://docs.oracle.com/middleware/12213/webtier/develop-plugin/overview.htm#PLGWL391

Instal l the plug-in wi th the WebLogic instal lation in the fol lowing location:

WEBLOGIC_HOME/wlserver_10.3/server/plugin/solaris/sparc/

where WEBLOGIC_HOME is the path to the WebLogic Server.

To increase the performance of MicroStrategy Web (JSP), you can completeadditional setup configurations before the deployment. For more information,see Performance-Based Setup Information, page 259 .


When your machine has been configured with the necessary settings, youcan deploy the JSP version of MicroStrategy Web and Mobi le Server wi thApache and WebLogic.

The Performance-Based Setup Information, page 259 section providesinformation on additional settings to increase application performance. These

Up grad e Gu id e

http://www.oracle.com/technology/products/weblogic/integration/index.html

http://www.oracle.com/technology/products/weblogic/integration/index.html

http://e-docs.bea.com/wls/docs100/plugins/apache.html

http://e-docs.bea.com/wls/docs100/plugins/apache.html


additional settings are not required but can increase the performance ofMicroStrategy Web (JSP). Review this information prior to deployment to seeif these options are of interest to you.

You can deploy MicroStrategy Web and Mobi le Server using one of thefol lowing deployment methods:

l The automatic deployment feature is the easiest and fastest way. SeeDeploying automatical ly (development mode), page 250. Choose thedevelopment mode in the /WEBLOGIC_MYDOMAIN_FOLDER/bin/startWebLogic.sh fi le, wi thin the WebLogic Serverfolder structure.

l The manual deployment feature can be used for environments where theserver is running in production mode and the automatic deployment isturned OFF. For more information, see Deploying manual ly (productionmode), page 253.

Dep lo yin g au t o m at ical ly (d evelo p m en t m o d e)

When automatic deployment is set to ON, as soon as you place a WAR fi lein the /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy folder, theappl ication is automatical ly deployed.

With this method you can deploy from:

l A dupl icate WAR fi le. When you deploy from a dupl icate WAR fi le, youare required to manual ly configure the web.xml fi le wi thin the WAR fi leto al low access to certain folders. Once this configuration is complete andthe WAR fi le is recompi led, the JSP appl ication can be deployed usingthe single WAR fi le.

l An exploded directory where al l the fi les contained in the WAR fi le wereextracted. When you deploy from an exploded directory, al l of the fi lesand folders wi thin the WAR fi le are exposed to WebLogic. This al lowsWebLogic access to the required folders so that i t can make anynecessary configuration changes to fi les in the exploded directory.

Up grad e Gu id e


To automatically deploy MicroStrategy JSP applications from a

duplicate WAR file


2. [Optional ] Rename the WAR fi le to a name you can easi ly identi fy andremember. This name is the context_name used in the uni formresource locator (URL) to access the fi le.

If you do not change the name of the file, remember to replace context_name with MicroStrategy when accessing the application from the URL.

To modi fy the web.xml fi le for mul tiple MicroStrategy deployments

If you are deploying more than one MicroStrategy environments on thesame WebLogic appl ication server, prior to deployment, you must modi fythe web.xml fi le as described below.

1. Unzip the WAR fi le by using the fol lowing command:

jar -xvf FileName.war

Where FileName is the name of the WAR fi le for your MicroStrategyJSP appl ication.

2. Open the web.xml fi le located in the /WEB-INF directory.

3. Modi fy the contextPath parameter. By defaul t, this parameter doesnot have a value. Type a unique string for the value of thecontextPath parameter. For example, type WebDep2 .

4. Save the web.xml fi le.

5. Zip the WAR fi le by using the fol lowing command:

jar -cvf FileName.war *

Where FileName is the name of the WAR fi le for your MicroStrategyJSP appl ication

Up grad e Gu id e


To deploy the WAR fi le

1. Transfer the WAR fi le to the fol lowing directory:

/WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

2. The appl ication is automatical ly deployed. To add and connect to anIntel l igence Server, see Configuring administrative access toMicroStrategy JSP appl ications, page 256.

To increase the performance of MicroStrategy Web JSP, you canconfigure additional settings after deployment. For more information, seePerformance-Based Setup Information, page 259 .

To automatically deploy MicroStrategy JSP applications from an

exploded directory

The WAR file must be uncompressed by the same user who started theapplication.


2. Create the fol lowing new folder:/home/username/context_folder

where username is your account name used to access the Web servermachine, and context_folder is the name of the new folder.

You can create the new folder anywhere except in the following location:

/WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

3. Copy the WAR fi le to the new folder.

4. To explode the WAR fi le inside the folder you created, run thefol lowing command:

# jar -xvf FileName.war

Up grad e Gu id e



5. Delete the WAR fi le by using the fol lowing command:

# rm FileName.war


6. Move the folder to the autodeploy folder wi th the fol lowingcommands:

# cd..

# mv context_folder /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy

The appl ication is automatical ly deployed. To add and connect to anIntel l igence Server, see Configuring administrative access to MicroStrategyJSP appl ications, page 256.

To increase the performance of MicroStrategy Web (JSP), you can configureadditional settings after deployment. For more information, see Performance-Based Setup Information, page 259 .

Dep lo yin g m an u al ly (p r o d u ct io n m o d e)

With manual deployment you can deploy MicroStrategy JSP appl icationsfrom:

l A dupl icate WAR fi le. When you deploy from a dupl icate WAR fi le, youare required to manual ly configure the web.xml fi le wi thin the WAR fi leto al low access to certain folders. Once this configuration is complete andthe WAR fi le is recompi led, the JSP appl ication can be deployed usingthe single WAR fi le.

l An exploded directory where al l the fi les contained in the WAR fi le wereextracted. When you deploy from an exploded directory, al l of the fi lesand folders wi thin the WAR fi le are exposed to WebLogic. This al lows

Up grad e Gu id e


WebLogic to access the required folders to perform any necessaryconfigurations to fi les in the exploded directory.

Perform the deployment in the /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy directory.

To manually deploy MicroStrategy JSP applications from a duplicate

WAR file


If you are deploying more than one MicroStrategy environment on thesame WebLogic appl ication server, prior to deployment, you mustmodi fy the web.xml fi le

2. Unzip the WAR fi le by using the fol lowing command:#jar -xvf FileName.war

Where FileName i s the name of the WAR fi le for your MicroStrategy JSP application.

3. Open the web.xml fi le located in the /WEB-INF directory.

4. Modi fy the contextPath parameter. By defaul t, this parameter doesnot have a value. Type a unique string for the value of thecontextPath parameter. For example, type WebDep2 .

5. Save the web.xml fi le.

6. Zip the WAR fi le by using the fol lowing command:#jar -cvf FileName.war *


7. Transfer the WAR fi le to the /WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy directory.

8. Open the WebLogic Server Administration Console (WLS AdminConsole) by typing the fol lowing address:

http://IP address:port/console/

Up grad e Gu id e


where IP address is the IP address of the machine on which youinstal led the WebLogic appl ication server and port is the port numberfor the WebLogic appl ication server.

9. Type a val id user ID and password at the prompt. The user ID andpassword are the ones you speci fied when instal l ing the WebLogicServer on your machine.

10. To complete this operation, see Configuring from the WebLogic ServerAdministration Console , page 256.

To manually deploy MicroStrategy JSP applications from the exploded

directory


2. Create a folder in the /WEBLOGIC_MYDOMAIN_FOLDER/autodeploy

directory and transfer the WAR fi le to this directory.

3. Unzip the WAR fi le using the fol lowing command:

#jar -xvf FileName.war

Where FileName is the name of the WAR fi le for yourMicroStrategy JSP appl ication.

4. Open the WebLogic Server Administration Console by accessing thefol lowing address:

http://IP address:Port/console/

where IP address is the IP address of the machine on which you installedthe WebLogic application server and Port is the port number for the WebLogicapplication server.

5. Type a val id user ID and password at the prompt. The user ID andpassword are the ones you speci fied when instal l ing the WebLogicServer on your machine.

Up grad e Gu id e


Configuring from the WebLogic Server AdministrationConsoleTo configure from the WebLogic Server Administration Console, refer toyour WebLogic Server Administration Console documentation on steps toinstal l a web appl ication.

Once you have instal led the JSP version of MicroStrategy Web and Mobi leServer as a WebLogic Server Administration Console web appl ication, youhave completed the steps required to deploy the appl ication.

To launch the administrative page for MicroStrategy Web (JSP), Mobi leServer (JSP) (JSP), see Configuring administrative access to MicroStrategyJSP appl ications, page 256.

To increase the performance of MicroStrategy Web (JSP), you can configureadditional settings after deployment. For more information, see Performance-Based Setup Information, page 259 .


Before you start MicroStrategy Web (JSP), Mobi le Server (JSP) (JSP), youmust configure their administrator pages.

To configure access to the MicroStrategy JSP applications

1. The fol lowing table l ists the URL to access MicroStrategy WebAdministrator and MicroStrategy Mobi le Server Administrator, for eachdeployment method.

The servlet names are case-sensi tive. Make sure to use the correctcase when typing the mstrWebAdmin name.

If the appl ication server is enabled with securi ty, a dialog box relatedto the administrator authentication opens.

Up grad e Gu id e


DeploymentMethod

Address

Automat icdeployment

Access the Administ rator page from a web browser using this URL:

• For Web (JSP): http://IPaddress:7001/context_folder_Web/servlet/mstrWebAdmin

In the URL listed above, context_folder_Web is the name of the folderwhere the Web (JSP) application was exploded and IPaddress is the IP address ofyour machine.

• For Mobile Server (JSP): http://IPaddress:7001/context_folder_Mobile/servlet/mstrWebAdmin

In the URL listed above, context_folder_Mobile is the name of thefolder where the Mobile Server application was exploded and IPaddress is the IPaddress of your machine.

Manualdeployment

Access the Administ rator page from a browser using this address:

• For Web (JSP): http://IPaddress:7001/Web_name/servlet/mstrWebAdmin

In the URL listed above, IPaddress is the IP address of your machine. Replacethe Web_name var iable with the name you specified in the deployed name fieldwhen configur ing Web (JSP) from WebLogic Server Administration Console, forexample, MyWebApp .

• For Mobile Server (JSP): http://IPaddress:7001/Mobile_name/servlet/mstrWebAdmin

In the URL listed above, IPaddress is the IP address of your machine. Replacethe Mobile_name var iable with the name you specified in the deployed namefield when configur ing Mobile Server from WebLogic Server Administration Console,for example, MyMobileApp .

2. Type the same user ID and password that was used to start theWebLogic Server on your machine.

In WebLogic, the deployment of a MicroStrategy JSP appl icationautomatical ly associates the WebLogic administrative user wi th theMicroStrategy JSP appl ication administrator. The WebLogicadministrative user is the user who has permissions to start theWebLogic Server on a given machine.

Up grad e Gu id e


3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy WebAdministrator page appears. Add and connect to an Intel l igenceServer.

4. If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications tocommunicate with Mobi le Server and Intel l igence Server. For steps onhow to define this configuration, see the MicroStrategy Mobi leAdministration Guide. Creating a configuration completes the stepsrequired to deploy Mobi le Server (JSP).


The address to launch MicroStrategy Web (JSP) is di fferent for eachdeployment method. The table below l ists the URL you can use to accessMicroStrategy Web (JSP).

DeploymentMethod

Address

Automat icdeployment

Access MicroStrategy Web (JSP) from a web browser using this URL:

http://IPaddress:7001/context_folder/servlet/mstrWeb

where context_folder is the name of the folder where the applicat ion wasexploded and IPaddress is the IP address of your machine.

Manualdeployment

Access MicroStrategy Web (JSP) from a browser using the address:

http://IPaddress/name/servlet/mstrWeb

where IPaddress is the IP address of your machine. Replace the name

variable with the name you specif ied in the deployed name f ield whenconf iguring from WebLogic Server Administ rat ion Console, for example,MyWebApp.

Up grad e Gu id e




Re-deploy the Application

If you have already deployed MicroStrategy Web (JSP) with WebLogic andyou change any parameters in the web.xml fi le, you must re-deploy theappl ication using the WebLogic Server Administration Console. This al lowsthe changes to take effect in the deployed appl ication. To re-deployMicroStrategy Web (JSP), refer to your WebLogic Server AdministrationConsole documentation on steps to re-deploy (update) a web appl ication.

Performance-Based Setup Information

The performance of MicroStrategy Web (JSP) can be increased byconfiguring i t on various component levels. These addi tional setup settingsare not required, but i f you want to increase the performance ofMicroStrategy Web (JSP), some changes must be done before or after thedeployment procedure. This section provides the fol lowing configurations:

Set t in g t h e Java Heap Size

The Java heap size for the WebLogic Server can be increased by modi fyingthe MEM_ARGS variable in the startWebLogic.sh script:

1. Open the startWebLogic.sh script from /WEBLOGIC_MYDOMAIN_

FOLDER/bin/startWebLogic.sh .

2. Define the fol lowing l ine in the script:MEM_ARGS="-Xms512m -Xmx1024m"

This l ine reflects an ini tial Java heap size of 512 MB. MicroStrategyrecommends the ini tial java heap size be set at a minimum of 512 MB,assuming the machine has enough memory space. This value mayneed to be modi fied to reflect the requirements of your speci ficenvironment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Javaheap size for your environment.

3. Stop and start the appl ication server.

Up grad e Gu id e


Pr eco m p i l in g JSP Fi les

To avoid the time taken to load the Web pages in the appl ication serverwhen you access i t for the fi rst time, you must precompi le the Java ServerPages (JSP) fi les before deploying the appl ication. Do this by setting theappl ication server to load al l the pages in the appl ication beforedeployment. Thus, when you connect for the fi rst time, the pages arealready loaded and the performance is better.

1. Open the weblogic.xml fi le located in the /WEB-INF directory.

2. In the jsp-descriptor section, set the keepgenerated and theprecompile parameters to TRUE, as fol lows:

<jsp-descriptor>

:

:

<jsp-param>

<param-name>keepgenerated</param-name>

<param-value>TRUE</param-value>

</jsp-param>

<jsp-param>

<param-name>precompile</param-name>

<param-value>TRUE</param-value>

</jsp-param>

:

:

</jsp-descriptor>

3. Save the fi le.

Disab le/ Relax Au t o -Relo ad Par am et er s

To disable/relax auto-reload parameters, complete the fol lowing steps.

Set the pageCheckSeconds ParameterThe pageCheckSeconds parameter sets the interval , in seconds, at whichthe WebLogic Server checks to see i f JSP fi les have changed and needrecompi l ing. Dependencies are also checked and recursively reloaded i fchanged.

Up grad e Gu id e


You can set the fol lowing values:

Value Description

0 Pages are checked on every request .

-1The page is not checked unt i l the server is restarted. Any classes usedby the JSP page that l ive in the servlet classpath are also reloaded.

n

Interval (in seconds) in which WebLogic Server checks if JSP f i leshave changed. For example, if this is set to 1, WebLogic checks thepages every second to see if the JSP has changed and needsrecompil ing.

To Set the pageCheckSeconds Parameter


2. In the jsp-descriptor section, set the pageCheckSeconds

parameter value. For example, the fol lowing code sets the value to -1:

<jsp-descriptor>

:

:

<jsp-param>

<param-name>pageCheckSeconds

</param-name>

<param-value>-1</param-value>

</jsp-param>

:

:

</jsp-descriptor>

3. Save the fi le.

Set the WebLogic Reload Period ParameterIn WebLogic, the Reload Period parameter sets how often WebLogic checkswhether a servlet has been modi fied. If the servlet has been modi fied,WebLogic reloads i t. As the MicroStrategy Web (JSP) servlets do not

Up grad e Gu id e


change after they have been deployed, MicroStrategy recommends that youdisable the reload period by setting i t to -1. A value of -1 means neverreload, and a value of 0 means always reload.

Use the appropriate procedure below, depending on whether you haveMicroStrategy Web (JSP) deployed as a dupl icate WAR fi le.

To Set the WebLogic Reload Period


2. In the container-descriptor section, set the servlet-reload-

check-secs parameter value. For example, the fol lowing code setsthe value to -1:<container-descriptor>

<servlet-reload-check-secs>-1</servlet-reload-check-

secs>

</container-descriptor>

3. Save the fi le.

Co n f igu r in g Ap ach e Web Ser ver t o Ser ve St at ic Fi les

Because Web servers are tuned to effectively serve static fi les, theperceived performance of MicroStrategy Web (JSP) is signi ficantlyenhanced i f image, style sheet, and JavaScript fi les are served via theApache Web server, and the WebLogic Server handles only the servletrequests. Do this by edi ting two main parameters, Alias andMatchExpression , in the Apache configuration fi le httpd.conf .

l The Alias parameter is used to create a virtual di rectory in the ApacheWeb server. The virtual di rectory is needed to serve static fi les such asimages, style sheets, and JavaScript.

l The MatchExpression parameter is used to configure the Apache plug-in so that the WebLogic Server handles only the servlet requests.

Up grad e Gu id e


To Configure the Apache Web Server to Serve Static Files

1. To change the Alias parameter, add the fol lowing l ines in thehttpd.conf fi le:Alias /MicroStrategy/images/"/WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy/MicroStrategy/images/"

<Directory "/WEBLOGIC_MYDOMAIN_

FOLDER/autodeploy/MicroStrategy/images">

Options Indexes MultiViews

AllowOverride None

Order allow, deny

Allow from all

</Directory>

These code excerpts assume the application name isMicroStrategy . See Deploying with WebLogic and Apache(Solaris), page 246 for information on default folder structure.

2. Repeat the previous step for the JavaScript and style sheet folders,replacing the word images in the previous code with the folder namewhere the JavaScript and style sheet fi les are located.

3. Change the MatchExpression parameter by typing */servlet/*

in the MatchExpression parameter. For example,<IfModule mod_weblogic.c>

WebLogicHost 10.15.133.56

WebLogicPort 7001

MatchExpression */servlet/*

</IfModule>

4. Stop and start the Apache Web server using the commandsapachectl start and apachectl stop .

The Web server now serves image (GIF), style sheet (CSS), JavaScript, andal l other static fi les, thus reducing the load on the appl ication server andincreasing the appl ication's performance.

Up grad e Gu id e


Deploying with WebSphere and IBM HTTP Server (AIX)

This section provides information used to deploy and configureMicroStrategy JSP appl ications on an AIX machine using the WebSphereServer and the IBM HTTP Web Server. You can use the steps below todeploy MicroStrategy Web (JSP) and MicroStrategy Mobi le Server (JSP).

This section includes the fol lowing information:


Once your machine has the necessary settings configured, you can deployMicroStrategy Web (JSP), Mobi le Server (JSP) (JSP) on the WebSpheremachine.

The Performance-Based Setup Information, page 272 section providesinformation on additional settings to increase application performance. Theseadditional settings are not required, but can increase the performance ofMicroStrategy Web (JSP).

Lau n ch in g t h e Web Sp h er e Ad m in ist r at ive Co n so le

The WebSphere Administrative Console can be accessed only i f theWebSphere server is started on the machine.

To start the Websphere Application Server

1. Execute the startServer script as fol lows:

cd WAS_HOME/bin

# ./startServer.sh SERVER_NAME

Typically, server1 is the default server name in WebSphere.

2. Ensure that the Administrative Server has started successful ly.Execute the fol lowing commands:

Up grad e Gu id e


cd WAS_HOME/bin

# ./serverStatus.sh -all

To launch the WebSphere Administrative Console

In a browser, type the URL for the administrative console. The URL is of thefol lowing form:

http://IP Address:Port/ibm/console

where IP Address is the IP address of the computer on which youinstal led the WebSphere appl ication server and Port is the port number forthe WebSphere Administrative Console. Refer to your thi rd-partyWebSphere documentation to confi rm the defaul t port number for theadministrative console.

St ar t in g t h e Web Sp h er e d efau l t ap p l icat io n ser ver

After you launch the WebSphere Administrative Console, you can deployMicroStrategy Web (JSP) by starting the defaul t appl ication server.

This is applicable for WebSphere Network Deployment Edition or WebSphereEnterprise Edition. For WebSphere Express or WebSphere Base Editions,there is no distinction between an administrative server and a default server.The StartServer.sh command starts the default application serverautomatically .

To start the default application server

When the WebSphere Administrative Console opens, a tree view isdisplayed.

1. Expand the Servers node, or cl ick the l ink to expand the view.

2. Cl ick the Applications Servers l ink.

Up grad e Gu id e


3. Select the box next to the appl ication server to start.

4. Cl ick Start.

In st al l in g t h e En t er p r ise Ap p l icat io n

To install the Enterprise Application

1. Expand Applications, and then Enterprise Applications to display al ist of instal led appl ications.

2. Cl ick Install.

Pr ep ar in g fo r t h e ap p l icat io n in st al lat io n

The fol lowing steps describe the settings that must be speci fied for theinstal lation.

Copy the WAR file for the MicroStrategy JSP placation to the WAS_HOME/installableApps directory, where WAS_HOME is the WebSphereapplication server home path.

To specify settings for the installation

1. To begin the instal lation for IBM WebSphere, go to Applications >Application Types > WebSphere enterprise applications.

2. Cl ick Install.

3. You must speci fy the path to the WAR fi le by selecting ei ther the localfi le system or remote fi le system option. For local fi le systems, you cancl ick browse to navigate to the location of the WAR fi le. For remote fi lesystems, type in the ful l path for the location of the WAR fi le.

4. Cl ick Next.

Up grad e Gu id e


5. Select to perform ei ther a Fast Path or Detailed instal lation. Ei thertype of instal lation can support the deployment of MicroStrategy JSPappl ications.

6. Select the Generate Default Binding check box, and ensure that theOverride existing bindings check box is cleared.

7. Cl ick Next.

8. Select the Precompile Java Server Pages files check box.

9. Speci fy the value for the Directory to Install Application as ${APP_

INSTALL_ROOT}/DefaultNode

10. Speci fy an Application Name of your choice.

11. Ensure that the Override class reloading settings for Web and EJBmodules check box is cleared.

12. Cl ick Next.

13. Select the Web Tier check box and cl ick Next.

14. Type a sui table name for ContextRoot , which is case-sensi tive. Donot include .war in the name for ContextRoot as this can causeerrors when attempting to start the appl ication.

The URLs to access MicroStrategy JSP applications containContextRoot , which should be replaced by the name of your choice.For example, MicroStrategy Web JSP uses the URLhttp://machine-name/ContextRoot/servlet/mstrWeb

and you can use the default name of the WAR file, which isMicroStrategy .

15. Cl ick Next.

16. Review the summary and cl ick Finish .

17. To grant access to these resources, map the admin role to the users

Up grad e Gu id e


or groups that wi l l be given the administrator privi leges for yourMicroStrategy JSP appl ication. To access these options inWebSphere, expand the Security options, and then cl ick GlobalSecurity.

Security must be enabled for the WebSphere Server for this feature towork.

Regen er at in g p lu gin -cfg.xm l

1. Expand Environment, and then cl ick Update global WebServer Plug-in configuration .

2. Cl ick OK , and then cl ick Save to master configuration .

Rest ar t in g t h e ap p l icat io n ser ver

This section explains how to stop and start the appl ication server.Performing these steps stops and starts al l the appl ications running on theappl ication server. To stop and start only the appl ication in which you areworking, see To start the Web module, page 269.

To restart the application server

The option to stop and start the application server through the administrativeconsole is available only for the Websphere Network Deployment andWebsphere Enterprise Editions. To stop and start the application server inWebsphere Express and Websphere Base editions, see below.

1. Expand Servers, and then cl ick the WebSphere Application Serversl ink.

2. Select the box next to the appl ication server you want to stop, andcl ick Stop .

3. Select the appl ication server you want to start and cl ick Start.

Up grad e Gu id e


To stop and start the appl ication server in Websphere Express andWebsphere Base edi tions, use the fol lowing commands:

l stopServer.sh server1 to stop the appl ication server

l startServer.sh server1 to start the appl ication server.

St ar t in g a sin gle JSP ap p l icat io n

This process starts only a single JSP appl ication, rather than al l theappl ications running on the appl ication server. To stop and start al lappl ications, see Restarting the appl ication server, above.

To start the Web module

1. Expand Applications, then expand Application Types, and thenselect WebSphere enterprise applications.

2. Select the box next to the appl ication to start and cl ick Start.


The administrative pages for your MicroStrategy JSP appl ications areaccessible only to users wi th an admin role. To create the set of users andpasswords that are authorized for this access, you must create thenecessary role mapping between these users and the admin role for theMicroStrategy JSP appl ication. The steps to perform this setup are givenabove in the section Preparing for the appl ication instal lation, page 266.For more information, refer to your IBM documentation.

Up grad e Gu id e


To configure administrative access to MicroStrategy JSP applications

1. Access the servlet by typing the fol lowing URL in a web browser:


IPAddress/ContextRootWeb/servlet/mstrWebAdmin

In the URL l isted above, ContextRootWeb is the name youprovided for the ContextRoot for Web Module box in the sectionPreparing for the appl ication instal lation, page 266. For example, thedefaul t name of the WAR fi le, which is MicroStrategy .


IPAddress/ContextRootMobile/servlet/mstrWebAdmin

In the URL l isted above, ContextRootMobile is the name youprovided for the ContextRoot for Web Module box in the sectionPreparing for the appl ication instal lation, page 266. For example, thedefaul t name of the WAR fi le, which is MicroStrategyMobile .

The servlet names are case-sensitive. Use the correct case whentyping the mstrWebAdmin name. If the application server is enabledwith security, a dialog box related to the administrator authenticationopens.

2. Type the user ID and password assigned with the admin role.

3. After you are authenticated, add and connect to an Intel l igence Server.

4. If you are deploying MicroStrategy Mobi le Server (JSP), theMicroStrategy Mobi le Server Administrator page appears. Add andconnect to an Intel l igence Server. Once connected, cl ick MobileConfiguration to configure your MicroStrategy Mobi le appl ications tocommunicate with Mobi le Server and Intel l igence Server. For steps on

Up grad e Gu id e


how to define this configuration, see the MicroStrategy Mobi leAdministration Guide. Creating a configuration completes the stepsrequired to deploy Mobi le Server (JSP).

5. If you are deploying MicroStrategy Web (JSP), proceed to launch theproject.


After configuring the MicroStrategy Web Administrator page, you mustfol low the steps described in this section to launch your project.

To launch the project

1. Start the Apache Web server by using the fol lowing command:

# /usr/HTTPServer/bin/apachectl start

For example, i f the IBM HTTP server is instal led in the defaul t location/usr/IBMIHS , then use the fol lowing command:

/usr/IBMIHS/bin/apachect1

2. In a Web browser, speci fy the fol lowing URL:

http://MachineName/ContextRoot/servlet/mstrWeb

Alternatively, you can use the IP address of your machine for remoteaccess, as shown below:

http://IPAddress/ContextRoot/servlet/mstrWeb

In these addresses, ContextRoot is the name you provided for thecontext root for Web Module box on Preparing for the applicationinstallation page. For example, the default name of the WAR file, which isMicroStrategy . For more information, refer to Preparing for theappl ication instal lation, page 266 .

You can now access the MicroStrategy Web (JSP) appl ication.

Up grad e Gu id e




Un in st al l in g Micr o St r at egy JSP ap p l icat io n s

You can uninstal l the MicroStrategy JSP appl ications through theWebSphere Administrative console.

1. Go to Applications > Application Types > WebSphere enterpriseapplications.

2. Select the desired MicroStrategy JSP appl ication.

3. Cl ick Uninstall.

4. Save the configuration in the master reposi tory.

Performance-Based Setup Information

The performance of MicroStrategy Web (JSP) can be increased byconfiguring i t on various component levels. These addi tional settings arenot necessary, but can increase the performance of MicroStrategy Web(JSP).


You can increase the Java heap size for a given appl ication server byconfiguring the WebSphere Administrative Console:

1. Access the Administrative Console.

2. Expand the Servers node.

3. Cl ick the Application Servers l ink to view the l ist of appl icationservers.

4. Cl ick the appl ication server name, scrol l to Addi tional Properties andcl ick Process Definition .

5. Cl ick JVM Settings to set the Java heap size settings. MicroStrategyrecommends that you ini tial ly set the Java heap size to a minimum of500 MB, assuming the machine has enough memory space.

Up grad e Gu id e


This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Javaheap size for your environment.

6. Cl ick Apply.

7. Stop and start the appl ication server.

Pr eco m p i l in g JSP Fi les

To avoid the time taken to load the Web pages in the appl ication serverwhen you access i t for the fi rst time, you must precompi le the Java ServerPages (JSP) fi les. Precompi lation can be done during deployment byselecting the Enable pre-compile of JSPs setting. Otherwise, i t can bedone after deploying the appl ication.

To precompi le the JSPs after deployment, set the appl ication server to loadal l the pages in the appl ication. Then when you connect for the fi rst time,the pages are already loaded and performance is improved.

Before you precompi le the JSP fi les, make sure that:

l The MicroStrategy Web (JSP) appl ication is deployed in the WebSphereenvironment.

l You know the defined appl ication name and the Web Module's name. Youcan retrieve these names from the Administrative Console. Locate theappl ication name under the Enterprise Appl ications node. Locate the WebModule name by expanding the appl ication and cl icking Web Modules.The defaul t name is Web Tier .

To precompile the JSP files

1. Change the directory to WAS_ROOT/bin .

2. Run the fol lowing command:./JspBatchCompiler.sh -enterpriseapp.name

Up grad e Gu id e


ApplicationName -webmodule.name webModule

-cell.name cellName -node.name nodeName

-server.name serverName -keepgenerated

TRUE

If the administrative server is running in a securi ty enabled mode, you areprompted for the user ID and password to connect to the Admin server.

username userID

password password

For each JSP fi le compi led without error, the fol lowing message appears:Code generation successful .

Co n f igu r in g t h e IBM HTTP Ser ver t o Ser ve St at ic Fi les

The IBM HTTP Server (Web server) is tuned to effectively serve static fi les.As a resul t, perceived performance is greatly enhanced i f you configure theIBM HTTP Server to serve image, style sheet, and JavaScript fi les. Thisalso reduces the load on the WebSphere Server so that i t can handle onlydynamic fi les whi le IBM HTTP Server handles static fi les. This requires thatyou do the fol lowing:

l Configure the appl ication server level to serve the Java Server Pages(JSPs) and servlets, which are dynamic fi les and handled by WebSphere.

l Configure the Web server level to serve the images, JavaScripts, andstyle sheets, which are static fi les and handled by the IBM HTTP Server.

For more information, see the IBM WebSphere Appl ication Server redbookcovering System Management and Configuration. This book discussesseparating static content from dynamic content.

Deploying with Tomcat (Linux)

This section provides information on how to deploy and configureMicroStrategy JSP appl ications with Tomcat in a Linux environment. Youcan use the steps below to deploy MicroStrategy Web (JSP) andMicroStrategy Mobi le Server (JSP):

Up grad e Gu id e


l Preconfiguration Information, page 275: Configuration that must occurbefore you begin deploying MicroStrategy Web (JSP), Mobi le Server(JSP) (JSP).

l Deploying MicroStrategy Web and Mobi le Server, page 277: Instructionsfor deploying, including detai led steps.


This section provides the preconfiguration information necessary to deployMicroStrategy JSP appl ications with Tomcat on your Linux machine.


If you have not instal led Oracle JDK yet, download the shel l fi le here. Besure to instal l the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where youinstall the JDK. If you install the JDK to a simple folder path such as C:\setting the system variable is easier and more likely to be correct.

From the location in which to instal l the JDK, run the fi le you downloaded:

jdk-Version-linux-i586.bin

For example, to instal l version 1.6.0, type the fol lowing:

jdk-1_6_0-linux-i586.bin


1. Open the /etc/profile fi le using a program that al lows you to edi tthe fi le.

2. Add the fol lowing l ine:

export JAVA_HOME=/PathName/jdkVersion;

Up grad e Gu id e



where PathName is the destination folder where you instal led the JDKand Version is the version, such as 1_6_0, of the JDK.

In st al l in g To m cat

This procedure assumes that you have downloaded and instal led Tomcat ina directory named Tomcat on your machine. If you have not instal ledTomcat yet, download the zip fi le from the fol lowing l inks:

l Tomcat 7.0.x

l Tomcat 8.0.x

Contact your System Administrator or v is it the Apache website for instructionson downloading and installing Tomcat.

Co n f igu r in g To m cat

After you instal l Tomcat, you must configure Tomcat. The Tomcatconfiguration includes creating the environment variable CATALINA_HOME

and defining this environment variable to point to the Tomcat directory.

1. Open the etc/profile fi le in a program that al lows you to edi t thefi le.

2. Type the fol lowing:

export CATALINA_HOME = /PathName

where PathName is the directory where you have instal led Tomcat.

For example,

export CATALINA_HOME = /Tomcat


The Java heap size for the Tomcat can be modi fied by defining the JAVA_

OPTS parameter in the catalina.sh fi le. For example, you can define thisparameter as fol lows:

Up grad e Gu id e

http://tomcat.apache.org/download-70.cgi

http://tomcat.apache.org/download-80.cgi


JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modi fied to reflect the requirements of yourspeci fic environment. Refer to your thi rd-party appl ication serverdocumentation for information on how to determine a satisfactory Java heapsize for your environment.


After you have performed the configurations described above, you canbegin deploying MicroStrategy JSP appl ications with Tomcat.

Dep lo yin g u sin g To m cat as a st an d alo n e Web co n t ain er

To deploy MicroStrategy JSP applications using Tomcat as a

standalone Web container


2. Copy the WAR fi le to the Tomcat/webapps directory.

To start and stop Tomcat from the command l ine

Type # $CATALINA_HOME/bin/startup.sh and cl ick Enter to startTomcat, which deploys your MicroStrategy JSP appl ications automatical ly,based on the fol lowing:

l If you have configured Tomcat to deploy an exploded WAR fi le, which isoften the defaul t behavior, a folder is created within theTomcat/webapps folder:



Up grad e Gu id e


l If you have configured Tomcat to deploy an unexploded WAR fi le, theconfiguration fi les are created within the system's defaul t temporary fi ledi rectory. For Linux systems, the temporary fi le di rectory is usual ly /tmp/

or /var/tmp/ :





To al low users authorized to access MicroStrategy Web Administrator,MicroStrategy Mobi le Server Administrator, you must create the users andassign them the role of admin under the Tomcat user configuration fi le. Thesteps to configure this access are below.

1. In the Tomcat/conf directory, open the tomcat-users.xml fi leusing a program that al lows you to edi t the fi le.

2. Add the fol lowing tags and save the fi le:

<role rolename="admin"/>

<user username="admin" password="admin"

roles="admin"/>

Up grad e Gu id e


You can specify any value in the user name and password fields.These are used to log in to the MicroStrategy Web Administrator andMobile Server Administrator pages. The roles field must be admin .

3. Stop and restart Tomcat.

Now you can access and configure your MicroStrategy JSP appl ication, asdescribed in Accessing the MicroStrategy JSP appl ication administrativepage, page 279.







localhost


The servlet names at the end of the URL are case-sensi tive. Makesure to use the correct case when typing the servlet name. If theappl ication server is enabled with securi ty, a dialog box related tothe administrator authentication opens.

2. When prompted for a user name and password, use the same valuesyou speci fied in the tomcat-users.xml fi le.


l If you are deploying MicroStrategy Web (JSP), the MicroStrategyWeb Administrator page appears. Add and connect to an Intel l igence

Up grad e Gu id e


Server.


4. If you are deploying MicroStrategy Web (JSP), proceed to launch theMicroStrategy project. In a Web browser, access MicroStrategy Web(JSP) using the fol lowing URL:

http://

localhost:8080/MicroStrategy/servlet/mstrWeb

Deploying MicroStrategy LibraryThe sections below provide instructions for setting up di fferent appl icationservers to deploy MicroStrategy Library.

Deploy MicroStrategy Library on WebSphere

The steps below apply to WebSphere versions 8.5.5 and 9.

Disab le Web Sp h er e' s b u i l t -in JAX-RS.

1. In the IBM WebSphere Appl ication Server, expand Servers > ServerTypes > WebSphere Application Servers.

2. Under Appl ication servers, select <server name> .

3. Under Server Infrastructure, expand Java and Process Management.Choose Process definition > Java Virtual Machine > Customproperties.

Up grad e Gu id e




4. Add a new property.

l Name:com.ibm.websphere.jaxrs.server.DisableIBMJAXRSEngi

ne

l Value: true

Ad d Pr o p er t ies t o t h e Web Co n t ain er Set t in gs

1. Choose Servers > Server Types > WebSphere application serversfrom the WebSphere main configuration page.

2. Cl ick [YOUR SERVER].

3. Under Configuration , choose Container Settings > Web ContainerSettings > Web Container.

4. Choose Additional Properties > Custom properties.

5. Cl ick New.

6. Add the fol lowing fields and cl ick OK .

l Name: com.ibm.ws.webcontainer.emptyServletMappings

l Value: true

7. Cl ick OK .

8. Cl ick Save to the master configuration .

Ad d a Sp eci f ic Web Co n t ain er Cu st o m Pr o p er t y

1. Choose Servers > Server Types > Application Servers.

2. Select the server used for Library.

3. Choose Web Container Settings > Web Container.

4. Cl ick Custom properties.

5. Cl ick New.

Up grad e Gu id e


6. Enter the property values l isted in the fol lowing table.

Property Value

Name com.ibm.ws.webcontainer. invokeFlushAfterService

Value false

Descript ion See the corresponding IBM support page

7. Cl ick OK .

8. Cl ick Save.

9. Restart your appl ication server.

In st al l an d Co n f igu r e t h e War Fi le

1. In the Select installation options screen of the WebSphereinstal lation process, make sure to enter the correct path in theDirectory to install application textbox and then cl ick Next.

2. On the Map virtual hosts for Web modules screen , select thecheckbox next to MicroStrategy Library and cl ick Next.

3. On the Map modules to servers screen , select the checkbox next toyour MicroStrategy Library instal lation and cl ick Next.

4. On the Map context roots for Web modules page, enter/MicroStrategyLibrary as the Context Root then cl ick Next.

5. Select the metadata-complete attribute checkbox next to yourMicroStrategy Library instal lation on the metadata for modules pageand cl ick Next.

6. Cl ick Finish and make sure to Save directly to the masterconfiguration.

Up grad e Gu id e

http://www.ibm.com/support/docview.wss?uid=swg1PM50111


7. Cl ick the Manage Applications link

or

Choose Applications > WebSphere Enterprise Applications.

8. Cl ick Library War.

9. In the Detai l Properties section, cl ick Class loading and updatedetection .

10. Under Class Loader Order, select Classes loaded with local classloader first (parent last).

11. Cl ick OK .

12. In the Modules section, cl ick Manage Modules.

13. Cl ick Library Module.

14. In the Class Loader Order pane, select Classes loaded with localclass loader first (parent last).

15. Cl ick OK twice.

16. Cl ick Save.

17. Choose Select check box for MicroStrategyLibrary_war.

18. Cl ick Start.

Review t h e Ser ver Class Lo ad er Po l icy

1. Choose Server > Server Types > Application Servers > Your servername.

2. Ensure the Server-speci fic Appl ication Settings are in one of thefol lowing orders:

l Class loader pol icy is set to Multiple.

l Class loader pol icy is set to Single and the class loading mode isset to parent-last.

Up grad e Gu id e


l Class loader pol icy is set to Multiple and the class loading mode ofal l appl ications, other than Library appl ications, is set to parent-first.

Deploy MicroStrategy Library on JBoss

Before Deploying the MicroStrategyLibrary.war File:

Open /jboss-eap-

7.0/standalone/configuration/standalone.xml and search for" jaxrs" and disable fol lowing l ines:





Deploy by Exploded Folder:

1. Unzip MicroStrategyLibrary.war fi le as a folder, the folder nameis MicroStrategyLibrary.war .

2. Put the MicroStrategyLibrary.war folder under ./jboss-eap-7.0/standalone/deployments/ .

3. Download modules_config.zip and extract i t under the jboss-

eap-7.0/modules folder .

4. Download jboss-deployment-structure.xml and put i t underjboss-eap-

7.0/standalone/deployments/MicroStrategyLibrary.war/

WEB-INF/ .

5. In the ./jboss-eap-7.0/standalone/deployments/ foldercreate a marker fi le namedMicroStrategyLibrary.war.dodeploy .

Up grad e Gu id e


6. After deploying the marker fi le would be updated toMicroStrategyLibrary.war.deployed , i f we want to redeploythe folder, just rename it as before.

7. Open MicroStrategyLibrary/admin page to configure connectionto Intel l igence Server and Col laboration Server.

Deploy MicroStrategy Library on Wildfly

Before Deploying the MicroStrategyLibrary.war File:

1. Change directories to the folder where you want to unzip the WAR fi le.

2. Run ' jar xvf xxxxx.war ' to unzip the WAR fi le.

3. Modi fy the configOverride.properties fi le wi th Intel l igenceServer and Col laboration Server information.

4. Use 'jar -cvf xxxxx.war * ' to make the WAR fi le.

5. Place the new WAR fi le inside the folder.

Deploy the War File:

1. Stop Wildfly.

2. Put the MicroStrategyLibrary.war fi le under ..\wildfly-10.1.0.Final\standalone\deployments folder.

3. Restart Wi ldfly.

Deploy MicroStrategy Library on Jetty

Please be aware that Jetty 9 is compatible on Java 8, not compatible on Java 9

Before deploying the .war fi le securi ty configuration of Jetty is necessary:

Up grad e Gu id e


1. In the fi le [jetty_path]/etc/jetty.xml , between <Configure>

markers the fi le should have <Call name="addBean"> markerswhich should read:

<Call name="addBean"> <Arg> <New

class="org.eclipse.jetty.security.HashLoginService">

<Set name="name">Administrator Authentication

Area</Set> <Set name="config"><SystemProperty

name="jetty.home"

default="."/>/etc/realm.properties</Set> </New>

</Arg> </Call>

2. In the same /etc folder add a fi le realm.properties containingthe l ine:

admin: admin,server-administrator,content-

administrator,admin

This wi l l define a user, password, and a set of roles.

To deploy the MicroStrategyLibrary.war fi le:

1. Place the fi le into [jetty]/demo-base/webapps

2. Execute the fol lowing command:

java -jar ../start.jar --add-to-start=jmx

3. Go to the demo-base folder and execute the fol lowing command:

java -jar ../start.jar

Deploy MicroStrategy Library on WebLogic

War file Deployment

1. On a browser, open the WebLogic console.

2. Go to Deployments > Install.

Up grad e Gu id e


3. Upload MicroStrategyLibrary.war .

4. Select the Install this deployment as an application option.

5. Leave al l other settings on the defaul t value and cl ick Finish .

6. From the deployed folder, change the necessary properties (Intel igeceServer hostname, Intel l igence Server port, etc.)

Sample deployment folder:

C:\Oracle\Middleware\Oracle_Home\user_

projects\domains\base_

domain\servers\AdminServer\tmp\.appmergegen_

1500564917141_dossier7391.war\WEB-

INF\classes\authConfig.properties

7. Restart the web server.

Deployment with War file exploded

1. On the machine where WebLogic is instal led, manual ly unzip theMicroStrategyLibrary.war fi le to a speci fic folder.

2. On a browser, open the WebLogic console.

3. Go to Deployments > Install.

4. Add the folder where the war is unzipped to the Path field.

5. Select the radio button next to <folder name> (open directory).

6. Select option Install as an application .

7. Select the setting to I will make the deployment accessible atextracted folder.

8. Keep other defaul t deployment values and and cl ick Finish .

9. After the deployment is successful i t should appear as active and

Up grad e Gu id e


heal thy.

Sample deployment resul t:

http://localhost:7001/MicroStrategyLibrary

To access the URL, you may need to turn off firewall on the corp/labsenvironment

Using a Response File with Configuration Wizard

As an al ternative to stepping through each page of the ConfigurationWizard, you can create a response fi le wi th the upgrade information anduse that response fi le to automatical ly upgrade your MicroStrategy systems.

This section provides the fol lowing information on using a response fi le:

Creating a Response FileMicroStrategy recommends that you create a response fi le through the GUImode of the Configuration Wizard. You step through the ConfigurationWizard and make your selections. Then, at the end of the ConfigurationWizard, do not cl ick Finish . Instead, cl ick Save. You are prompted to saveyour selections in a response fi le.

You can also create or modi fy a response fi le wi th a text edi tor. If you donot have access to the GUI mode of the Configuration Wizard, this is theonly way to create a response fi le. MicroStrategy suppl ies a blank responsefi le template, Response.ini , that you can copy and modi fy to create yourresponse fi le. This fi le is in the Common Fi les folder of your MicroStrategyinstal lation. By defaul t, this folder is C:\Program Files

(x86)\Common Files\MicroStrategy .

For information on al l the parameters in the response fi le, see ResponseConfiguration Parameters and Options, page 292.

Up grad e Gu id e


Executing a Response File1. In Windows, go to Start > All Programs > MicroStrategy Tools >

Configuration Wizard . The Configuration Wizard opens.

2. Cl ick Load .

3. Browse to the path where the response fi le is saved and cl ick Open .The Summary page opens.

4. An overview of al l the configuration tasks performed by the responsefi le appears. Cl ick Finish .

To Use a Response File through the Windows Command Line

1. Enter the fol lowing command in the Windows command l ine:

macfgwiz.exe -r "Path\response.ini"

Where Path\ is the ful ly qual i fied path to the response fi le.

A common location of a response file is:

C:\Program Files (x86)\Common

Files\MicroStrategy\RESPONSE.INI

If an error message is displayed, check the path and name you suppliedfor the response file and make any required changes.

To Use a Response File through the Configuration Wizard in UNIX or

Linux

1. From a UNIX or Linux console window, browse to <HOME_PATH>

where <HOME_PATH> is the directory you speci fied as the HomeDirectory during instal lation.

2. Browse to the folder bin .

Up grad e Gu id e


3. Enter mstrcfgwiz-editor and cl ick Enter. The ConfigurationWizard opens with the Welcome page displayed.

4. Cl ick Enter.

5. Enter 1 to select to use a response fi le, and then cl ick Enter.

6. Enter the ful ly qual i fied path to the response.ini fi le and cl ickEnter.

/home/username/MicroStrategy/RESPONSE.INI


To Use a Response File Through the UNIX/Linux Command Line




3. Enter the fol lowing command in the command l ine and cl ick Enter.

mstrcfgwiz-editor -response /Path/response.ini

Where Path is the ful ly qual i fied path to the response fi le.

For example, a common location of a response file is:



Up grad e Gu id e


To Use a Response File Through the Windows Command Line

1. Type the fol lowing command in the Windows command l ine:

macfgwiz.exe -r "Path\response.ini"

Where Path\ is the ful ly qual i fied path to the response fi le.

A common location of a response file is:

C:\Program Files (x86)\Common Files\MicroStrategy\RESPONSE.INI


To Use a Response File Through the Configuration Wizard in UNIX or

Linux




3. Enter mstrcfgwiz-editor , and cl ick Enter. The ConfigurationWizard opens with the Welcome page displayed.

4. Cl ick Enter.

5. Enter 1 to select to use a response fi le. Cl ick Enter.

6. Enter the ful ly qual i fied path to the response.ini fi le and cl ickEnter.



Up grad e Gu id e


To Use a Response File Through the UNIX/Linux Command Line




3. Enter the fol lowing command in the command l ine, and cl ick Enter.

mstrcfgwiz-editor -response /Path/response.ini

Where Path is the ful ly qual i fied path to the response fi le.

For example, a common location of a response file is:



Response Configuration Parameters and OptionsMicroStrategy recommends that you always create the response fi le throughthe GUI mode of the Configuration Wizard. However, you can also modi fy aresponse fi le wi th a text edi tor to make minor changes such as enteringdi fferent user login and password information.

If you are manually editing the response file, make sure to save the file usingANSI encoding.

Upgrading Intelligence Server Components and Projects

The response fi le parameters in the [UpgradeServer] section upgradeIntel l igence Server components and projects. The table below l ists theavai lable parameters and the functional i ty of avai lable options for eachparameter.

Up grad e Gu id e


Options Description

[UpgradeServer]

In this sect ion you can upgrade Intell igence Servercomponents and the projects for an Intell igenceServer.

UpgradeServer=

Def ines whether to upgrade Intell igence Servercomponents and projects, as determined by thefollowing values:

l 1: Upgrade Intell igence Server components andprojects.

l 0: Does not upgrade Intell igence Servercomponents and projects.

UpgradeMD=

Def ines whether to upgrade the metadata, asdetermined by the following values:

l 1: Upgrades the metadata repository, whichcontains the def init ions of your MicroStrategyapplicat ions and support ing objects. An upgradeof your metadata is required to provide supportfor all new and updated features in the mostrecent version of MicroStrategy.

l 0: Does not upgrade the metadata.

Upgrade Privileges=

Def ines whether to upgrade administ rat iveprivi leges, as determined by the following values:

l 1: Upgrades the privi leges used to def ine thefeatures and capabil i t ies available for eachMicroStrategy user. This upgrade is required toref lect any changes in privi leges for the mostrecent version of MicroStrategy. Af ter theupgrade is f inished, you can manually modifythe privi leges for your users and user groups toensure that all users have access to the requiredMicroStrategy features. To ensure that theupdated user privi leges are in compliance withyour l icense agreement, you can use License

Up grad e Gu id e


Options Description

Manager to audit and view user productprivi leges.

l 0: Does not upgrade administ rat ive privi leges.

MigrateHL=

Def ines whether to migrate History List f rom a f latf i le to a database, as determined by the followingvalues:

l 1: Migrates your previous f i le-based HistoryList repository to a database-based History Listrepository. In pre-9.0 versions of MicroStrategy,all History List f i les were stored using a f i le-based method. In addit ion to the f i le-basedmethod, it is also possible to store the HistoryList repository in the database. This allowsadminist rators to centrally monitor all HistoryList messages across the system.

l 0: Does not migrate History Lists to adatabase. Use this opt ion if you did notpreviously use History List messages or you planto cont inue to use a f lat f i le to support and storeHistory Lists.

UpgradeProjects=

Def ines whether to upgrade projects, asdetermined by the following values:

l 1: Upgrades the projects def ined inProjectLogicalUpgrade.

l 0: Does not upgrade projects.

ServerUser=Provide the user name for the MicroStrategy userto connect to the Intell igence Server to upgrade.

ServerPwd=Provide the password for the MicroStrategy user toconnect to the Intell igence Server to upgrade.

MDPwd= Provide the password for the metadata to upgrade.

Up grad e Gu id e


Options Description

PrivilegesSourceVersion=

I f you have previously upgraded the metadata butnot upgraded the privi leges, provide the version ofthe metadata that you most recent ly upgraded yourprivi leges to, f rom the following list of opt ions:

l 9.4

l 9.5

l 9.5.1

l 10

l 10.1

l 10.2

l 10.3

l 10.4

l 10.5

l 10.6

l 10.7

l 10.8

l 10.9

l 10.10

l 10.11

HLTarget=

I f performing a History List migrat ion, the type ofHistory List to migrate to:

l File

l Database

l Hybrid

HLPath=

I f performing a History List migrat ion, def ines thedirectory locat ion of the History List f lat f i le tomigrate to a database.

Up grad e Gu id e


Options Description

HybridPath=

I f performing a History List migrat ion to a hybridHistory List , def ines the directory locat ion wherethe hybrid History List f i les are to be stored.

HLDSNName=

I f performing a History List migrat ion, def ines theDSN of the database to migrate the History Listtables to.

HLUserName=

I f performing a History List migrat ion, def ines theuser name to connect to the database for theHistory List migrat ion.

HLUserPwd=

I f performing a History List migrat ion, def ines thepassword to connect to the database for theHistory List migrat ion.

HLPrefix=I f performing a History List migrat ion, def ines thetable pref ix for History List tables.

HLDropTables=

Def ines whether to drop exist ing tables in thedatabase used for the History List migrat ion, asdetermined by the following values:

l 1: Deletes exist ing tables in the databasebefore migrat ing the History List tables.

l 0: Appends the migrated History List tables tothe database without delet ing exist ing tables.

HLDeleteFiles=

Def ines whether to delete the f i le based HistoryList af ter the migrat ion is complete, as determinedby the following values:

l 1: Deletes the f i le-based History List repositoryonce the migrat ion to a database-based HistoryList repository is complete. This opt ion shouldonly be used if the f i le-based History Listrepository is no longer needed, and you canensure the migrat ion process can be completedsuccessfully.

Up grad e Gu id e


Options Description

l 0: Does not delete the f i le-based History Listrepository once the migrat ion to a database-based History List repository is complete.

HLUseUTF8=

Def ines whether UTF-8 encoding should be usedfor the History List migrat ion on Windows, asdetermined by the following values:

l 1: Uses UTF-8 encoding for Windows drivers.This opt ion should be used if your database andHistory List messages use UTF-8 encoding, andthe Intell igence Server is installed on Windows.

l 0: Does not use UTF-8 encoding.

HLUseUNIXUTF8=

Def ines whether UTF-8 encoding should be usedfor the History List migrat ion on UNIX/Linux, asdetermined by the following values:

l 1: Uses UTF-8 encoding for UNIX/Linux drivers.This opt ion should be used if your database andHistory List messages use UTF-8 encoding, andthe Intell igence Server is installed on UNIX orLinux.

l 0: Does not use UTF-8 encoding.

HLDB2zOSDBName=

Def ines the database name to create or migrateHistory Lists stored in DB2 z/OS. This opt ionshould be used if connect ing to a DB2 z/OSdatabase.

HLDB2zOSTableSpaceName=

Def ines the table name to be used in the databasewhen creat ing or migrat ing the History List . Thisopt ion should be used if connect ing to a DB2 z/OSdatabase.

ThreadNumber

I f performing a History List repository upgrade to ahybrid History List , def ines the number of databasethreads to use for the upgrade.

Up grad e Gu id e


Options Description

ProjectLogicalUpgrade=

Def ines the projects to update their schedules thatsend reports and documents to caches, HistoryLists, and MicroStrategy Mobile as subscript ions.These subscript ions are part of the integratedsubscript ion and delivery features in Intell igenceServer 9.0 and later versions. They provide thesame abil i ty to send reports and documents tocaches, History Lists, and MicroStrategy Mobile asthe schedules in MicroStrategy pre-9.0.

This opt ion also upgrades the reports and ReportServices documents in the projects, whichimproves performance, reduces storage spacerequirements, and ensures that graphs displaycorrect ly in MicroStrategy Web 10 and Developer10.

To upgrade mult iple projects, you must enclosethe name of each project in curly braces {} andseparate the names with a backslash \ . Forexample:

{Project1}\{Project2}\...\{ProjectN}

ScheduleUpdate=

Def ines the projects to upgrade their schedules tothe most recent version of MicroStrategy.

To upgrade mult iple projects' schedules, you mustenclose the name of each project in curly braces { } and separate the names with a backslash \ . Forexample:


MDXUpdate=

Def ines the projects to update their MDX sourceobjects (MDX cubes) that were created in earl ierversions of MicroStrategy to take advantage ofincreased performance and other updates.

You can integrate MDX sources such as SAP

Up grad e Gu id e


Options Description

BW, Microsof t Analysis Services, andHyperion Essbase into your MicroStrategyenvironment. For informat ion on integrat ingMDX sources into MicroStrategy, see theMDX Cube Report ing Guide.

To upgrade mult iple projects' MDX source objects,you must enclose the name of each project in curlybraces { } and separate the names with abackslash \ . For example:


SysObjIDUnification=

Def ines the projects for which to update systemobjects so that objects can be moved betweenunrelated projects using MicroStrategy ObjectManager. This is required for projects f rom pre-9.0.1 versions of MicroStrategy.

To upgrade mult iple projects' system objects, youmust enclose the name of each project in curlybraces { } and separate the names with abackslash \ . For example:


ProjectUpgradeContinueExecuting=

Def ines whether to update the rest of the specif iedprojects if one project update generates an error:

l 1: Cont inues the update process even if an erroris found in one project .

l 0: Halts the update process for all projects if anerror is found in one project .

EncryptPassword=

Def ines whether the password is encrypted in theresponse f i le, as determined by the followingvalues:

l 1: Encrypts the password in the response f i le,which ensures that your password is secure. This

Up grad e Gu id e


Options Description

is the default behavior.

l 0: The password is not encrypted in theresponse f i le, which enables you to modify thepassword in the response f i le later using a texteditor. You can then dist ribute the response f i leto mult iple users with various login andpassword credent ials. However, be aware thatthis can compromise your database security ifyou do not remove the password from theresponse f i le before dist ribut ing it .

DB2ZoSDBName=

Def ines the database name to update metadatasstored in DB2 z/OS. This opt ion should be used ifconnect ing to a DB2 z/OS database.

DB2ZoSTableSpaceName=

Def ines the table name to be used in the databasewhen upgrading the metadata. This opt ion shouldbe used if connect ing to a DB2 z/OS database.

LeanObjects=

Def ines whether to perform Lean Objectsmigrat ion at the server level:

l 1: Perform Lean Objects migrat ion.

l 0: Do not perform Lean Objects migrat ion.

LeanObjectsProjects=

Def ines whether to perform Lean Objects migrat ionat the project level:

l 1: Perform Lean Objects migrat ion.

l 0: Do not perform Lean Objects migrat ion.

Upgrading Statistics Repositories

The response fi le parameters in the [UpgradeStats] section upgradestatistics and Enterprise Manager reposi tories. The table below l ists theavai lable parameters and the functional i ty of avai lable options for eachparameter.

Up grad e Gu id e


Options Description

[UpgradeStats]

In this sect ion you can upgrade stat ist ics repositories to the mostrecent version of MicroStrategy. You can have more than one[UpgradeStats] sect ion. Addit ional stat ist ics upgrade sect ions canbe included as [UpgradeStats1], [UpgradeStats2], and so on.

UpgradeStats=

Def ines whether to upgrade the stat ist ics and Enterprise Managerrepositories, as determined by the following values:

l 1: Upgrades the stat ist ics repository

l 0: Does not upgrade the stat ist ics repository

EncryptPassword=

Def ines whether the password is encrypted in the response f i le, asdetermined by the following values:

l 1: Encrypts the password in the response f i le, which ensures thatyour password is secure. This is the default behavior.

l 0: The password is not encrypted in the response f i le, whichenables you to modify the password in the response f i le later usinga text editor. You can then dist ribute the response f i le to mult ipleusers with various login and password credent ials. However, beaware that this can compromise your database security if you do notremove the password from the response f i le before dist ribut ing it .

StatsDSN=I f performing a stat ist ics repository upgrade, def ines the DSN of thedatabase that stores the stat ist ics repository.

StatsUser=I f performing a stat ist ics repository upgrade, def ines the user name toconnect to the database for the stat ist ics repository.

StatsPwd=I f performing a stat ist ics repository upgrade, def ines the password toconnect to the database for the stat ist ics repository.

StatsPrefix=I f performing a stat ist ics repository upgrade, def ines the databasepref ix for the stat ist ics repository.

Upgrading an Enterprise Manager Project

The response fi le parameters in the [EMProjectHeader] sectionupgrade an Enterprise Manager project. The table below l ists the avai lable

Up grad e Gu id e


parameters and the functional i ty of avai lable options for each parameter.

Options Description

[EMProjectHeader]

In this sect ion you can upgrade an Enterprise Manager projectto the most recent version of MicroStrategy. You can have morethan one [EMProjectHeader] sect ion. Addit ional EnterpriseManager project upgrade sect ions can be included as[EMProjectHeader1], [EMProjectHeader2], and so on.

EMProject=

Def ines whether to upgrade the Enterprise Manager project , asdetermined by the following values:

l 1: Upgrades the Enterprise Manager project .

l 0: Does not upgrade the Enterprise Manager project .

EMProjectEncryptPwd=

Def ines whether the password is encrypted in the response f i le,as determined by the following values:

l 1: Encrypts the password in the response f i le, which ensuresthat your password is secure. This is the default behavior.

l 0: The password is not encrypted in the response f i le, whichenables you to modify the password in the response f i le laterusing a text editor. You can then dist ribute the response f i leto mult iple users with various login and password credent ials.However, be aware that this can compromise your databasesecurity if you do not remove the password from the responsef i le before dist ribut ing it .

EMProjectDSSUser=

I f performing an Enterprise Manager project upgrade, providesthe MicroStrategy user name that can access and administer theEnterprise Manager project .

EMProjectDSSPwd=

I f performing an Enterprise Manager project upgrade, providesthe password for the MicroStrategy user that can access andadminister the Enterprise Manager

project .

EMProjectDSNName=I f performing an Enterprise Manager project upgrade, def inesthe DSN of the database that stores the stat ist ics tables and

Up grad e Gu id e


Options Description

Enterprise Manager repository.

EMProjectDSNUserName=

I f performing an Enterprise Manager project upgrade, def inesthe user name to connect to the database for the stat ist icstables and Enterprise Manager repository.

EMProjectDSNUserPwd=

I f performing an Enterprise Manager project upgrade, def inesthe password to connect to the database for the stat ist ics tablesand Enterprise Manager repository.

EMProjectDSNPrefix=

I f performing an Enterprise Manager project upgrade, def inesthe database pref ix for the stat ist ics tables and EnterpriseManager repository.

Upgrading History List Repositories

The response fi le parameters in the [UpgradeHistoryList] sectionupgrade a database-based History List reposi tory. The table below l ists theavai lable parameters and the functional i ty of avai lable options for eachparameter.

Options Description

[UpgradeHistoryList]

In this sect ion you can upgrade History List repositories to the mostrecent version of MicroStrategy. You can have more than one[UpgradeHistoryList] sect ion. Addit ional History List upgradesect ions can be included as [UpgradeHistoryList1],[UpgradeHistoryList2], and so on.

UpgradeHistoryList=

Def ines whether to upgrade a History List repository, as determined bythe following values:

l 1: Upgrades the History List repository.

l 0: Does not upgrade the History List repository.

EncryptPassword=Def ines whether the password is encrypted in the response f i le, asdetermined by the following values:

Up grad e Gu id e


Options Description

l 1: Encrypts the password in the response f i le, which ensures thatyour password is secure. This is the default behavior.

l 0: The password is not encrypted in the response f i le, whichenables you to modify the password in the response f i le later usinga text editor. You can then dist ribute the response f i le to mult ipleusers with various login and password credent ials. However, beaware that this can compromise your database security if you do notremove the password from the response f i le before dist ribut ing it .

HLDSN=I f performing a History List repository upgrade, def ines the DSN of thedatabase that stores the History List repository.

HLUser=I f performing a History List repository upgrade, def ines the user nameto connect to the database for the History List repository.

HLPwd=I f performing a History List repository upgrade, def ines the passwordto connect to the database for the History List repository.

HLPrefix=I f performing a History List repository upgrade, def ines the databasepref ix for the History List repository.

CopyContent=

I f performing a History List repository upgrade, upgrades exist ingHistory List messages to the specif ied format, as determined by thefollowing values:

l 1: Upgrades exist ing History List messages.

l 0: Does not upgrade exist ing History List messages.

Regardless of this set t ing, the new database tables required forthe new History List format are created, and any new History Listmessages are created in the new format.

CompressData=

I f performing a History List repository upgrade, compresses allexist ing History List messages, as determined by the following values:

l 1: Compresses exist ing History List messages.

l 0: Does not compress exist ing History List messages. Newlycreated messages are compressed.

Up grad e Gu id e


Migrating Web Delivery Subscriptions from Narrowcast Server toMicroStrategy Distribution Services

The response fi le parameters in the [UpgradeServer] section migrateMicroStrategy Web del ivery subscriptions from a Narrowcast Serverenvironment to Distribution Services. MicroStrategy Web del iverysubscriptions include emai l , fi le, and print subscriptions created fromMicroStrategy Web. Migrating these subscriptions from Narrowcast Serverto Distribution Services al lows the subscriptions to be central ized inIntel l igence Server rather than a separate Narrowcast Server. The tablebelow l ists the avai lable parameters and the functional i ty of avai lableoptions for each parameter.

Options Description

[MigrateNCS]

In this sect ion you can migrate MicroStrategy Webdelivery subscript ions from a Narrowcast Serverenvironment to Dist ribut ion Services. You can have morethan one [MigrateNCS] sect ion. Addit ionalMicroStrategy Web delivery subscript ion migrat ionsect ions can be included as [MigrateNCS1],[MigrateNCS2], and so on.

MigrateNCS=

Def ines whether to migrate MicroStrategy Web deliverysubscript ions from a Narrowcast Server environment toDist ribut ion Services, as determined by the followingvalues:

l 1: Migrates MicroStrategy Web delivery subscript ionsfrom a Narrowcast Server environment to Dist ribut ionServices.

l 0: Does not migrate MicroStrategy Web deliverysubscript ions from a Narrowcast Server environment toDist ribut ion Services.

DSNNameSBR=Def ines the DSN of the database that stores theNarrowcast Subscript ion Book Repository.

Up grad e Gu id e


Options Description

UserNameSBR=Def ines the user name to connect to the database for theNarrowcast Subscript ion Book Repository.

UserPwdSBR=Def ines the password to connect to the database for theNarrowcast Subscript ion Book Repository.

SysPrefixSBR=Def ines the pref ix used for the tables of the NarrowcastSubscript ion Book Repository.

DSNNameOR=Def ines the DSN of the database that stores theNarrowcast Object Repository.

UserNameOR=Def ines the user name to connect to the database for theNarrowcast Object Repository.

UserPwdOR=Def ines the password to connect to the database for theNarrowcast Object Repository.

SysPrefixOR=Def ines the pref ix used for the tables of the NarrowcastObject Repository.

PSNName=Def ines the project source that the Web deliverysubscript ions are migrated to.

DSSUser= Def ines the user name to connect to the project source.

DSSPwd=Def ines the user password to connect to the projectsource.

TargetProjects=

Def ines the projects, for a project source, to migrateWeb subscript ions from Narrowcast Server to Dist ribut ionServices. You can select mult iple projects, separat ingprojects by the \ character. For example,TargetProjects=Project1\Project2.

MigrateWebDeliveryUsers=

Def ines whether to migrate all users of Web deliveries toDist ribut ion Services, as determined by the followingvalues:

l 1: Migrates all users of Web deliveries to Dist ribut ionServices. Addresses of the MicroStrategy users who

Up grad e Gu id e


Options Description

subscribed to Web deliveries are assigned to thecorresponding MicroStrategy users. No newMicroStrategy users are created.

l 0: Does not migrate all users of Web deliveries toDist ribut ion Services.

AssignPrivileges=

I f you choose to migrate all users of Web deliveries toDist ribut ion Services, this opt ion def ines whether togrant the Use Dist ribut ion Services privi lege for all Webdelivery users that are migrated to Dist ribut ion Services,as determined by the following values:

l 1: Grants the Use Dist ribut ion Services privi lege forall Web delivery users that are migrated to Dist ribut ionServices. Ensure that grant ing these privi leges is incompliance with your product l icense for Dist ribut ionServices.

l 0: Does not grant the Use Dist ribut ion Servicesprivi lege for all Web delivery users that are migratedto Dist ribut ion Services.

MigrateNCSUsers=

Def ines whether to migrate Narrowcast Server users andtheir addresses as contacts in Dist ribut ion Services, asdetermined by the following values:

l 1: Migrates Narrowcast Server users and theiraddresses as contacts in Dist ribut ion Services. Acontact is created for each Narrowcast Server user.The Narrowcast Server user's addresses are copied asaddresses of the contact . A contact is a list ofsubscript ion recipient addresses. These recipients donot have the permissions to log in to MicroStrategyWeb or Developer. Contacts enable these recipients toreceive subscript ions.

l 0: Does not migrate Narrowcast Server users andtheir addresses as contacts in Dist ribut ion Services

Up grad e Gu id e


Options Description

MigrateTransmittersAction=

These parameters specify the conf l ict resolut ion ruleswhen migrat ing Narrowcast objects to Dist ribut ionServices. Conf l icts occur when ident ical objects arepresent in both the Narrowcast Server system you aremigrat ing from and the Intell igence Server metadata youare migrat ing to. Def ining conf l ict resolut ion rulesdetermines how these conf l icts are resolved during themigrat ion.

You can use the following parameters to def ine how toresolve any conf l icts during the migrat ion:

l MigrateTransmittersAction for Transmit ters

l MigrateDevicesAction for Devices

l MigrateSchedulesAction for Schedules

l MigrateSubscriptionsAction for Subscript ions

l MigrateUsersAction for Users

For each object type listed above, you can def ine conf l ictresolut ion rules based on matching IDs. For t ransmit ters,devices, and schedules you can also def ine conf l ictresolut ion rules based on matching def init ions. Theseopt ions are described in the table below.

In the table below, "source" refers to yourNarrowcast Server and "dest inat ion" refers to thenew metadata tables.

MigrateDevicesAction=

MigrateSchedulesAction=

MigrateSubscriptionsAction=

Up grad e Gu id e


Options Description

MigrateUsersAction=

Up grad e Gu id e


Options Description

Match by ID orDefinition

Conflict Resolution Option Value

Match by IDs

Objects arematched bytheir ID only.

Match by IDs, keepexisting

I f objects withmatching IDs arefound, the object inthe dest inat ionlocat ion is kept . Theobject in the source isnot migrated to thedest inat ion.

1

Match by IDs, replace

I f objects withmatching IDs arefound, the objectf rom the sourcereplaces thematching object inthe dest inat ion.

2

Match byDefinition

Objects arematched bytheirdef init ions.This enablesobjects thathave the samedef init ion, butdif ferent IDs tobe def ined as a

Match by Definition,merge

I f objects withmatching def init ionsare found, alldependent objects ofthe matching object inthe source aremigrated to thedest inat ion. Themigrated dependentobjects are def ined as

3

Up grad e Gu id e


Options Description

match. Theseconf l ictresolut ionopt ions areavailable fort ransmit ters,devices, andschedules.

dependents of thematching object in thedest inat ion.

Match by Definition,create new

I f objects withmatching def init ionsare found, thematching object inthe source ismigrated to thedest inat ion as a newobject . A separateobject for thematching object inthe dest inat ion isalso kept . Thisresults in two objectswith matchingdef init ions in thedest inat ion, whichyou can modify af terthe migrat ion iscomplete.

4

EncryptPassword=

Def ines whether the password is encrypted in theresponse f i le, as determined by the following values:

l 1: Encrypts the password in the response f i le, whichensures that your password is secure. This is thedefault behavior.

l 0: The password is not encrypted in the response f i le,which enables you to modify the password in theresponse f i le later using a text editor. You can thendist ribute the response f i le to mult iple users with

Up grad e Gu id e


Options Description

various login and password credent ials. However, beaware that this can compromise your database securityif you do not remove the password from the responsef i le before dist ribut ing it .

Defining DSNs

After you instal l an ODBC driver, you can define one or more data sourcesfor i t. The DSN should provide a unique description of the data, forexample, Payroll_Project_Metadata or Payroll_Warehouse .

The DSN is the name for a pointer used by a cl ient appl ication (in this caseMicroStrategy) to find and connect to a data source. Mul tiple DSNs canpoint to the same data source and one DSN can be used by di fferentappl ications.

You can define a data source connection with a DSN by using:

l The MicroStrategy Connectivi ty Wizard—configures connectivi ty to datasources by creating a DSN that uses a MicroStrategy-branded ODBCdriver (see Creating a DSN for a data source, page 313).

l The Microsoft ODBC Data Source Administrator—creates a DSN for anODBC driver that is not MicroStrategy-branded (see Managing ODBC anddata sources with Microsoft ODBC Data Source Administrator, page 315).

l Edit the odbc.ini on Linux. For more information, please see ConfiguringODBC Parameters wi th odbc.ini .

It is strongly recommended you use the MicroStrategy Connectiv ity Wizardwhen creating a new DSN for a MicroStrategy-branded ODBC driver. Use theMicrosoft ODBC Data Source Administrator only if you intend to use a driverthat is not MicroStrategy-branded.

Up grad e Gu id e


If you create DSNs using the Microsoft ODBC Data Source Administrator, youmust create system DSNs. Otherwise, MicroStrategy interfaces will notrecognize them.

Creating a DSN for a data sourceIf a DSN does not al ready exist in your empty metadata reposi tory or thereposi tory instal led with MicroStrategy, you can add or create a new one.

The MicroStrategy Connectivi ty Wizard is a tool designed speci fical ly toconfigure connectivi ty to data sources by creating a DSN that uses aMicroStrategy-branded ODBC driver.

To create a DSN

1. On Windows, log in to the system as an administrator.

2. From the Start menu, go to Programs > MicroStrategyTools >Connectivity Wizard .

On Linux:

l Using the Connectivi ty Wizard interface, perform the fol lowing steps:

l In a Linux console window, browse to HOME_PATH where HOME_


l Browse to the folder bin and type ./mstrconnectwiz , and thenpress ENTER.

l From the command l ine, perform the fol lowing steps:

l In a Linux console window, browse to HOME_PATH where HOME_


l Browse to the folder bin and type ./mstrconnectwiz -h , andthen press ENTER.

Up grad e Gu id e


l This command displays command l ine operation syntax andexamples for di fferent database platforms. Create your commandbased on the syntax and examples displayed. Once you performyour command, the DSN is created and no further action isrequired. For detai led steps on how to use the command l ineversion of this tool , see Creating a DSN for a Data Source inConfiguring MicroStrategy Using Command Line Tools.

3. Cl ick Next.

4. Select a database driver wi th which to create a DSN and cl ick Next.

Only a few databases can contain metadata repositories. For details ,refer to the MicroStrategy Readme . Only DSNs created to connect tothese databases can be used to connect to metadata repositories.

5. Enter the information in the appropriate fields for connecting with theselected database driver. The information to enter varies depending onthe database platform that you selected. For more information, seeCreating DSNs for speci fic data sources.

6. Cl ick Test.

7. Enter the User Name and Password to connect to the database.

8. Cl ick Connect. If the test is performed successful ly, the connectionwith the database is establ ished. If the test fai ls, veri fy the correctconnection information with your database administrator and make anyrequired changes to the information you provided in the previoussteps.

9. Cl ick Close, and then Finish .

If you already have an existing DSN with the same name as the one youprovided, a message box appears. You have the following options:

Up grad e Gu id e


Select Yes to make sure the DSN points to the location you are expecting.This overwrites the existing DSN.

Select No to save the DSN with a different name.

Repeat the above steps to create as many DSNs as you require. At aminimum, create one for your metadata and one for your warehouse.

Managing ODBC and data sources with Microsoft ODBC DataSource AdministratorThe Microsoft ODBC Data Source Administrator manages database driversand data sources on Windows. The Microsoft ODBC Data SourceAdministrator uti l i ty creates a log with which to trace cal ls to data sourcesand to view, create, and edi t DSNs. The uti l i ty is avai lable from Microsoftand is usual ly included with the purchase of an ODBC driver.

l It is strongly recommended that you use the Connectivi ty Wizard whencreating a new DSN for a MicroStrategy-branded ODBC Driver. Use theMicrosoft ODBC Data Source Administrator only i f you intend to use anon-MicroStrategy driver.

l If you choose to create DSNs using the Microsoft ODBC Data SourceAdministrator, they must be system DSNs. Otherwise, MicroStrategyinterfaces cannot recognize them.

To create a DSN using the Microsoft ODBC Data Source Administrator

1. Log in to the machine as an administrator. This gives you the abi l i ty tocreate a system-wide DSN, rather than a user-speci fic DSN.

2. In most Windows systems you can access the ODBC Data SourceAdministrator from the Control Panel . Refer to your thi rd-partyMicrosoft documentation for steps to access the ODBC Data SourceAdministrator tool .

Up grad e Gu id e


3. Cl ick the System DSN tab.

To view all the installed ODBC drivers, c lick the Drivers tab.

4. Cl ick Add .

5. Select the desired driver and cl ick Finish .

We recommended that you select a MicroStrategy ODBC driver. Thesedrivers, whose names start with MicroStrategy, were installed when youinstalled the MicroStrategy application on the computer.

6. Enter the information in the appropriate fields to create a data sourcefor the selected database driver.

The information to enter varies depending on the database platformthat you selected, which is discussed in Creating DSNs for speci ficdata sources.

7. Cl ick OK .

Specifying Warehouse Connection Information

A database instance is a MicroStrategy object, created in MicroStrategyDeveloper by an administrator, that represents a connection to a datasource. A database instance speci fies connection information, such as thedata source name, Login ID and password, and other data source speci ficinformation.

The steps to create the required components of a database instance areprovided in the following sections: Creating a database instance, page321 , Creating a database connection, page 325 , and Creating adatabase login, page 331 .

When a project archi tect creates a project, the archi tect assigns a databaseinstance to that project. A project speci fies only one warehouse database

Up grad e Gu id e


instance at a time, but a database instance can be assigned to multipleprojects. Since only one data source can be included in the project'srelational schema, al l reports and documents return information from asingle data source.

If you have a l icense for the MultiSource Option feature, you can connect aproject to mul tiple warehouse database instances. There can be multipledata sources that connect to the Warehouse Catalog for the project. Sincethese data source can be integrated as part of the project's relationalschema, al l reports and documents can return information from multipledata sources. For information on accessing multiple data sources in aproject, see the Project Design Guide.

Regardless of whether you have a l icense for the MultiSource Option, youcan also extend a project's access to multiple data sources through otherMicroStrategy features. Freeform SQL, Query Bui lder, and supportingaccess through MicroStrategy to other MDX cube sources such as SAP BW,Oracle Essbase, and Microsoft Analysis Services al lows non-projectdatabase instances to be included and used in a project along with thewarehouse database instances. For information on Freeform SQL andQuery Bui lder, see the Advanced Reporting Guide. For information on MDXcube sources, see the MDX Cube Reporting Guide

These non-project database instances can al low a project to connect to thedata sources for the various features and addi tional data sourcesmentioned above, instead of accessing the data from the project's relationalschema. For more information on the Warehouse Catalog, see the ProjectDesign Guide.

SQL data warehouses database instancesA SQL data warehouse database instance is any database instance thatconnects to a database or other data source through SQL queries. Morespeci fical ly, this covers database instances used for standardMicroStrategy reporting, Freeform SQL, Query Bui lder, data marts, and anyother relational data source. You can also connect to History List and

Up grad e Gu id e

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

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

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




statistics tables through SQL data warehouse database instances. The SQLdata warehouse database instances are avai lable in the ProjectConfiguration Edi tor, as shown below.

Selecting a database instance check box makes that database instanceavai lable in the project for standard MicroStrategy reporting, data marts,Query Bui lder, and Freeform SQL. If you have a l icense for the MultiSourceOption, selecting a check box for a database instance also makes thedatabase instance avai lable from the Warehouse Catalog to be part of theproject's relational schema.

Database instances can be created as part of the Import Data feature. Adatabase instance used for the Import Data feature is displayed with the

icon. These database instances are created with security permissions for theuser that created them while using the Import Data feature. If you select one ofthese database instances to be included as an available database instance inthe project, it is recommended that you change the security permissions to aMicroStrategy user with administrative priv ileges. This includes takingownership of the database instance and defining an appropriate access controllis t. This ensures that no changes are made to the database instance by other

Up grad e Gu id e


users, which could cause a loss of connectiv ity to the data source. Forinformation on the Import Data feature, refer to the MicroStrategy Web onlinehelp.

The shading and color of a database instance in the l ist of relationaldatabase instances reflects how the database instance is being used in theproject:

l Blue text: This is the warehouse database instance, as selected from thewarehouse database instance drop-down l ist. There can only be onewarehouse database instance for a project, because this databaseinstance's data is populated in the Warehouse Catalog to define theproject's relational schema. You cannot choose to disable the warehousedatabase instance for the project wi thout fi rst selecting a di fferentwarehouse database instance.

If you have a l icense for the MultiSource Option, the primary databaseinstance acts as the main source of data for a project and is used as thedefaul t database instance for tables added to the project.

For information on the Warehouse Catalog as wel l as accessing multipledata sources with the MultiSource Option, see the Project Design Guide.

l Bold text: The project contains objects that are dependent on thedatabase instance. You cannot choose to disable a database instancethat has dependent objects for the project.

l Normal text: The database instance is not being used in the project.

Clearing the check box of a database instance removes the databaseinstance from the project and deletes any unused Freeform SQL or QueryBui lder schemas. You can clear a database instance from a project only i fthere are no dependent objects in the project for the database instance. Formore information on removing a database instance and related FreeformSQL and Query Bui lder schemas from a project, refer to the SystemAdministration Guide.

Up grad e Gu id e





MDX cube database instancesAn MDX cube database instance is any database instance that connects toan MDX cube source, such as SAP BW, Oracle Essbase, or MicrosoftAnalysis Services. For information on connecting to and reporting on theseMDX cube sources, refer to the MDX Cube Reporting Guide. The MDX cubedatabase instances are avai lable in the Project Configuration Edi tor, asshown below.

A database instance that has an MDX cube schema is represented withbold text. The shading and color of a database instance in the l ist ofrelational database instances reflects how the database instance is beingused in the project:

l Bold : The project contains objects that are dependent on the databaseinstance. You cannot choose to disable a database instance that hasdependent objects for the project.

l Normal: The database instance is not being used in the project.

Up grad e Gu id e



If you remove an MDX cube database instance from a project, you candelete any unused MDX cube schema objects. You can remove databaseinstance from a project only i f there are no dependent objects in the projectfor the database instance. For more information on removing a databaseinstance and related MDX cube managed objects from a project, refer to theSystem Administration Guide.

For addi tional information on configuring MDX cube database instances,refer to the MDX Cube Reporting Guide.

MDX schema loading and maintenance

You can cl ick Schema Maintenance to perform various tasks for an MDXcube schema that is part of your project, as described below:

l You can choose when an MDX cube schema associated with a databaseinstance is loaded for a project. By defaul t, MDX cube schemas areloaded as needed when MDX cube reports are executed. You can alsochoose to load MDX cube schemas when Intel l igence Server starts. Forinformation on defining when MDX cube schemas should be loaded, referto the MDX Cube Reporting Guide.

l When you integrate MDX cube sources into MicroStrategy, the data isintegrated as an MDX cube schema. Once you integrate an MDX cubesource into MicroStrategy, you can exchange the database instance usedto connect to the MDX cube schema for a di fferent database instance.This al lows you to use di fferent database instances with di fferent loginand connection information to access an MDX cube schema. Forinformation on exchanging the database instance used to connect to theMDX cube schema, refer to the MDX Cube Reporting Guide.

Creating a database instanceDatabase instances are created and modi fied in the Database InstanceManager, which can be found by expanding Administration for a project

Up grad e Gu id e






source, then expanding Configuration Managers. When you choose tocreate a new database instance, the Database Instances Edi tor opens.

You can also create a new database instance using the Database InstanceWizard that is available in the Database Instance Manager shortcut menu.

The Database Instances Edi tor has the fol lowing tabs:

l General—speci fies the database instance name, connection type (datasource platform or appl icable data source), and defaul t databaseconnection.

The database connection type you choose should match your data sourceand determines whether the database instance is a relational or an MDXcube database instance.

l Advanced—speci fies the database name for intermediate table storage i fa database other than the warehouse is used to store intermediate tables,as wel l as other options.

Up grad e Gu id e


The Advanced tab is not avai lable for MDX cube database instances.

l Job Priori tization—speci fies the job priori tization scheme for the instanceand the number of priori tized connections.

To create a database instance1. In MicroStrategy Developer, log in to a project source with

administrative privi leges.

2. Go to Administration > Configuration Managers > DatabaseInstances.

3. From the File menu, go to New > Database Instance.

4. On the General tab, in the Database instance name field, type thename of the database instance.

5. In the Database connection type drop-down l ist, select the datasource connection type according to the data source hosting yourdatabase.

If you have upgraded from a previous version of MicroStrategy, you canclick Upgrade to retrieve any database connection types that have beenincluded since the previous version of MicroStrategy that you used.

6. On the Advanced tab, you can configure various options for thedatabase instance, including:

l Intermediate table storage: You can speci fy the database name andtable name space to use when intermediate tables are created.Intermediate tables are created to support various queries.

l Database gateway support: You can support backwardscompatibi l i ty for database gateway support from MicroStrategyversion 6.x.

To enable database gateway support, select the Primary databaseinstance check box, and then select a primary database instance

Up grad e Gu id e


from the drop-down l ist. The primary database instance is thedatabase instance that should be used for element browsing againstthe selected table and for queries that do not require joins to othertables. For information on database gateway support, see the ProjectDesign Guide.

l Data mart optimization : You can support data mart optimization i fthe data source for the database instance is in the same data sourcethat contains data marts.

To enable data mart optimization, select the This database instanceis located in the same warehouse as check box, and then select adatabase instance from the drop-down l ist.

l Table prefix: If the tables in your data source use a table prefix, youcan include the table prefix to identi fy the proper col lection of tables.Cl ick Select to select a table prefix or define a new table prefix.

l ODBC Version : You can define which ODBC version to use for thedatabase instance, as described below:

n Use 2.0 ODBC Calls: ODBC 2.0 was used in pre-9.0 versions ofMicroStrategy. You can use this option for backward compatibi l i tyi f your database management system does not support ODBC 3.x.This also al lows you to use extended fetch to retrieve blocks ofdata from the database into memory, instead of row by row.

n Use 3.x ODBC Calls: The support of ODBC 3.x is introduced inMicroStrategy 9.0. This value is chosen by defaul t for DatabaseInstances in MicroStrategy 9.x and higher.You should use thisoption i f your database management system supports ODBC 3.x.ODBC 3.x wi l l always use extended fetch (SQLFetchScrol l ) toretrieve blocks of data from the database into memory rather thanrow-by-row retrieval .

Up grad e Gu id e




7. On the Job Prioritization tab, you can configure how jobs arepriori tized for the database instance. For information on configuringjob priori tization, see the System Administration Guide.

8. On the General tab, in the Database connection (default) pane,select the defaul t data source connection and cl ick OK.

If the necessary database connection does not exist, you can createone by cl icking New. For steps to create a database connection,see Creating a database connection, page 325 below.

Creating a database connectionA database connection speci fies the DSN and database login used toaccess the data source. A database instance designates one databaseconnection as the defaul t connection for MicroStrategy users; however,users and groups can be mapped to other database connections usingconnection mapping. For more detai ls on connection mapping, see Userconnection mapping, page 333.

You create database connections in the Database Instances Edi tor bycl icking New on the General tab. Any database connection created withinthe Database Instances Edi tor is avai lable for use across al l databaseinstances in the project source. For more information on creating adatabase connection for MDX cube sources, refer to the MDX CubeReporting Guide.

When you choose to create a new database connection, the DatabaseConnections dialog box opens:

Up grad e Gu id e





The Database Connections dialog box has di fferent options depending onthe database instance type:

l SQL data warehouse database instances

n General : Speci fies the database connection name, the warehouse DSN,and the defaul t database login.

n Advanced: Speci fies the database driver mode, driver execution mode,and other miscel laneous warehouse connection settings.

l MDX cube database instances

n General : Speci fies the database connection name, the defaul t databaselogin, and addi tional connection information that you must provide. Formore information on creating a database connection for MDX cubesources, see the MDX Cube Reporting Guide.

n Advanced: Speci fies the connection settings, addi tional connectionstring parameters, and connection caching settings.

Up grad e Gu id e



To create a database connection

Before moving forward, ensure that a database instance has been created asdescribed in Creating a database instance, page 321 .

1. On the General tab, in the Database connection name box, type aname to identi fy the database connection.

2. In the Local system ODBC data sources pane, select the data sourcename for the data source.

3. On the Advanced tab, you can define various options per yourrequirements and the requirements of the database you are connectingto, including:

l Database driver mode: Select one of the fol lowing database drivermodes:

l Multi-process: Each connection to the warehouse database isspawned as a separate process, identi fied in Windows TaskManager as M8DBMPE.exe . If one process fai ls, such as when adatabase access thread hangs or is lost, other processes are notaffected.

l Multi-threaded : Al l connections to the warehouse database aremaintained inside the Intel l igence Server process MSTRSVR.exe .Al l connections, SQL submissions, and data retrievals from thedatabase are handled within this process.

MicroStrategy recommends setting al l database drivers to multi -process mode. The robustness and stabi l i ty which come with multi -process mode greatly overshadow any increased efficiency thatmay come with multi -threaded mode. Problems that appear randomand sporadic in mul ti -threaded operation can often be resolved byswitching to multi -process mode.

Up grad e Gu id e


l Driver execution mode: Define the driver execution modedepending on the ODBC driver being used:

l Asynchronous Connection : Al l statements al located within theconnection should be able to run SQL asynchronously.

l Asynchronous Statement: For each statement, the asynchronousmode is expl ici tly set.

l Synchronous: Only one statement executes at a time. This is thedefaul t value.

Many newer ODBC drivers do not support asynchronous modebecause the driver is capable of opening a new thread and executing anew query while simultaneously running an earlier query. TheMicroStrategy Readme gives recommendations for the driverexecution mode options that can be used for different ODBC drivers.

l Use extended fetch : Select this check box to enable Intel l igenceServer to fetch blocks of data from the database into memory,instead of row-by-row. Be aware that this check box is only avai lablei f the database instance is defined to use 2.0 ODBC cal ls, which isincluded in the steps Speci fying Warehouse Connection Information,page 316. When 3.0 ODBC cal ls are enabled, extended fetch isalready enabled and this option is grayed out.

l Use parameterized queries: Select this check box to enableIntel l igence Server to pass data to the database in blocks instead ofrow-by-row. For information on how parameterized queries canimprove performance in MicroStrategy, see the Project DesignGuide.

l Maximum cancel attempt time (sec): Defines the maximum amountof time the MicroStrategy Query Engine wai ts for a successful

Up grad e Gu id e




attempt before i t cancels a query. Values of 0 and -1 indicate nol imi t.

l Maximum query execution time (sec): Defines the maximumamount of time a single pass of SQL can execute on the database.Values of 0 and -1 indicate no l imi t.

l Maximum connection attempt time (sec): Defines the maximumamount of time Intel l igence Server wai ts to connect to the database.Values of 0 and -1 indicate no l imi t.

l Additional connection string parameters: Enables you to passaddi tional ODBC connection parameters to the database as part ofthe connection string. This is useful i f you need to change ODBCdefaul ts. Cl ick Preview to see the enti re connection string.

l Table prefix: Defines a table prefix that speci fies the schemacontaining the tables to access.

l Character set encoding for Windows drivers: The options l istedbelow are only relevant when Intel l igence Server is running on aWindows machine:

n Non UTF-8 (defaul t): Select this option i f the ODBC driver returnsinformation in a character encoding other than UTF-8.

n UTF-8: Select this option i f the ODBC driver returns information inUTF-8 character encoding. Drivers for Teradata databases mayrequire UTF-8 encoding.

l Character set encoding for UNIX drivers: The options l isted beloware only relevant when Intel l igence Server is running on a UNIXmachine:

n Non UTF-8: Select this option i f the ODBC driver returnsinformation in a character encoding other than UTF-8.

Up grad e Gu id e


n UTF-8 (defaul t): Select this option i f the ODBC driver returnsinformation in UTF-8 character encoding. Drivers for Teradatadatabases may require UTF-8 encoding.

l Connection Caching : Speci fy the caching of the databaseconnection using the fol lowing options:

n Connection idle timeout (sec): Defines the amount of time aninactive connection to the database remains cached unti l i t isterminated. You must also set the Connection l i fetime, describedabove, to a value greater than zero for database connections to beused by more than a single job.

Enforcement of the connection idle timeout can cause a databaseconnection to be removed before i t reaches i ts connection l i fetime.You can use this connection idle timeout to ensure that databaseconnections do not remain in Intel l igence Server memory in an idlestate for an extended amount of time.



If you type a value of 0, when the job associated with a databaseconnection is completed, the database connection is deleted andnot put into a cache. If you type a value of -1, a database

Up grad e Gu id e


connection can remain idle and considered for new jobs unti l thedatabase connection l i fetime is reached.

4. On the General tab, in the Default database login name pane, selectthe defaul t database login and cl ick OK .

If the necessary database login does not exist, you can create one bycl icking New. For steps to create a database connection, see Creatinga database login, page 331 below.

Creating a database loginA database login speci fies the user ID and password used to access thedata source. The database login overwri tes any login information stored inthe DSN. A database connection designates one database login as thedefaul t login for MicroStrategy users, however users and groups can bemapped to other database logins using connection mapping.

Connection mapping is explained in User connection mapping, page 333 .

You create database logins in the Database Connections dialog box bycl icking New on the General tab. Any database login created within theDatabase Connections dialog box is avai lable for use across al l databaseconnections in the project source.

MicroStrategy reporting and analysis features require a general set ofdatabase login permissions that can connect to and modi fy the data sourceand metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions arerequired. Intermediate tables are created in the metadata for recursivesearch queries, which requires Create and Drop permissions as wel l .Updating the schema requires the Delete permission.

l For the data warehouse, the Select, Create, Insert, and Drop permissionsare required.

Up grad e Gu id e


When you choose to create a new database login, the Database loginsdialog box opens:

To create a database login

Before moving forward, ensure that the following is complete:

l A database instance has been created, as described in Creating a databaseinstance, page 321 .

l A database connection has been created, as described in Creating adatabase connection, page 325 .

1. In the Database Login field, type the name of the database login.

2. Provide the user ID and password required to access the data source,using one of the fol lowing methods:

l Type the user ID in the Login ID field, and type the password for thatuser ID in the Password field.

l Select the Use network login ID check box to connect to the datasource using the network user credentials which are also used to runIntel l igence Server. If Intel l igence Server is running as a service,this is the user that is running the mstrsvr.exe process. Todetermine this user, in MicroStrategy Service Manager, selectMicroStrategy Intelligence Server and cl ick Options. The user isl isted on the Service Startup tab, in the Login field. If the Service

Up grad e Gu id e


Account Name is defined as System Account, the Windows usercredentials are used to access the data source.

3. Cl ick OK.

Database logins are passed to the data source any time a user executes areport or browses attribute elements. Therefore, all database logins created inMicroStrategy Developer must be also be created as valid logins in the datasource.

User connection mappingUser connection mapping is the process of mapping MicroStrategy users todatabase connections and database logins. For MicroStrategy users toexecute reports, they must be mapped to a database connection anddatabase login.

MicroStrategy users l ink to database connections and logins using:

l The defaul t database connection (and, therefore, defaul t database login)

l Special ized maps to a database connection and/or database login(di fferent than the defaul t connection and login) for ei ther a user or usergroup

You can map users to connections and logins in the Project ConfigurationEdi tor or Command Manager. For information about how connection mapsare used, see the System Administration Guide.

MicroStrategy reporting and analysis features require a general set ofdatabase login permissions to connect to and modi fy the data warehouseand metadata, as described below:

l For the metadata, the Select, Insert, and Update permissions arerequired. Intermediate tables are created in the metadata for recursivesearch queries, which requires Create and Drop permissions as wel l .Updating the schema requires the Delete permission.

Up grad e Gu id e



l For the data warehouse, the Select, Create, Insert, and Drop permissionsare required.

To create a connection map

Before moving forward, ensure that the following is complete:

l A database instance has been created, as described in Creating a databaseinstance, page 321 .

l A database connection has been created, as described in Creating adatabase connection, page 325 .

l A database login has been created, as described in Creating a databaselogin, page 331 .

1. In Developer, log in to a project.

2. Right-cl ick the project and select Project Configuration . The ProjectConfiguration Edi tor opens.

3. In the Categories l ist, expand the Database Instances category, andthen select Connection mapping .

4. Right-cl ick in the Database instances - Connection mapping pane,and select New. A new connection mapping is added.

5. You can define the connection mapping by speci fying the informationdescribed below:

l Database Instance: The database instance which connects to thedata source required for the connection mapping.

l User: The user or user group to apply the connection mapping to.

l Language: The language of the data accessed by the connectionmapping. You can use connection mappings to support datainternational ization. For information on supporting data

Up grad e Gu id e


international ization with connection mappings, see the ProjectDesign Guide.

l Database connection : The data source to connect to.

l Database Login : The database login for the connection mapping.

6. Cl ick OK .

Minimizing the Impact of Data Changes for PlatformRelease Upgrades

With each feature release, improvements and enhancements made to theData Engine can cause minor changes in the data returned when executingdossiers and documents. The impacts of these changes for customersupgrading from one feature release to the next, MicroStrategy 10.10 toMicroStrategy 10.11 for example, are minimal and can be resolved throughtypical post-upgrade testing.

For customers migrating from one platform release to the next,MicroStrategy 10.4.x to MicroStrategy 2020 for example, the cumulativeeffect of the changes can have a large impact on your execution resul ts. Tominimize these impacts when performing a platform release upgrade,MicroStrategy Workstation al lows you to choose the Data Engine versionfor each project or appl ication in your environment.

Customers Upgrading from MicroStrategy 10.11 or earl ier wi l l notice theData Engine version is 10.4 for al l projects in your environment fol lowingan upgrade to MicroStrategy 2020. Once the upgrade process is completed,the Data Engine version can be changed to 2020 on a project-by-projectbasis so that data changes can be identi fied, evaluated, and resolved whi lemaintaining consistent performance across the rest of the environment. Al lnew projects defaul t to the 2020 Data Engine version.

What does the Data Engine do?

The Data Engine processes queries, against a schema, for a speci fic data

Up grad e Gu id e




source, to perform data manipulations.

Pr ocesses qu er ies

At t r ibu t es, m et r ics, f i l t ers, VLDB set t ings, secu r it y f i l t ers, dat a locales

Aga in st a sch em a

At t r ibu t es, fact s, t ab les, relat ionsh ips, h ierarch ies

For a specif ic da t a sou r ce

SQL, M DX, In -M em ory, o r a b lend o f l inked dat aset s

To per for m dat a m an ipu la t ion s

Sor t ing, sl icing, sub t o t als, sm ar t m et r ics, der ived elem en t s, t h resho lds, cross-

t abb ing

Selecting a Data Engine Version

To select a Data Engine version, MicroStrategy Workstation must be connected toan environment and you must have Administrator priv ileges.

1. Open the Workstation window with the Navigation Pane.

2. Cl ick Applications to display the projects avai lable in theenvironment.

3. Right cl ick an appl ication and select Properties.

4. Select a version from the Data Engine Version drop-down menu.

Up grad e Gu id e


5. Cl ick OK .

6. Reload the project wi th MicroStrategy Developer to apply the changes.

Up grad e Gu id e