Installing IBM Planning Analytics Spreadsheet Services (TM1 Web)

You can install Planning Analytics Spreadsheet Services on a computer that is separate from the computer where you installed the TM1® Server and other TM1 or Planning Analytics components.

Note: As of the 2.0.55 SC release of IBM® Planning Analytics in July 2020, TM1 Web is installed with the Planning Analytics Spreadsheet Services installer. TM1 Web is no longer part of the web tier within the Planning Analytics Local installer.

This documentation describes how to install TM1 Web with the Planning Analytics Spreadsheet Services installer. If you need details on installing TM1 Web as part of the web tier within the Planning Analytics Local 2.0.9.1 LC or earlier, see Installing the web tier.

For a list of frequently asked questions about the TM1 Web deployment introduced with the 2.0.55 SC release, see Changes to TM1 Web deployment.

For conformance documentation that describes compatibility between versions of Planning Analytics TM1 Web, Planning Analytics for Microsoft Excel, and Planning Analytics Workspace, see IBM Planning Analytics TM1 Web conformance requirements.

Check for changes to web.xml file

If you are upgrading Planning Analytics Spreadsheet Services (TM1 Web) to a new version, you install a new version of the web.xml file called web.xml.new and your existing web.xml file is preserved.

To take advantage of fixes applied in the new release, you must use the web.xml.new file and you must reapply any changes that you made to your previous configuration settings. In particular, restore your values for session-timeout.

Back up the existing web.xml file in <installation_location>/webapps/tm1web/WEB-INF. For example, rename web.xml to web.xml.old. This step backs up your current settings.
Rename web.xml.new to web.xml. This step uses the new version of web.xml that is supplied with the latest version of Planning Analytics Spreadsheet Services.
Replace the entry for session-timeout in web.xml with the entry from web.xml.old. This step restores any changes that you made to this property previously.
For example:
```
<session-config>
    <session-timeout>20</session-timeout>
</session-config>
```

Install Planning Analytics Spreadsheet Services

The following items are an overall checklist for installing Planning Analytics Spreadsheet Services.

Check prerequisites.
Install Planning Analytics Spreadsheet Services.
Start the IBM Planning Analytics Spreadsheet Services service.
Run and test Planning Analytics Spreadsheet Services from your network environment.
Edit the Planning Analytics Spreadsheet Services configuration file to support a multiple computer environment.
Configure the TM1 Web login page using AdminHostName and TM1ServerName parameters.
Configure authentication and data transmission security.
Modify Planning Analytics Spreadsheet Services configuration parameters.
Configure the web browsers in your environment.
Configure JVM settings for Planning Analytics Spreadsheet Services.