MicroStrategy ONE

Web and Mobile

This section provides information used to deploy and configure MicroStrategy JSP applications in a Tomcat-only environment. For information on how to configure Tomcat to work with IIS, see iishowto.html (Tomcat 6.0) in the Tomcat documentation. You can use the steps below to deploy MicroStrategy Web (JSP) and MicroStrategy Mobile Server (JSP):

Preconfiguration Information

This section provides the preconfiguration information necessary to deploy MicroStrategy JSP applications on Tomcat on your machine.

Installing the JDK

If you have not installed the Oracle JDK yet, download the file from the website. Be sure to install the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where you install the JDK. If you install the JDK to a simple folder path such as C:\ setting the system variable is easier and more likely to be correct.

Configuring the JDK

The third-party products discussed below are manufactured by vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate Microsoft documentation for steps to access and modify the environment variables.

  1. From the Start menu, go to Computer > System properties > Advanced system settings > Environment Variables > System Variables.
  2. Under , click New to create a system variable.
  3. In the Variable Name field, type JAVA_HOME.
  4. In the Variable Value field, type the path of the folder where you installed the JDK and click OK.

For example, if the fully qualified path to your JDK executable is C:\jdk1.6.0\bin\java.exe, the value of your JAVA_HOME variable is C:\jdk1.6.0.

If you have installed JDK under the Program Files folder, type Progra~1 when specifying the folder name in the Variable Value box; otherwise the system does not recognize the folder. For example, type C:\Progra~1\jdk1.6.0 in the Variable Value box.

Configuring Tomcat

This procedure assumes that you have downloaded and installed Tomcat on your machine. You can download Tomcat from the Apache website; depending on the version you want to download, you may need to locate the appropriate file in Apache's Archive area. Instructions for downloading and installing Tomcat are also available on the Apache website.

To configure Tomcat, a system variable must point to the folder where you install Tomcat. Installing Tomcat to a simple folder path such as C:\Tomcat makes it easier to define the system variable.

The third-party products discussed below are manufactured by vendors independent of MicroStrategy, and the steps to configure these products is subject to change. Refer to the appropriate Microsoft documentation for steps to access and modify the environment variables.

  1. From the Start menu, go to Computer > System properties > Advanced system settings > Environment Variables > System Variables.
  2. Click New to create a system variable.
  3. In the Variable Name field, type CATALINA_HOME.
  4. In the Variable Value field, specify the path of the folder where you installed Tomcat and click OK. For example, if you installed Tomcat directly to the C drive, the destination folder is C:\Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1 when specifying the folder in the Variable Value box. Otherwise, the system does not recognize the folder. For example, type C:\Progra~1\Tomcat in the Variable Value box.

Setting the Java heap size

The Java heap size for the Tomcat can be modified by defining the JAVA_OPTS parameter in the catalina.bat file. For example, you can define this parameter as follows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modified to reflect the requirements of your specific environment. Refer to your third-party application server documentation for information on how to determine a satisfactory Java heap size for your environment.

Deploying MicroStrategy Web and Mobile Server

Assuming you have made all the necessary configurations described above, you can begin deploying MicroStrategy Web (JSP), Mobile Server (JSP) (JSP) with Tomcat.

Deploying using Tomcat as a stand-alone Web container

  1. Locate the WAR file for your MicroStrategy JSP application, as described in Locating the WAR file.
  2. Copy the WAR file to the Tomcat\webapps folder.
  3. From the Start menu, select Run.
  4. Type cmd in the Open drop-down list and click OK.
  5. Browse to the Tomcat\bin folder, where Tomcat is the folder in which you installed Tomcat. For example, in the command prompt, type

    cd C:\Tomcat\bin
  6. Click Enter. C:\Tomcat\bin> is displayed at the command prompt.
  7. Type the required commands to start and stop Tomcat, which depends on your version of Tomcat. For example, for Tomcat 7, type Tomcat7 start to start Tomcat and type Tomcat7 stop to stop Tomcat. Refer to your third-party Apache documentation for information on the commands to start and stop Tomcat.

If you installed Tomcat under the Program Files folder, type Progra~1 when you change folders in the command prompt. Otherwise, the system does not recognize the folder. For example, type C:\Progra~1\Tomcat\bin in the command prompt.

