How-to Create A Single Product Dashboard

Goal

We want to create a portal that will display only the information for one chosen Bugzilla product. All portlets, regardless of their “restrictTo” property will report on only that product. The following shows a restricted portal.

Single Product Portal

Estimated Time Required

Between 2 minutes for a pre-defined portal and 10-30 minutes to define a new portal and add it to Bugs Dashboard.

Business Value

Allow a project team to focus on all the details about their specific project.

Prerequisites

  1. Installation and configuration of the Bugs Dashboard as detailed in the How-to Install and How-to Configure pages
  2. Define the product name to which you wish to restrict the portal. This may be done using the names off one of the existing portlets or by selecting from Bugzilla’s products table.
  3. If you are creating a new portal, you will need the list of portlets you wish to use on the portal along with their characteristics. This can best be obtained by collecting the information from existing portlet property files that shipped with Bugs Dashboard (e.g. projectA_portlets_en_US.properties).

Process For An Existing Portal

There are two methods for restricting an existing portal, however, we do not recommend you use the restrictTo property of the portlets. We will focus here on the restricting the entire portal through the portal’s restrictTo method. This is safer as someone could add more portlets later and miss the restriction.

  1. Stop the Servlet container (i.e. stop Tomcat)
  2. Navigate to the /webapps/bugs/WEB-INF/classes directory under Tomcat.
  3. Edit the portals_en_US.properties file (or the appropriate localized file for your country and language).
  4. Find the appropriate portal you wish to restrict by its title. If appropriate, change the title to reflect the product.
  5. Move to the last line for that group which will say “portalX.restrictTo=” where X is the sequential number for the group of characteristics.
  6. Enter the name of the product you wish that portal to be restricted to.
  7. Save and close the file.
  8. Start Tomcat

Process For A New Portal

While this process calls for creating a new portal, we are going to leverage as much pre-existing work as possible. We will copy values within the portals property file as well as copy a portlets file as our starting point for the new configuration.

  1. Stop the Servlet container (i.e. stop Tomcat)
  2. Navigate to the /webapps/bugs/WEB-INF/classes directory under Tomcat.
  3. Edit the portals_en_US.properties file (or the appropriate localized file for your country and language). Any time we add a portal, we must add it to the portals_en_US.properties file. There is only one of these whereas there is a separate portlets file for each portal defined with this file.
  4. Copy the last group in the portals property file and then paste it right back to the file.
  5. Increment the number of the last group, then change the total number of portlets at the top of the file. This will insure that you do not miss this important step when you finish the last property.
  6. Change the properties to those that you want for this portal. When it comes to the cascading style sheet and style, you should be able to leverage an existing css file. There’s one included with every download for a 2 column and three column portal. However, if you wish to change the widths, copy the css files that match the number of columns, rename them and change the percentages.

    You want to set the “restrictTo” value to the product name from the Bugzilla products table that you want this portal to report on.
  7. The portlets property in the portals property file must point to a file containing the listing of portlets and their properties which you wish to see for this product. There are five property files that ship pre-defined for the Bugs Dashboard. These are “projectA” through “projectF” properties (e.g. “projectA_properties_en_US.properties”). If you wish to use a different set of portlets, copy one of the default sets that most closely matches your desired set. Add or remove portlets to create the set you wish to use. You may move portlets from other property sheets to your property sheet to create the full set you wish to use. Don’t forget to update the total number of portlets at the top of the portlets property sheet if you make changes!
  8. You are now ready to restart Tomcat and test your new portal!