Common Grid Functionality

Modified on Wed, 19 Jan 2022 at 02:35 PM

TABLE OF CONTENTS

Introduction

 

Most of the functionality in ManagementStudio is centered around a Common Grid format across all of the main modules. They include: Applications, User Migrations, Devices, Deployment Units and the Bespoke Module.


Each Module is divided into the following areas:

  1. Grid Filter - A list of the workflow steps, plus options to view by Blueprints, Defects etc
  2. Ribbon - Various functions broken down in sections such as Segments and Reports
  3. Toolbar - Grid-based functions for filtering, grouping and exporting data
  4. Grid - This displays a filtered list of items (such as applications) in the module


This document describes the functionality of each of those common areas. For a more detailed look at each of the modules, please refer to the appropriate module page.


Grid Filter

The Grid Filter shows the workflow steps which have been configured for the module. A count of the total number of items is shown under All Items. The number of items in each process is also shown.


By clicking on an individual process in the Grid Filter, the Grid (4) is updated to show only the items in that process. 


The Grid Filter also provides the ability to view the items filtered by:

  • Process (1)
  • Blueprint (2) 
  • Defect (3) 
  • Survey (4) 
  • Test Sign-Offs (5)
  • Dependencies (6)

These options are accessed from the highlighted panel below:


Process (1)

Filter the items by the workflow step. This is the default view and is useful where all items in a particular process step need to be reviewed.


Blueprint (2) 

Filtering by Blueprint allows you to add two Blueprint folders or Blueprints to the grid, then filter the grid items by these Blueprints. In addition, this filter add two columns to the Grid, showing which Blueprints the items belong to. 


To use the Blueprint filter:

  • Click on the Blueprint Filter button (1)
  • Add one or more Blueprint Folders or Blueprints to the Group A by clicking on Add to Blueprint Group A (2) then choose the Blueprint
  • Add one or more Blueprint Folders or Blueprints to the Group B by clicking on Add to Blueprint Group B (3) then choose the Blueprint
  • Click one of the four buttons (4) depending on your preference:


Button
Items Displayed
Show items in A and/or BThis option will show all the items which belong to either Blueprint. If an item is in neither A or B it will not be displayed.
Show items in A with B removedThis option will show the items in A and remove the items from that list which are in B.
Show items in A and B onlyThis option will only show items which are in both A and B. Items in only A or only B will not be displayed.
Show items in A or B, but not bothThis option will show the items which are in either A or B, but if they are in A and B they will not be shown


In the screenshot above, two Blueprint Folders were added to Group A, one was added to Group B and the Show items in A and/or B button was clicked. This resulted in the Grid being updated to only show items in either of those Blueprint folders. If an item wasn't a member of either of the Blueprint Folders, it was not displayed in the Grid.


Defects (3) 

This Grid Filter shows items based on whether they have a defect or not, and the status of the defect such as Open or Pending

  1. Click the Defects button
  2. Choose a Defect Status
  3. The items with that defect status will be displayed in the grid

In the screenshot above there are four items (in this case Applications) with defects.


Survey (4) 

This Grid Filter shows items based on whether they have a survey or not, and the status of the survey such as Pass or Fail

  1. Click the Surveys button
  2. Choose a Survey Status
  3. The items with that survey status will be displayed in the grid


In the screenshot above there are two items (in this case User Migrations) with surveys which have passed.


Test Sign-Offs (5)

This Grid Filter shows items based on whether they have a Test Sign-Off or not, and the status of the sign-off such as Pass or Fail. Note that this filter will only be available if the Testing tab has been enabled for that module, and at least one test has been defined.

  1. Click the Test Sign-Offs button
  2. Choose a Test Sign-Off Status
  3. The items with that status will be displayed in the grid


In the screenshot above there are one item (in this case User Migrations) with Compatibility Tests which have passed.


Dependencies (6)

This Grid Filter shows items based on whether they have a Dependency or not, and the status of the Dependency such as In Progress or Ready. Note that this filter will only be available if the Dependency tab has been enabled for that module.

  1. Click the Dependency button
  2. Choose a Dependency Status
  3. The items with that status will be displayed in the grid


In the screenshot above there are two items (in this case User Migrations) with Dependencies which are In Progress.


Ribbon

The Ribbon provides some common functionality across all the modules:

  • Segments
  • Reports

The ribbon also provides functionality specific to that module. For example, in the Applications module there is the option to switch to Pending Applications


This help page covers the common functionality. The specific functionality is covered in each module's help page:

Applications


Segments


The buttons in the Segment area of the Ribbon provide "filters" on the main grid. Note that these button are not cumulative. i.e. if you click My Applications then click Processes -> 1. Identified the My Applications filter is removed.


This is in contrast to the combination of the Process Filter and the Segments which are cumulative. i.e. You 


These are the buttons which are available in the Segments ribbon. Note that some of these options may not be available depending on which module you are in, and which options have been setup for that module.


ButtonFunction

All Applications/Devices etc.

