Customizing the Project Management page
The Project Management page includes links for business documents and project
milestones. Preparing this page for your project may involve activities such as
the following:
- Uploading a project plan to the Project Dashboard tool and working with
schedules and tasks in that tool.
The Schedules and
Tasks links in the Activities area (light blue background) of
the Project Management page are stable links to the Project Dashboard tool.
Once Project Dashboard is configured for this project these links become
operational. These links display the Project Plan milestones for the project.
These are tasks that have an effort value of 0 in an .mpp file. The view
presented on these queries is limited to only the upcoming Lifecycle Task
milestones for the next four weeks. If there are none, you receive an error
message. See the help on Project
Dashboard for details.
- Customizing the display names of the Target Milestone attribute that is
associated with various lifecycle artifacts in Project Tracker, and making
corresponding changes in the Lifecycle Artifact Milestone table on this page.
The links in this table are Project Tracker queries that return all
artifacts due at each milestone. You may want to change the display names of
the milestones. If you make significant changes to the lifecyle artifacts, you
may want to change the lifecycle artifact milestone queries
- Customizing the Work Products links on this page.
For example, you may
need to add a URL to launch an IT governance system report and upload
documents to the landing page for IT governance documentation.
Note: If your project does not require particular functions
on this page, you can delete the information or you can delete the entire page.
Contact your domain administrator for details.
Updating the lifecycle artifact milestones
A default set of lifecycle artifact types is provided with the CollabNet
Baseline Project template. A number of these artifact types have a Target Milestone
attribute. For example, requirements and defect reports can have target
milestones. The CollabNet Baseline Project template supplies ten Target Milestone values.
A project template administrator may have edited the display names for the
target milestones. If additional changes were made to the lifecyle artifacts,
the template administrator may have edited the query links in the milestones
table.
In general, these milestones should be adequate for your use. Or, you may
only want to make minor changes. For example, you can edit the display names for
the Target Milestone attribute and make corresponding changes in the Lifecycle
Artifact Milestones table. Or, you may want to change how many milestones are
displayed in the table. In either of these cases, you edit the HTML for the
table.
If the Target Milestone attribute may not suit your purposes, or you need to
make additional changes to the lifecyle artifact types at the project level. If
this is the case, you will need to customize the Target Milestone attribute
display name and edit the following characteristics of the table that contains
the milestones:
- The names of the milestones and number of milestones - If
you want to change the names of the milestones that are displayed to the user,
or add milestones, you need to customize the Target Milestone attribute in
Project Tracker.
- The queries associated with each milestone - If you
change the lifecycle artifact associated with the Target Milestone attribute,
you will need to replace the query links in the table. Or, if you add
milestones, you will need to add a row and an associated query to this table.
To edit the Target Milestone attribute for this project:
- Click the Projects page.
- Click the link for the project where you want to change the Target
Milestone attribute.
- Click Project Tracker > Manage artifact types in the
left navigation pane.
- Click the link for one of the artifact types that uses the Target
Milestone attribute, for example, the Requirement artifact type.
- Click the link for the Planning and Execution attribute
group.
- Click the link for the CNALM-Target-Milestone attribute.
- Edit the display names for the values of the CNALM-Target-Milestone
attribute.
To capture the query URL for the new target milestones:
- Click the Projects page
- Click the link for the project that where you want to update the
milestones table.
- Click Project Tracker > Query Artifacts in the left
navigation pane.
- Click Create New.
- Click Advanced Query.
- Selecting the artifact type or types that you want to return on the query.
- Select the Target Milestone attribute value that you want to match on this
query.
- When the query results produce the desired result, copy the query results
URL from the browser address bar.
- Paste the URL into a text file.
To update the Lifecycle Artifact Milestone table on the Project Management page:
- If you have not done so already, use Subversion to check out the project
template directory.
For example, you may check out
My-Project/trunk/www/cn-project-pages
Where My-Project
is the name of the project you are working on.
- Use Subversion to update the Project Management top.html snippet.
For
example, using Subversion, this will be in
My-Project/trunk/www/cn-project-pages/Project
Management/snippets/top.html
- Open the top.html file in an editor.
- 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&otherTemplate=UserList.vm
&action=Search &pageNum=1 &queryId=&refine=
. . .
&col=51%2C101%2C53&coldelim="true">View Activities Due</a>)
</td>
<td>To Be Determined</td>
<td>Not Started</td>
</tr>
- Paste the query results URL in the appropriate location in the Activities
area or a table.
For example, to update a URL in the Activities area, find
the appropriate list item below the <!-- Start Activity Box --> comment,
for example:
<li><a href="/servlets/Scarab/remcurreport/true/template/
Search.vm?nextTemplate=IssueList.vm&action= Search&eventSubmit_doSearch=Search&
grp=si&si=&qattdelim=true&it=3&mitdelim=true& col=11%2C13%2C2&coldelim=true"
title="View all requirements that have been eliminated from consideration">
All excluded </a></li>
Note: The pasted URL
will not be pretty.
- Remove the prefix for the query URL.
The prefix is http or
https://project.domain, where project is the name
of the project where the query was captured and domain is the domain
where the project resides. The URLs should begin with "/servlets/Scarab".
- Ensure that special characters in the URL are escaped. For example, replace all instances of
ampersand ("&") with the
HTML tag "&".
- Add information in a title attribute to display a tool tip when the user
places the cursor over the activity link.
- Commit the changes using your version control tool.
Configuring the schedule and tasks links
If your project has a file named milestones.txt in the snippets directory for the Project Management page, and you have enabled Project Dashboard for the project, a Task Milestones table will appear. This table will display information based on the Task Manager. In the Activities area displayed either below the page navigation toolbar or at the top of the page (with the light blue background), there will also be functional links that display the Project Dashboard schedules and tasks.
Important: If you want to upload an .mpp file to Project Dashboard, you must be sure
that two Subversion integrations settings are turned off for the project. Click
the project link on the Projects page, click Edit project > Tool configuration, then
turn off the Message must name artifact and Committer must own artifact settings in the Subversion section of the page.
To learn more about configuring Project Dashboard:
- Click the Projects page.
- Click the link for the project for which you want to configure Project Dashboard.
- Click the Project Dashboard link in the left navigation pane.
- Click the relevant topic in the How do I. . . Help panel.
Adding links and document upload tables
You can add new links in the activities area. You can create landing pages for the links, and these landing pages can contain documentation tables with upload buttons to this page. This can be convenient if you expect many documents to be uploaded and you want to avoid clutter on the main page for a subpage or a page.
The CollabNet Baseline project template automatically creates a process documents table with associated buttons and browse dialogs for uploading documents when you create a subdirectory of a subpage or a page that itself contains a subdirectory named documents.
You can add links, landing pages, and document upload tables based on an existing structure in the project template, or you can create this information from scratch.
Adding a link and landing page based on an existing structure
The easiest way to create a new link with a landing page and document table is to copy an existing one. For example, to add a link and an associated landing page and documentation table to the Product Management page, you could follow the steps in the following procedure.
To add a link and landing page based on an existing structure:
- Copy an existing link-and-landing-page structure.
For example, if you are using the default CollabNet Baseline Project template, you can copy the following directories, renaming the it-governance directory but retaining the names of the snippets and documents directories and top.html:
trunk/www/cn-project-pages/Project Management/it-governance/snippets/top.html
trunk/www/cn-project-pages/Project Management/it-governance/documents
- Copy and paste the corresponding link in the activities area to create a new link that points to the directory structure that you created in the previous step.
This link is in the Project Management/snippets/top.html file. For example, in the activities table for the Product Management page, copy and paste the link for IT governance:
<li><a href="/cn-project-pages/Project%20Management/it-governance" title="View a page with links to IT governance documents">IT governance</a></li>
Rename the link text and the link destination
to match the new directory structure you created, for example, as follows:
<li><a href="/cn-project-pages/Project%20Management/new-directory" title="View and upload status reports">Status reports</a></li>
- Edit the content of the new-directory/snippets/top.html file to match the information in the new link.
- Using Subversion, add and commit your changes.
Adding a new link and landing page "from scratch"
You can create a new link with a landing page and document table from scratch. For example, to add a link and an associated landing page and documentation table to the Product Management page, you could follow the steps in the following procedure.
Note: In the following procedure, the links in the activities area refer to a nonexistent index.html file. This is a required part of the syntax for adding links and landing pages. The actual index.html is constructed by CollabNet from the top.html and bottom.html snippets that you create.
To add a link and landing page "from scratch":
- Create a subdirectory of the landing page where you want to put the new information, and in that subdirectory, create two subdirectories named snippets and documents.
For example, you can create the following subdirectories of the Project Management page:
trunk/www/cn-project-pages/Project Management/new-directory/snippets
trunk/www/cn-project-pages/Project Management/new-directory/documents
- Create a top.html and bottom.html file in the snippets subdirectory:
trunk/www/cn-project-pages/Project Management/new-directory/snippets/top.html
trunk/www/cn-project-pages/Project Management/new-directory/snippets/bottom.html
- Create the corresponding link in the activities area to create a new link that points to the directory structure that you created in the previous step.
For example, in the activities table for the Product Management page, this link would be in the Project Management/snippets/top.html file. Create a link that points to the new directory:
<li><a href="/cn-project-pages/Project%20Management/new-directory" title="View and upload status reports">Status reports </a></li>
- Edit the content of the new-directory/snippets/top.html file to match the information in the new link, for example, create a heading that matches the link display text.
- Using Subversion, add and commit your changes.
Customizing the work products links
On the Product Management page, there are sample links in the Activities area
(the light blue background) to various work products:
- IT governance documents
- Your IT governance system
A template administrator may have replaced these links with live data. For
example, clicking the IT governance system link may launch this system. However,
if this has not been done, you should configure these links.
To upload IT governance system documents:
- Click the Projects page and click the link for the project
where you want to add this documentation.
- Click Project Management on the page navigation toolbar
or in the left navigation pane.
- In the Work Products column of the Activities area (light
blue background), click View IT governance documents.
- On the IT Governance page, click Upload document.
- Browse for the file and click Save.
To configure the work products link to the IT governance system:
- If you have not done so already, use Subversion to check out the project
template directory.
For example, you may check out
My-Project/trunk/www/cn-project-pages
Where My-Project
is the name of the project you are working on.
- Use your version control tool to update the Project Management top.html
snippet.
For example, using Subversion, this will be in
My-Project/trunk/www/cn-project-pages/Project
Management/snippets/top.html
- Open the top.html file in an editor.
- In the section for work products, edit the following link:
<div class="launch_icon">
Launch systems:
</div>
<!-- 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 -->
For example, you might substitute the following:
<li><a href="http://www.your_url_here.com/"
onclick="window.open(this.href); return false;"
title="Go to a Web-enabled requirements management application">
Requirements system</a></li>
- Use
onclick="return launch(this.href, 1);" to have the link open in a small new window.
Use onclick="window.open(this.href);" to have the link open in a normal-sized new window.
Edit the title to change the tool tip that appears when the user moves the cursor over this link.
- Submit your changes.