EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB43242: How to install MicroStrategy Web and Mobile help documentation on a local web server.


Community Admin

• Strategy


The online help for Strategy Web, Strategy Web Administrator, and Strategy Mobile Server is provided on a Strategy-hosted server. This paradigm allows these Strategy products to access the most recent and up to date documentation for their associated release.
To access the online help, a connection over the Internet must be made. For certain systems, allowing this type of connection might not be feasible for various reasons such as limited Internet connection or security concerns. To support these systems, Strategy also provides the following local help files that can be included in Strategy Web or Strategy Mobile Server deployments to provide local access to the online help. The local web pages served will only be in English, but full documentation in other languages can be found under the

manuals 
folder within the
StrategyWebHelp.zip
file. These files are available in the Download site.

  • StrategyWebHelp.zip: Includes the help files for Strategy Web and Strategy Web Administrator.
  • StrategyMobileServerHelp.zip: Includes the help files for Strategy Mobile Server.

 
Follow the steps below to modify your deployments of Strategy Web or Strategy Mobile Server to access local help files. You must perform these steps for each separate deployment of Strategy Web or Strategy Mobile Server.
 
Prerequisites:

  • You have downloaded the .zip files that contain the Strategy help files to the machine that hosts your Strategy Web or Strategy Mobile Server deployment from the Download site.
  • You have deployed the appropriate version of Strategy Web or Strategy Mobile Server. Refer to the Installation and Configuration Guide provided with the Strategy software for information on deploying Strategy Web and Strategy Mobile Server.

To modify a Strategy Web deployment to access local help files

  1. On the machine that hosts your Strategy Web deployment, extract the files from StrategyWebHelp.zip.
  2. From the extracted files, copy the top level folder named
    Strategy_Web_Help, 
    move its entire contents, including all files and subfolders, into the top level directory for your Strategy Web deployment.
  3. Rename the copied folder
    help.
  4. Open the Strategy Web Administrator page.
  5. From the Web Server list on the left, click Help configuration. The help configuration options are displayed. 
  6. Select Local. Links to the Help will start at ../help/, and then click Save.
  7. Restart the web server hosting your Strategy Web deployment.
  8. To verify that the help is now accessing the local version of the help files, click one of the available Help options or ? icons within the

Strategy Web or Strategy Web Administrator interfaces. Within the web browser that displays the help information, the URL should reflect a local connection to the help as opposed to showing a connection to www.microstrategy.com.
 
If an access error is encountered when clicking a Help option, this can mean that the help files were not included in the proper deployment location. Ensure that the local help files you extracted from the associated .zip file are stored at the top level of the deployment path. The help folder must be the top level folder for the local help files.
 
To modify a Strategy Mobile Server deployment to access local help files

  1. On the machine that hosts your Strategy Mobile Server deployment, extract the files from
    StrategyMobileServerHelp.zip.
  2. From the extracted files, copy the top level folder named
    help 
    and move its entire contents, including all files and subfolders, into the top level directory for your Strategy Mobile Server deployment.
  3. Open the Strategy Mobile Server Administrator page.
  4. From the Mobile Server list on the left, click Help configuration. The help configuration options are displayed.
  5. Select Local. Links to the Help will start at ../help/, and then click Save.
  6. Restart the web server hosting your Strategy Mobile Server deployment.
  7. To verify that the help is now accessing the local version of the help files, click one of the available Help options or ? icons within the Strategy Mobile Server interfaces. Within the web browser that displays the help information, the URL should reflect a local connection to the help as opposed to showing a connection to www.microstrategy.com.

If an access error is encountered when clicking a Help option, this can mean that the help files were not included in the proper deployment location. Ensure that the local help files you extracted from the associated .zip file are stored at the top level of the deployment path. The help folder must be the top level folder for the local help files.
 


Comment

0 comments

Details

Knowledge Article

Published:

April 21, 2017

Last Updated:

April 21, 2017