Customizing the CollabNet Baseline Project pages

The CollabNet Baseline Project template also provides these pages:

You can delete or customize these pages.

Adding, deleting, and reordering pages

The cn-project-pages directory in the project-templates project contains one or more directories whose names are formed of an integer, a dash, and an ordinary name. For example, the following is a standard cn-project-pages directory:

      cn-project-pages
         Stages
              Definition
              Design
              . . .
         Project Management
         Communications
         Metrics and Reporting
         Integrations

The directories named Stages, Project Management, Communications, and so on appear on the top Navigator toolbar and as links in the left navigation pane, as follows:

Each page can contain either content or subpages and icons (but not both).

You can add and delete subpages and pages. The directories that contain the pages are named as you want them.

A top-level directory for a page can contain one of two types of information, but not both:

If a top-level category contains second-level categories, the top-level catgory can only contain content in the form of a description.txt snippet. This file can contain the text for the category's tool tip.

To add, delete, or reorder pages:

  1. Navigate to the CollabNet Baseline Project directory or a custom template.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the template directory. If you create a project that is based on asuch a template, you can modify the template in the www directory for that project.
  2. If you are adding a page, copy an existing page directory in this structure to a new directory and use the n-tabname naming convention to name this directory.
    For example, if you want to add a new page that appears before the Stages page, you could add the following directory: project-templates/trunk/www/templates/My-Process/cn-project-pages/NewTab. If you are deleting a page, you delete the corresponding directory.
  3. Renumber the other directories as needed.
    For example, using the above example of adding a new Stages subpage at the beginning, you would edit the remaining directory names as follows:
    project-templates/trunk/www/templates/My-Process/cn-project-pages/NewTab
    project-templates/trunk/www/templates/My-Process/cn-project-pages/Stages
    project-templates/trunk/www/templates/My-Process/cn-project-pages/Project Management
    project-templates/trunk/www/templates/My-Process/cn-project-pages/Communications
    project-templates/trunk/www/templates/My-Process/cn-project-pages/Reporting and Metrics
    project-templates/trunk/www/templates/My-Process/cn-project-pages/Integrations
  4. If you are adding a page, use the add function of Subversion, then update any modified files.
  5. Commit all changes using your version control tool.

Customizing the Project Management page

The Project Management page displays the following information:

You can customize the following information on the Project Management page:

To edit the lifecycle artifact milestones table on the landing page for Project Management:

  1. Click the Projects tab and click the link to a project that uses the template that you want to modify.
  2. Click Project Tracker > Query artifacts in the left navigation pane.
  3. Create a query to view the milestone artifact display names.
    In all likelihood, you edited these display names shortly after creating the new project template.
  4. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the template directory.
  5. Use your version control tool to update the Project Management directory.
  6. Edit snippets/top.html.
  7. Find the appropriate table and edit the link text to match the milestone names that you have provided in Project Tracker.
  8. Replace the query for this milestone, as described in the following procedure.

To add a query to the lifecycle artifact milestones table on the landing page for Project Management:

  1. Click the Projects tab and click the link to a project that uses the template that you want to modify.
  2. Click Project Tracker > Query artifacts in the left navigation pane.
  3. Create a query that returns artifacts that have a particular value set for the Milestone attribute (or the equivalent, if you have modified the default Milestone attribute).
    For example, you might create a query that returns all requirements that have the Milestone set to Milestone 2.
  4. Copy the query URL in the address bar.
  5. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  6. Use your version control tool to update the Project Management directory.
  7. Edit snippets/top.html.
  8. Edit the links in the Milestone table on this page.
    For example, you might edit the following:
    <tr class="a"> 
     <td>Milestone 1 (<a href="/servlets/Scarab/tqk/1/remcurreport/true/template 
     /AdvancedQuery.vm? nextTemplate=IssueList.vm&amp;otherTemplate=UserList.vm  
     &amp;action=Search &amp;pageNum=1 &amp;queryId=&amp;refine=  
     . . .
     &amp;col=51%2C101%2C53&amp;coldelim="true">View Activities Due</a>)  
     </td> <td>To Be Determined</td>  
     <td>Not Started</td>  
     </tr> 
  9. Paste the new query URL, following the guidelines described in To edit or create an artifact type definition.
  10. Ensure that special characters in the URL are escaped. For example, replace all instances of ampersand ("&") with the HTML tag "&amp;".
  11. To ensure that the shading of the rows of this table alternates between light and dark grey, check the class attribute on the TR tag and ensure that these tags alternate between "class=a" and "class=b".

Customizing the Communications page

The Communications page displays the following:

You can customize the following information on the Communications page:

