Grid Overview
  • 26 Apr 2024
  • 11 Minutes to read
  • Contributors
  • Dark
    Light

Grid Overview

  • Dark
    Light

Article summary

Introduction

This document describes the proprietary MetaManagerTM Grid seen throughout the various modules of the application.

MetaManagerTM Grid Overview

The MetaManagerTM proprietary grid provides detailed information on the content to be addressed in the applicable module. Though the grid is slightly different depending on the module, many of the actions and characteristics of the grid are the same in each module. This document will describe the common attributes and characteristics of the grid, and each individual module’s documentation will address the specifics that pertain to that module.

Grid Area

The grid area is made up of Query Rows and Object Rows.

MetaManagerTM Grid

In the example above, the following sections are examples of Query Rows:

  • Selected Reports

  • Name contains “List.”

In the example above the following sections are examples of Object Rows:

  • GO sales and Retailers.

  • Documentation Report Samples

  • Gunter Erler

When the grid contains no rows, it displays a drop label and informative text to the user.

MetaManagerTM Drop Box

Query Rows

A Query Row is a top-level blue row that represents a query to be issued against the IBM Cognos server. The query will return applicable children objects in a sub grid called Object Rows. These Object Rows will be processed when the module is run.

MetaManagerTM Query Rows

A Query Row is created by dragging the following objects to the grid:

  • Selected Reports Query Row by dragging leaf level objects (i.e. individual report(s) that are dragged from the tree to the grid).

  • Container objects such as Public Folders, Directory, Namespace, Package, Folder or Account.

  • Searches from the Search Tree or the Saved Searches area.

  • Favorite Folders (green folders).

NOTE: Dragging a favorite folder will only drop the leaf level objects in that folder. It will not drop container object in the favorite folder.

The Query Row is not loaded until it is expanded by selecting the right arrow next to the Query Row name.  Users have the option of expanding the Query Row before running the module, or running the module without expanding it first. If the user chooses to manually expand a Query Row, the query will be issued against the IBM Cognos server and the user must wait for the row to load its objects (keeping in mind that some queries can take a long time to load).

If the user expands a Query Row, they must wait for it to load before pressing the update or preview buttons. Pressing the buttons before the load is complete will display an error message.

NOTE: There is no way to cancel the loading the Object Rows once the Query Row is expanded.

After a Query Row has been loaded and the Object Rows are displayed, the user has their first insight of impact analysis (i.e. which objects are going to be processed as a result of this query). Users can take advantage of this by manually removing some of the objects that were loaded. For example, if a user wanted to update all of the reports in a folder except a few select ones, they can achieve this by dragging the folder to the grid area and expanding it, then manually deleting the few select reports before hitting the update button.

Selected Reports

Selected Reports” is a special type of Query Row, representing a general grouping for manually selected objects that are dragged to the grid and are not results from a query. The Selected Reports row is not a query, so expanding it does not execute a call to the server.  The Selected Reports row is not displayed if there are no individual objects added to the grid. In addition, the Selected Reports row cannot be refreshed.

  • The Delete button will clear all of the objects in the bucket and hide the row.

  • The Selected Reports row is automatically displayed if the user drags a report or leaf level object to the grid area and is automatically hidden when the last leaf level object is removed from the list.

A Query Row is created by dragging the following objects:

  • Selected Reports Query Row by dragging leaf level objects.

  • Container objects such as: Public Folders, Directory, Namespace, Package, Folder or Account

  • Searches from the Search Tree or the Saved Searches area

  • Favorite Folders (green folders). Dragging a favorite’s folder will only drop the leaf level objects in that folder. It will not drop container object in the favorite folder.

Object Rows

An Object Row represents a single report, query, analysis, etc... object that will be processed by the module. This row will provide the impact analysis and monitoring capabilities as to what this object will or has done during the update process.

MetaManagerTM Object Rows

Object Row Characteristics

  • An object row is loaded as a result of a query row.

  • Object rows can be manually added to the special Selected Reports query row.

  • An object row can be deleted by hitting the delete key, right clicking and selecting remove or clicking the delete button on the rightmost column.

  • An object row has 3 states.

    • Initial State

    • Previewed

    • Saved

Adding Query Rows / Object Rows to the Grid

The MetaManagerTM Portal Tree is made up of objects which can be dragged to the modules grid area. Different objects will exhibit different behaviors.

MetaManagerTM Grid

Container objects

Container objects include public folders, Directory, Packages, Folders and Accounts. These objects will be dragged as Query Rows. When the Query Row is expanded, all descendant objects that are supported in the applicable module will be loaded.

 

NOTE: Descendants includes all subfolders and not just children.

Searches

A search will be dragged as a Query Row. The search query will be “executed” and the resulting children will be displayed as Object Rows. Search results will be filtered to only create object rows for objects that the applicable module supports.

Favorite Folders

Favorite folders can be created and nested to provide users flexibility when organizing favorites. A Favorite folder can contain a Favorite folder, Content Store container (i.e. package) or a leaf level object (i.e. report, pagelet).  

 