Your MicroStrategy JSP application is deployed automatically, based on the following:

  • If you have configured Tomcat to deploy an exploded WAR file, which is often the default behavior, a folder is created within the Tomcat\webapps folder:
    • When deploying MicroStrategy Web (JSP), the folder is named MicroStrategy by default.
    • When deploying MicroStrategy Mobile Server (JSP), the folder is named MicroStrategyMobile by default.
  • If you have configured Tomcat to deploy an unexploded WAR file, the configuration files are created within the system's default temporary file directory. For Windows systems, the temporary file directory is commonly defined by the TMP environment variable:
    • When deploying MicroStrategy Web (JSP), a /microstrategy/web-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Web (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.
    • When deploying MicroStrategy Mobile Server (JSP), a /microstrategy/mobile-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Mobile Server (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.

Configuring administrative access your MicroStrategy JSP applications

To allow users authorized to access MicroStrategy Web Administrator, MicroStrategy Mobile Server Administrator, you must create the users and assign them the role of admin under the Tomcat user configuration file. The steps to configure this access are below.

  1. In the Tomcat\conf folder, open the tomcat-users.xml file in a program that allows you to edit the file, such as Notepad.
  2. Add the following tag and save the file:

    <user name="administrator" password="administrator" roles="admin"/>

    You can specify any value in the user name and password fields.

  3. Stop and start Tomcat from the command line.

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for your MicroStrategy JSP application.

  1. Access the servlet by typing the following URL in a Web browser:
    • For Web (JSP): http://localhost:8080/MicroStrategy/servlet/mstrWebAdmin
    • For Mobile Server (JSP): http://localhost:8080/MicroStrategyMobile/servlet/mstrWebAdmin

    The servlet names at the end of the URL are case-sensitive. Make sure to use the correct case when typing the servlet name. If the application server is enabled with security, a dialog box related to the administrator authentication opens.

    If you are using Tomcat integrated with IIS, you do not need to specify the port number in the URL. However, when using Tomcat as a stand-alone Web container, you must specify the port number. The default port for Tomcat is 8080.

  2. When prompted for a user name and password, use the same values you specified in the tomcat-users.xml file.
  3. If you are deploying MicroStrategy Web (JSP), the MicroStrategy Web Administrator page appears. Add and connect to an Intelligence Server.
  4. If you are deploying MicroStrategy Mobile Server (JSP), the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the (missing or bad snippet). Creating a configuration completes the steps required to deploy Mobile Server (JSP).

Launching the project

In a Web browser, access MicroStrategy Web (JSP) using this URL:

http://localhost:8080/MicroStrategy/servlet/mstrWeb

This section provides information on how to deploy and configure MicroStrategy JSP applications with Tomcat in a Linux environment. You can use the steps below to deploy MicroStrategy Web (JSP) and MicroStrategy Mobile Server (JSP):

Preconfiguration Information

This section provides the preconfiguration information necessary to deploy MicroStrategy JSP applications with Tomcat on your Linux machine.

Installing the JDK

If you have not installed Oracle JDK yet, download the shell file here. Be sure to install the JDK and not the JRE software options.

To configure the JDK, a system variable must point to the folder where you install the JDK. If you install the JDK to a simple folder path such as C:\ setting the system variable is easier and more likely to be correct.

From the location in which to install the JDK, run the file you downloaded:

jdk-Version-linux-i586.bin

For example, to install version 1.6.0, type the following:

jdk-1_6_0-linux-i586.bin

Configuring the JDK

  1. Open the /etc/profile file using a program that allows you to edit the file.
  2. Add the following line:

    export JAVA_HOME=/PathName/jdkVersion;

    where PathName is the destination folder where you installed the JDK and Version is the version, such as 1_6_0, of the JDK.

Installing Tomcat

This procedure assumes that you have downloaded and installed Tomcat in a directory named Tomcat on your machine. If you have not installed Tomcat yet, download the zip file from the following links:

Contact your System Administrator or visit the Apache website for instructions on downloading and installing Tomcat.

Configuring Tomcat

After you install Tomcat, you must configure Tomcat. The Tomcat configuration includes creating the environment variable CATALINA_HOME and defining this environment variable to point to the Tomcat directory.

  1. Open the etc/profile file in a program that allows you to edit the file.
  2. Type the following:

    export CATALINA_HOME = /PathName

    where PathName is the directory where you have installed Tomcat.

    For example,

    export CATALINA_HOME = /Tomcat

Setting the Java Heap Size

The Java heap size for the Tomcat can be modified by defining the JAVA_OPTS parameter in the catalina.sh file. For example, you can define this parameter as follows:

JAVA_OPTS = "-Xms1024m -Xmx2048m"

This value may need to be modified to reflect the requirements of your specific environment. Refer to your third-party application server documentation for information on how to determine a satisfactory Java heap size for your environment.

Deploying MicroStrategy Web and Mobile Server

After you have performed the configurations described above, you can begin deploying MicroStrategy JSP applications with Tomcat.

Deploying using Tomcat as a standalone Web container

  1. Locate the WAR file for your MicroStrategy JSP application, as described in Locating the WAR file.
  2. Copy the WAR file to the Tomcat/webapps directory.

To start and stop Tomcat from the command line

Type # $CATALINA_HOME/bin/startup.sh and click Enter to start Tomcat, which deploys your MicroStrategy JSP applications automatically, based on the following:

  • If you have configured Tomcat to deploy an exploded WAR file, which is often the default behavior, a folder is created within the Tomcat/webapps folder:
    • When deploying MicroStrategy Web (JSP), the folder is named MicroStrategy by default.
    • When deploying MicroStrategy Mobile Server (JSP), the folder is named MicroStrategyMobile by default.
  • If you have configured Tomcat to deploy an unexploded WAR file, the configuration files are created within the system's default temporary file directory. For Linux systems, the temporary file directory is usually /tmp/ or /var/tmp/:
    • When deploying MicroStrategy Web (JSP), a /microstrategy/web-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Web (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.
    • When deploying MicroStrategy Mobile Server (JSP), a /microstrategy/mobile-Version/ folder is created within the temporary file directory, where Version is the version number for the MicroStrategy Mobile Server (JSP) product. Within this folder location, various configuration files can be found within the WEB-INF folder and its subfolders.

Configuring administrative access to MicroStrategy JSP applications

To allow users authorized to access MicroStrategy Web Administrator, MicroStrategy Mobile Server Administrator, you must create the users and assign them the role of admin under the Tomcat user configuration file. The steps to configure this access are below.

  1. In the Tomcat/conf directory, open the tomcat-users.xml file using a program that allows you to edit the file.
  2. Add the following tags and save the file:

    <role rolename="admin"/>

    <user username="admin" password="admin" roles="admin"/>

    You can specify any value in the user name and password fields. These are used to log in to the MicroStrategy Web Administrator and Mobile Server Administrator pages. The roles field must be admin.

  3. Stop and restart Tomcat.

Now you can access and configure your MicroStrategy JSP application, as described in Accessing the MicroStrategy JSP application administrative page.

Accessing the MicroStrategy JSP application administrative page

You can use the steps below to access the administrative page for your MicroStrategy JSP application.

  1. Access the servlet by typing the following URL in a Web browser:
    • For Web (JSP): http://localhost:8080/MicroStrategy/servlet/mstrWebAdmin
    • For Mobile Server (JSP): http://localhost:8080/MicroStrategyMobile/servlet/mstrWebAdmin

      The servlet names at the end of the URL are case-sensitive. Make sure to use the correct case when typing the servlet name. If the application server is enabled with security, a dialog box related to the administrator authentication opens.

  2. When prompted for a user name and password, use the same values you specified in the tomcat-users.xml file.
  3. After you are authenticated:
    • If you are deploying MicroStrategy Web (JSP), the MicroStrategy Web Administrator page appears. Add and connect to an Intelligence Server.
    • If you are deploying MicroStrategy Mobile Server (JSP), the MicroStrategy Mobile Server Administrator page appears. Add and connect to an Intelligence Server. Once connected, click Mobile Configuration to configure your MicroStrategy Mobile applications to communicate with Mobile Server and Intelligence Server. For steps on how to define this configuration, see the MicroStrategy Mobile Administration Help. Creating a configuration completes the steps required to deploy Mobile Server (JSP).
  4. If you are deploying MicroStrategy Web (JSP), proceed to launch the MicroStrategy project. In a Web browser, access MicroStrategy Web (JSP) using the following URL:

    http://localhost:8080/MicroStrategy/servlet/mstrWeb