Understand your Cognos Content Store database using Content Manager Size and Browser Tools

Read-only GUI tools for simplified access to Content Store database information

Comments

Cognos Content Manager tools - An overview

For many Cognos 8 or Cognos 10 administrators, it sometimes seems that the Content Store database is growing substantially for "no good reason". Obviously there is a reason; however, it may be difficult to pinpoint the cause without the proper tool to help you. Let's use the Content Store as an example. Most of the objects saved in the Content Store database are presented in Cognos Connection. These objects are displayed nicely for end users to navigate, but there is no interface available for administrators to see an overall view of all the existing objects that could contribute to the size of the Content Store database. The frustrations from customers have inspired us to come up with the IBM Cognos 8 or Cognos 10 Content Manager Size Tool, "CMSize," a stand-alone Eclipse project that queries the Content Store database to get a summary of the number and size of various objects. The results are then displayed in a simple format. This tool also provides the option for administrators to select any area of the Content Store to query (Public Folders, for example), a specific folder, users' My folders, and types of objects to query (for example, reports, queries, jobs, deployment, and so on).

If Cognos administrators run this tool regularly and save the results to a file each time, they have the ability to compare these files to find out what has changed. This can give an idea of why the Content Store database keeps growing and the administrator can take actions based on the comparison results.

A Cognos 8 or Cognos 10 SDK developer on the other hand may be more interested in finding out properties of various objects in the Content Store. A quick browse to get property settings can help developers quickly identify what is available and what can be changed programmatically using SDK toolkit. The IBM Cognos 8 or Cognos 10 Content Manager Browser Tool ("CM Browser") reports detailed information for all objects in the Content Store database.

These tools run with product version IBM Cognos 8.4.1 and above.

Content Manager Browser Tool - A detailed look

The CM Browser allows the user to graphically view each object within the Content Store database and view its properties and respective value settings. There is also a search feature that allows you to locate all occurrences of objects containing a user defined string. Detailed information on system requirements, running the tool, and feature descriptions are documented in the IBM Cognos 8 or Cognos 10 Content Manager Browser Tool.pdf file, which is included in the tool download.

Table 1. Features and tools available in the CM Browser
Feature / ToolMenu item / IconDescription
Preferences Window > Preferences
  • Change and apply settings for
    • Content Manager URL
    • soapaction
    • BI Bus Namespace
  • Restore defaults
Log onLog on
  • Uses IBM Cognos 8 or Cognos 10 log-on credentials
  • Can change and save a different default Content Manager URL and namespace
  • Anonymous namespace will not require a log on
Log offLog off
  • Logs off the current session
Test Content Manager connectionTest
  • Tests the entered Content Manager URL
  • Saves the entered Content Manager URL
  • View the End User License Terms of Use
High-level or detailed displayed propertiesProperty                             display type
  • Toggle between retrieving and displaying a small set of properties and all properties
    • High-level - a small set of properties
    • Detailed - all properties
RefreshRefresh
  • Deletes all current data in the browser tree
  • Retrieves data from Content Store
  • Refreshes the browser tree
Search toolSearch tool
  • Search for string in the Content Store and reports all occurrences
  • Scope categories
    • Administration
    • Capability
    • Configuration
    • Directory
    • Portal
    • Public Folders
    • Transient
  • Search for all objects in a scope
  • Case-sensitive and -insensitive search
  • Set maximum records to be checked (5000 recommended)
  • Select a result to expand it in the tree for easy identification
HelpHelp
  • Displays the IBM Cognos 8 or Cognos 10 Content Manager Browser.pdf reference file
Property menu itemsProperty menu items
  • Right-click to select a property value
  • Right-click again to display action menu items
    • Copy - puts the selection value on the clipboard for paste
    • View in Notepad - displays the full selection value in Notepad

Figure 1 is a sample screenshot. The CM Browser Tree is displayed in the left-side panel. Each node represents an object and its hierarchy. The right-side panel displays the property name and property value for the object selected in the CM Browser tree.

