Configuring the update button

About this task

Administrators can configure version control in IBM® Planning Analytics for Microsoft Excel to download a specific version of the software when users click Update in a compatibility status message.

Procedure

Download the 32-bit and 64-bit Planning Analytics for Excel .xll files from IBM Support Fix Central.
Move the .xll files to a directory of your choice.
Go to C:\Program Files\ibm\cognos\tm1web\wlp\usr\servers\tm1web\server.xml.
Add the following information to the server.xml file:
```
<webApplication location=".xll file location" id="update" contextRoot="/update" name="update"></webApplication>
```
The webApplication location is the full path of the folder where you saved the .xll files.
For example, webApplication location="c:\pafe\updates".
In the evalservice directory, go to WEB-INF\configuration and open PAfE_Status_Configuration.json.
Add the names of the downloaded .xll files to PAfE_Status_Configuration.json in the following format:
"xllDownload32bitName": "hostname:portnumber/contextRoot/filename"
"xllDownload64bitName": "hostname:portnumber/contextRoot/filename"
Where the:
1. hostname is in the form of a URI, such as https://sample.hostname.ibm.com
2. portnumber is the TM1 Application Gateway port number, usually 9510
3. contextRoot is the path name defined in the server.xml file
4. filename is the name of the .xll file
The following shows an example of the configuration:
```
{
    "supportedPAfEVersions": [ ],
    "deprecatedPAfEVersions": [ ],
    "enablePAfEStatusSystem": false,
    "pafENormalStatusMessage": "",
    "pafENeedsAttentionStatusMessage": "",
    "pafEWarningStatusMessage": "",
    "hideNormalStatus": false,
    "showUpdateButton": true,
    "pafEStatusInfoUrl": "",
    "xllDownload32bitURL": "http://sample.hostname.ibm.com:9510/update/PAfESampleFile32.xll",
    "xllDownload64bitURL": "http://sample.hostname.ibm.com:9510/update/PAfESampleFile64.xll"
}
```
Set the ShowUpdateButton option to true to display the Update button in the status information.
Restart the Evaluation Server.

Results

Clicking Update in a compatibility status message downloads the version of Planning Analytics for Excel that is configured for use.