Shows all the items in that module. This is useful when you have applied a Segment, and want to then return to seeing all the items.
My Applications/Devices etc.Shows items which are assigned to you
ProcessesShows items in a specific Process
BlueprintsShows items in a Blueprint folder or Blueprint. Selecting a Blueprint Folder rather than a Blueprint can be useful in situations where you want a less specific filter
TeamsShow items assigned to a specific user
DropdownsShows items with a specific dropdown value. Example: This is useful in Applications where you are searching for all the Applications with a Priority 
Test Sign-OffsShows items which have a specific test result. This is useful in Applications where you want a list of all the applications which have passed (or failed) the "Desktop Application" test type.
SurveysThis shows all the items which have a specific Survey outcome such as "Pass" or Fail". This is useful for User Migration filtering
Defects and TasksThis shows all the items with a specific Task or Defect status. This may be useful for example where you are interested in all the Applications which have outstanding Defects, or all the Deployment Units which have completed Tasks. For more information on Tasks refer to this article:
https://support.managementstudio.com/a/solutions/articles/14000122464
Custom FormsThis option allows items to be shown which have a certain value in a Custom Form. For example, in Applications it may be useful to search for any item which has a Active Directory Group with "APP" in the name. This could be achieved by setting the Segment filter as follows:
Other FiltersOptions available in "Other Filters" are:
  • Dependencies - show items with any dependencies
  • Locked - show items which are Locked
  • Archived - show items which are Archived
  • Deleted - show items which have been Deleted are are pending final  
Search DatabaseBy App Id
This option provides a way to filter the list of items to those with a specific set of IDs. This is useful where a known list of IDs has been copied from a source such as Excel or Notepad, and those items need to be viewed in the grid.

By Custom Id
This option provides a way to filter the list of items to those with a specific set of Names.


Reports

For information on Reports refer to this set of articles:

https://support.managementstudio.com/a/solutions/categories/14000074748/folders/14000126379?view=all


Toolbar

The Toolbar provides the ability to change the visible items in the Grid. 



ButtonFunction
1. Refresh GridRefreshes the items currently being displayed in the grid. Useful for when those items have been updated but the grid is showing the old values. This button has an additional option called Reload Grid which will clear any Filters or Segments which have been applied
2. 3.Search Grid Allows dynamic filtering of the grid based on a text search. Note that multiple search terms (separated by a space) can be entered here to search for multiple text strings within the grid dataset
The button to the right of the Search Grid will clear all filters.
3. Show/hide Group By barThis button turns on/off the Group By bar. This enables a column header to be dragged into that bar to group by that column

This option is useful where there's a requirement to "pivot" the data by one of the data fields, for example Application Priority when viewing Applications:


Note that there are additional options available by clicking the arrow to the side of the button for:

  • Expand All Groups - Opens all the groups to view all grouped items
  • Collapse All Groups - Closes all the groups
  • Toggle Group Footers - Turns the footers on/off which show item counts
4. 5. Select AllThis button will select all the items currently displayed in the grid. 

Note that there are additional options available by clicking the side of the button for:
  • Select None - Select no items
  • Invert Selection - Switch the selection to the inverse
5. CopyThis button copies data fields from the selected items into the clipboard. When clicked the following dialogue is presented:

By default all the columns will be copied. However, by clicking on each column name it's possible to select which fields are copied. Use the Select All or Select None buttons to select all or none of the data fields.

Clicking Copy copies those data filed to the clipboard (with headers). Alternatively, clicking the arrow to the side of the Copy button provides additional options:
  • Copy - No header - This copies the data without the data headers
  • Copy - Comma Separated - This option is only available when one data field is enabled for copying. It allows all values of that data field to be copied, separated by commas
  • Copy - Space Delimited - This option is only available when one data field is enabled for copying. It allows all values of that data field to be copied, separated by spaces


There are addition options available in the arrow to the right of the toolbar button:

  • Copy to Clipboard (Selected) - This option will copy the selected items to the clipboard (this is the same as clicking Copy)
  • Export to Excel (All) - This option will export all the items from the grid (as per current filters) into Excel file format. A file name and location will be required.
  • Export to CSV (All) - This option will export all the items from the grid (as per current filters) into CSV file format. A file name and location will be required. 
6. PivotThis option enables the data in the grid (all the items, not just the selected items) to be exported into a pivot table. The example below shows a pivot of Device data, with the count of Operating System:

There are addition options available in the arrow to the right of the toolbar button:

  • Pivot to Table - This provides the same function as the Pivot button
  • Pivot to Chart - This allows a pivot chart to be created from the items in the grid
7. Column PickerThis button enables columns to be added or removed from the grid. Note that these changes are not persisted; the default columns will be displayed when the client is restarted.
8. Reset Grid LayoutThis button will reset which columns are displayed in the grid, along with the filters and sort order, to the default configuration.https://support.managementstudio.com/support/solutions/articles/14000127464-common-grid-functionality#Toolbar
9. NewThis button will create a new item (Application, Device etc). It is useful when a low volume of items need to be created manually.

For bulk imports refer to this article:
https://support.managementstudio.com/support/solutions/folders/14000127637
Show Details Panel Below
This button opens a panel at the bottom of the window displaying the selected item's Details tab. The other tabs for that item can also be accessed.

When the Details Pane is enabled, two addition buttons are made available in the toolbar. These provide a way to cycle through different items, up or down:

Alternatively, items can be selected in the upper part of the window in the main grid, and the details displayed in the lower pane.

Clicking the Show Details Panel button a second time closes the panel.
Show Details Panel to Right
This button opens a panel to the right of the window displaying the seleted item's Details tab. The other tabs for that item can also be accessed.

When the Details Pane is enabled, two addition buttons are made available in the toolbar. These provide a way to cycle through different items, up or down:

Alternatively, items can be selected in the left-hand side of the window in the main grid, and the details displayed on the right.

Clicking the Show Details Panel button a second time closes the panel.
Guided Tours
Where available, clicking this button will open a short guided tour of the module.
Help
The Help button opens context-sensitive help.




Further Support

If you require further support, please visit ManagementStudio's Service Desk to search the knowledge base or create a new support ticket.