To customize the Project Team table on the Communications landing page:

  1. Navigate to the project template directory.
    For example, you may go to trunk/www/My-Process
    Where My-Process is the name of the project template directory.
  2. Use your version control tool to update the Project Management directory.
  3. Edit snippets/top.html.
  4. Replace the generic entries in the project team table with the names of team members.
    To ensure that the shading of the rows of this table alternates between light and dark grey, check the class attribute on the tr tag and ensure that these tags alternate between "class=a" and "class=b".
  5. Replace the default links.
    The following links point to a help page: <td>[<a href="/nonav/cn-project-pages/help/customizing_alm_links.html" onclick="return launch(this.href, 1);" title="Note: link may open in new window" class="helplink">Link - TBD</a>]</td>.
    <!-- onclick="return launch(this.href, 1);" makes the link open in a small new window -->
    <!-- Use onclick="window.open(this.href); return false;" to make the link open in a normal-sized new window -->
    <!-- Edit the title to change tool tip -->
    <!-- Remove class="helplink" to prevent question mark cursor -->
    You can substitute a new URL in the HREF tag, or you can hard-code information in this table.
  6. Using your version control tool, update top.html.
  7. Using your version control tool, submit your changes.

To customize the WebEx link on the Communications landing page:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use your version control tool to update the Project Management directory.
  3. Edit snippets/top.html.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Communications/snippets/top.html
    Where My-Project is the name of the project you are working on.
  4. Using Subversion, update top.html.
  5. Open the top.html file in an editor.
  6. Edit the link for scheduling a WebEx session to lead to your organization's WebEx page.
    For example, you might add the following:
    <td><a href="http://mycompany.webex.com>"</a> onclick="window.open(this.href); return false;">Schedule</a> an upcoming WebEx meeting</td>
  7. Commit the changes using your version control tool.
  8. Using your version control tool, commit your changes.

To customize the chat link on the Communications landing page:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use your version control tool to update the Project Management directory.
  3. Edit snippets/top.html.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Communications/snippets/top.html
    Where My-Project is the name of the project you are working on.
  4. Using your version control tool, update top.html.
  5. Open the top.html file in an editor.
  6. In the table with the Communications heading, edit the link for launching IRC.
    For example, you may need to edit the following link:
    irc://us.undernet.org/beginner
  7. Edit the link for viewing the IRC Web site.
    For example, you may need to edit the following link:
    http://en.wikipedia.org/wiki/Internet_relay_chat

Customizing the Metrics and Reporting page

The Metrics and Reporting page enables users to view Excel reports on active and historical work items in a project such as requirements. For example, a user can view a graphical report that shows how many requirements are still in definition, how many are being designed, how many are in coding, and so on.

You can customize the following information on the Metrics and Reporting page:

Note: The Excel reports generated from the Metrics and Reporting page can only work if basic authentication is enabled. These reports do not work on sites that use certificate-based authentication.

Customizing the Integrations page

The Integrations page allows you to use CollabNet as a launching point for third-party tools that your users may need. A requirement for using a third-party tool is to set up a Web server where people can point their browsers and use the tool. The main activity of integrating CollabNet with these tools consists of entering the URL to your configured application.

You can customize the following information on the Metrics and Reporting page:

To modify the CruiseControl results link:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use Subversion to update theIntegrations/CruiseControl/cruise-control-results directory.
  3. Using your version control tool, add and commit a build results file to this directory, or overwrite any existing documents in this directory.
    The build results table is automatically updated.

To modify the CruiseControl system link:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use Subversion to update the Integrations/CruiseControl/
  3. Edit top.html in the snippets directory, updating the following link:
    <ul>
    <li><a href="/nonav/cn-project-pages/help/customizing_alm_links.html" onclick="return launch(this.href, 1);" title="Go to the CruiseControl machine [Note: link may open in new window]" class="helplink">CruiseControl system</a></li> </ul>
  4. Update the information in the title area if you want to display a tool tip when the user's pointer hovers above the link.

To modify the TestDirector defect links:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use Subversion to update the Integrations/TestDirector directory.
  3. Edit top.html in the snippets directory, updating the links to the Project Tracker queries in the TD Defects (read only) table.
    See Customizing the lifecycle artifacts and queries for details.

To modify the TestDirector test results links:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use Subversion to update the Integrations/TestDirector/ptest-director reports directory.
  3. Using your version control tool, add and commit a results file to this directory, or overwrite any existing documents in this directory.
    The results table is automatically updated.

To modify the TestDirector application links:

  1. Navigate to the project template directory.
    For example, you may go to project-templates/trunk/www/templates/My-Process/cn-project-pages
    Where My-Process is the name of the project template directory.
  2. Use Subversion to update the Integrations/CruiseControl/ directory.
  3. Edit the top.html in the snippets directory, updating the following link in the Launch Systems column:
    <ul>
    <li><a href="/nonav/cn-project-pages/help/customizing_alm_links.html" onclick="return launch(this.href, 1);" title="Go to TestDirector [Note: link may open in new window]" class="helplink">TestDirector system</a></li>
    </ul>
    <!-- onclick="return launch(this.href, 1);" makes the link open in a small new window -->
    <!-- Use onclick="window.open(this.href); return false;" to make the link open in a normal-sized new window -->
    <!-- Edit the title to change tool tip -->
    <!-- Remove class="helplink" to prevent question mark cursor -->
  4. Update the information in the title area if you want to display a tool tip when the user's pointer hovers above the link.