When a Favorite row is dragged to the grid area, all of the leaf-level objects in the favorite folder and all sub favorite folders will be added to the grid. Content Store containers will not be dragged as contents of a favorite folder because this would result in confusion as to how the drop should be supported.

Groups and Roles

When accounts are dragged to the grid, MetaManagerTM processes the My Folders for the account.

 

Groups and roles, however, are not themselves container objects, but rather they are designed to organize user accounts. Therefore, the accounts organized “within” them are not truly children objects. Instead, they are referenced by the group or role, and therefore when a group or role is dragged to the grid area, MetaManagerTM will produce the list of accounts belonging to that group or role and drop a Query Row for each account.

 

NOTE: A Query Row is not generated for the group or role. Rather, Query Rows are generated for the resulting accounts of the group or role. If the grid were to be saved to file and reloaded, the same list of accounts would appear. If members of the group or role changed, the group or role would have to be re-dragged to the grid.

Leaf Level Objects

Leaf level objects include Reports, Queries, PowerPlay Cubes, etc. These objects can be dragged to the grid, and users can select multiple objects by using the multi-select features of the portal tree.

 

The leaf level objects are added to the special Selected Reports Query Row. There is no dynamic nature to these objects; if the grid is saved to file and reloaded each object will be reloaded.

Grid Buttons

Most module grids contain a Preview button and / or an Update button.

  • Clicking the Preview button will bring all of the object rows to the Previewed State. All objects will be reset to their initial state (i.e. the state stored within the Content Store) before previewing.

  • Clicking the Update button will bring all of the object rows to the Saved state. Object rows will not be reset to their initial state. If an object row is in its initial state, it will be previewed (processed) then saved. If the row has already been previewed (processed) it will not be reprocessed, instead it will simply be saved.

Grid Shortcuts

The grid supports various standard Windows shortcut keys. The following keyboard shortcuts can be used within any module of MetaManagerTM:

Reissues the query and reset the children to the full original list of objects. The refresh icon can be used if the user suspects the results of the query may have changed outside of MetaManagerTM or if the user manually deleted rows which they wish to reset.

 

Removes the query row from the grid.

 

Delete

Users can select one or more query rows with the mouse or keyboard and use the Delete key on the keyboard to remove multiple query rows.

 

Ctrl + “A”

Selects all rows in the grid.

 

Resets the grid (this button is located on the toolbar).

 

NOTE: The “New” icon may reset other UI elements as well.

 

Up / Down Arrow

Changes the current row.

 

Right Arrow

Expands a Query Row.

 

Left Arrow

Collapses a Query Row.

 

Application button

Displays the context menu. This is the “Context Menu” button available on most new keyboards.

Context Menus within Object Rows

Within the object rows, various right-click or context menus exist depending on the module and the object row selected. Below is a listing of the various context menus available.

NOTE: The various context menu items vary from module to module and within each module.

Run

This action will invoke report viewer and run the current report in the content store.

 

Preview

This action will invoke report viewer and preview the modified version of the report.

 

NOTE: Preview is not supported by PowerPlay Studio and PPES reports due to a limitation by IBM Cognos.

 

Save

This action will save the selected row to the content store. This can be used to selectively save a handful of rows instead of using the Update button. If the user now chooses the Update button to save all of the Object Rows, this Object Row will be skipped because it has already been processed to completion.

 

Remove

This button will remove the object row from the grid. When a user removes the last object in the Selected Rows query row, the query row will hide itself. This is not true for other Query Rows, even though it may be empty the user still has the ability to refresh the query row. The rows can be re-added to the grid by refreshing the Query Row. By removing the object row, it will not be processed when the user hits the Update button.

 

NOTE: Removing a row manually will flag the Query Row as a modified selection and therefore when the UI is saved to file and reloaded, this Query Row will not be re-executed. Instead, it will load the static list of children (which may adversely affect performance when loading saved .mmx files for large lists). If the user wishes to re-execute the Query Row, they must do so by hitting the refresh button on the Query Row.

 

Diff Changes

The button in this column invokes the Diff feature if a 3rd party file comparison program has been supplied. The 3rd party file comparison program is specified in the options screen.

 

NOTE: The 3rd party file comparison program must accept the 2 files on the command line as “program.exe %1 %2”.

 

If the specified 3rd party file comparison program supports it, users are permitted to edit the modified specification when viewed within the 3rd party file comparison program. This gives users the ability to make manual changes inside the 3rd party file comparison program editor. When the new specification is read in, the Object Row will be re-previewed to determine if the specification is impacted and if so, what the new current status is.

 

NOTE: The 2 files are written to the user’s temp directory and are deleted after the 3rd party file comparison program closes. Upon closing, the modified file is read in from disk and is used to replace the version in memory.

 

NOTE: WinDiff is a free file and folder comparison utility available from Microsoft but is limited in its capabilities. Other commercial applications like Beyond Compare and Ultra Compare are more robust.

 

Revalidate

This action will revalidate the original report against the content store. This is useful if the user modifies the specification outside MetaManagerTM.

 


What's Next