Figure 1. Object property values - Detailed view
Object property                     values - Detailed view
Object property values - Detailed view

Figure 2 is a sample screenshot of the Search Tool dialog box. In this example, the string "cube" has been entered as the search criteria, the Scope "Public Folders" is selected, the Case Sensitive box is not checked, and the Record Read Limit is set to "5000".

Figure 2. CM Browser Search Tool
CM Browser Search Tool
CM Browser Search Tool

This search has the following results:

  • Only the first 5000 records in the Program Folders are read
  • The string "cube" is searched for regardless of the case
  • The results window displays statistics at the top of the list number of records read and the number of matches found
  • The results window lists each property that contains the string "cube"

To view a property in the CM Browser tree, select a property, and click on the Expand Selection button.

This tool can be downloaded here.

Content Manager Size Tool - A detailed look

The CMSize Tool reports the size and the count of all objects in the Content Store database. Within a specified search scope and type of objects, it displays the count, approximate size, and search path of the objects.

Table 2. Features and tools available in the CM Browser
FeatureMenu item / Icon / ButtonDescription
Preferences Window > Preferences
  • Change and apply settings for
    • Content Manager URL
    • soapaction
    • BI Bus Namespace
  • Restore defaults
Log onLog on
  • Uses IBM Cognos 8 or Cognos 10 log-on credentials
  • Can change and save a different default Content Manager URL and namespace
  • Anonymous namespace will not require a log on
Log offLog off
  • Logs off the current session
Test Content Manager connectionTest
  • Tests the entered Content Manager URL
  • Saves the entered Content Manager URL
  • View the End User License Terms of Use
Save to fileSave to file
  • First click - creates a file and saves the query result
  • Subsequent clicks - appends the query result to the file
Save to new fileSave to new file
  • Allows you to change to or create a new query result file
RefreshRefresh
  • Resends the current request
  • Refreshes the display panel
HelpHelp
  • Displays the help file
BackBack
  • Takes you back to the previous page
Drill downDrill down
  • Shows details of the children objects for the highlighted parent object
SendSend
  • Sends a request to the Content Store for the first set of objects
NextNext
  • Sends a subsequent request to the Content Store for the next set of objects
Copy searchpathCopy searchpath
  • Copies the selected searchpath text to the clipboard

Figure 3 is a sample screenshot of the Object Size tab:

Figure 3. CMSize Object Size tab
CMSize Object Size tab
CMSize Object Size tab

The Scope selection sets the search criteria. The options are:

  • Public Folders - all objects in the public folder
  • My Folders - all objects under all accounts in the current namespace
  • Deployment Folder - all import/export files in the deployment folder
  • Other - all objects in a user defined search path

The Max Objects parameter allows you to set the maximum number of objects accessed for each query.

The Objects selection sets the type of objects you would like to query. The options are:

  • Analysis
  • Query
  • Report
  • Report View
  • Model
  • Jobs
  • Retention Rules
    • Operator - "=", ">", "<"
    • Retention Filter - enter a number representing the object retention rule (0 is unlimited)
  • Deployment - if scope is set to Deployment Folder

The query results display:

  • Object Name
  • Count - total count of the displayed objects
  • Size - total size of the displayed objects which will be the same as the LOB field in your content store database
  • Search Path - the search path of the displayed object

Figure 4 is a sample screenshot of the Object Count tab:

Figure 4. CMSize Object Count tab
CMSize Object Count tab
CMSize Object Count tab

The Scope selection sets the search criteria. Currently, the only selection available is Root.

The parameter set in Display Object Count >= specifies the filter on the object count in the query.

The query results display:

  • Class - a sortable list of object types
  • Count - a sortable list of object counts

This tool can be downloaded here.


Downloadable resources


Related topic


Comments

Sign in or register to add and subscribe to comments.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Big data and analytics, Information Management
ArticleID=330983
ArticleTitle=Understand your Cognos Content Store database using Content Manager Size and Browser Tools
publish-date=08142008