Configure version control (for Administrators)

To configure version control, Administrators need to modify the Evaluation Server.
  1. Install TM1 Web and go to the C:\Program Files\ibm\cognos\tm1web\webapps directory.
  2. Extract the evalservice.war file to create a directory called evalservice.
  3. In the evalservice directory, go to WEB-INF\configuration.
  4. Open the PAfE_Status_Configuration.json file. You can modify the following parameters to configure the version control mechanism:

    Name Type Purpose
    EnablePAfEStatusSystem Boolean Enables version control in Planning Analytics for Excel. Set the Boolean to “True” to turn on version control.
    SupportedPAfEVersions String Specifies supported versions of Planning Analytics for Excel. List the supported versions (example, 2.0.73.1) and separate each version with a comma.
    Note: Planning Analytics for Excel versions 2.0.70 and earlier do not support version control.
    DeprecatedPAfEVersions String Specifies the versions of Planning Analytics for Excel that will soon be deprecated. These versions are accepted by version control but compatibility check labels them as a Warning.
    PAfENormalStatusMessage String Optional - Used to add a custom message that displays in the Normal status dialog box. The maximum length for the message is 300 characters.
    PAfENeedsAttentionStatusMessage String Optional - Used to add a custom message that displays in the Blocked status dialog box. The maximum length for the message is 300 characters.
    PAfEWarningStatusMessage String Optional - Used to add a custom message that displays in the Warning status dialog box. The maximum length for the message is 300 characters.
    HideNormalStatus Boolean Optional - Prevents the Normal status from displaying in the IBM Planning Analytics ribbon. By default, it is set to “False”.
    ShowUpdateButton Boolean Optional - Displays the Update button in the status dialog box. By default, it is set to “False”.
    PAfEStatusInfoUrl String Optional - Used to add a URL to the status dialog box from where supported versions of the software can be downloaded. By default, the URL field is empty.

  5. Go to C:\Program Files\ibm\cognos\tm1web\wlp\usr\servers\tm1web\server.xml.
  6. In the id=evalservice line, change the location to the following: 
    location="${wlp.user.dir}/../../webapps/evalservice/"
  7. Restart the service by running the Windows Services program and IBM Planning Analytics Spreadsheet Services.