Tips for TM1 Proven Practices


During our training and integration projects on IBM’s TM1, we see some common challenges that many TM1 users, and admins face. One of those is the “persisted views” function. TM1’s web client has a feature that persists the orientation of cube views and charting options across sessions. This means that a user can re-orient their grid, select any of the charting options, close TM1 Web, and then return to their application later on and see the same presentation. However, there are times when you may want to reset the views for all users of the application at various points in the planning cycle to ensure that all users are returned to the default view. The following are some tips on re-orienting cube views and charting options.

These tips for Versions TM1 10.2 or newer

Users can choose to return to the default view orientation using the “Reset View” menu item in TM1 Application Web as shown below.

Solution

The persistence of the user’s chosen orientation is achieved by the creation of private views that are stored in the TM1 server data directory. The private views are created in a sub-folder that follows the user’s name and the name of the relevant cube. TM1 Application Web also creates files with a .blb extension that store information on the charting options being used for a particular view. These files are usually stored in the root of the TM1 data directory, and not in the user-specific path.

Every TM1 application is given a unique identifier known as a GUID. The GUID can be found in the URL of the TM1 application’s workflow page. Image below shows this URL containing the a GUID of {8a808556-0604-462d-8471-cbc5a22573bc}. Note that some GUIDs are enclosed in bracket characters and others are not.

A TM1 application GUID in a URL

The private views and .blb files related to an IBM Cognos TM1 application also contain the application’s GUID. The image below shows the GUID used in the file name of a private view that has been created for the Cambridge node of the Staff Plan cube for user Jones and it relates to the TM1 Application whose unique identifier is {8a808556-0604-462d-8471-cbc5a22573bc}.

The GUID used in the filename for a private view

Additionally, a .blb file relating to the charting options selected by user Jones for the Staff Plan view has been placed in the root of the IBM Cognos TM1 data directory. The image below shows the GUID being used in the various components of the .blb file name.

The GUID used in the filename for a .blb file

The scripts below can be executed from the command line, to first find any private view files and .blb files matching a given unique identifier, and second to delete the files that were found. Before using these scripts, please note the following:

  • Before these scripts are executed on your TM1 system, the TM1 Administrator must ensure that the TM1 database is backed up.
  • All users should be logged out of the system. If users are not logged out when the deletion script is run, then the private views will be persisted when the user re-opens the TM1 Application Web client, even if it appears that the .vue files have been successfully deleted.
  • The script to list the files to be deleted should be run and the results carefully verified before the corresponding script to delete the private views is run.
  • The TM1 Application Server uses .blb files to store information concerning the TM1 applications within your environment. Be careful not to delete any of these files in error.

Script to find relevant private view and blb files

Enter the following commands into a text file and name it FindPrivateViews.cmd.

  • dir %1\%2.blb /s /b | sort /R > “%3”
  • dir %1\%2.vue /s /b | sort /R >> “%3”

To obtain a list of the targeted files that you can review, open a command prompt, browse to the location of this file and then run it, providing the necessary parameters as follows:

  • FindPrivateViews <TM1 server path> *[}tp_tasks}{8a808556-0604-462d-8471-cbc5a22573bc* PrivateViews.txt
  • <TM1 server path> is the location of your IBM Cognos TM1 server data directory, enclosed in double quotes if it contains spaces.
  • *[}tp_tasks}{8a808556-0604-462d-8471-cbc5a22573bc* is the wildcard search string that looks for objects with the relevant Application GUID
  • PrivateViews.txt is the output file containing the list of .vue and .blb files that are found. It is written to the same directory as the FindPrivateViews.cmd file. Please ensure you have review the contents of PrivateViews.txt to ensure that you have identified only the correct views.

It’s important to prefix the wildcard search parameter (the second argument passed to the batch file) with [}tp_tasks}.

To delete relevant private views and blb files us this script

Enter the following two lines into a text file and name it DeletePrivateViews.cmd.

  • for /f “usebackq delims=” %%f in (`”dir %1\%2.vue /s /b | sort /R”`) do del /p “%%f”
  • for /f “usebackq delims=” %%f in (`”dir %1\%2.blb /s /b | sort /R”`) do del /p “%%f”

Only execute this script once you have verified the list of files that you output previously. Execute it with first parameter being the IBM Cognos TM1 server path and the second parameter the wildcard representing the IBM Cognos TM1 Application GUID:

  • DeletePrivateViews <TM1 server path> *[}tp_tasks}{8a808556-0604-462d-8471-cbc5a22573bc*

By default, this script will prompt you before deleting each of the files it finds. If you have very many files and you do not wish to be prompted, you may remove the /p switch from the del functions in the script.