Coding and building

You can use the subpage for the Code & Build subpage of a project to complete the following tasks:

Finding requirements and action items that are relevant to the Code & Build subpage

The following procedures describe how to find requirements and action items that are relevant to the Code & Build subpage.

To view requirements associated with the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build icon on the Page Navigation toolbar or the Code & Build link in the left navigation pane.
  4. In the Requirements column of the activity area, click one of the following:
    Note that the activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background:
    Add new - To enter a requirement that may be considered for inclusion in the product.
    View active requirements flagged for discussion - View requirements that have a Flagged for Discussion attribute value that is set to "Yes" and a Status attribute value of Submitted, Accepted, Started, On hold, or Reopened.
    View active requirements ready for code & build - To view requirements that have been proposed for the coding but have not yet officially been accepted into this subpage. For requirements that appear when you click this link, the value of the subpage in Lifecycle attribute is Code & Build, and the value of the Accepted into Current subpage attribute is No. The value of the Status attribute is Submitted, Accepted, Started, On hold, or Reopened.
    View active requirements currently in code & build
    - To view requirements for which coding work can start or is in progress. For requirements that appear when you click this link, the value of the subpage in Lifecycle attribute is Code & Build, and the value of the Accepted into Current subpage attribute is Yes. The value of the Status attribute is Submitted, Accepted, Started, On hold, or Reopened.
    View active requirements in any stage - These requirements contain Status attributes with one of the following values selected: Submitted, Accepted, Started, On hold, or Reopened.

To view defects associated with the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build icon on the Page Navigation toolbar or the Code & Build link in the left navigation pane.
  4. In the Defect Reports column of the activity area, click one of the following.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
    Add new - To enter a new defect that may be considered for this release.
    View active defect reports flagged for discussion - View defects that have a Flagged for Discussion attribute value that is set to "Yes" and a Status attribute value of Submitted, Accepted, Started, On hold, or Reopened.
    View active defect reports currently in code & build - To view defects that have been deemed necessary to be fixed. For these defects, the value of the subpage in Lifecycle attribute is Code & Build, and the value of the Accepted into Current subpage attribute is Yes. The value of the Status attribute is Submitted, Accepted, Started, On hold, or Reopened.
    View active defect reports ready for code & build - To view defects that have been found but have not yet officially been accepted into this stage. For these defects, the value of the subpage in Lifecycle attribute is Code & Build, and the value of the Accepted into Current subpage attribute is No. The value of the Status attribute is Submitted, Accepted, Started, On hold, or Reopened.
    View active defect reports in any stage - These defects contain Status attributes with one of the following values selected: Submitted, Accepted, Started, On hold, or Reopened.

To view action items associated with the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build icon on the Page Navigation toolbar or the Code & Build link in the left navigation pane.
  4. In the Action Items column of the activity area, click one of the following.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
    Add new action item - To enter an action item, for example, conducting a code review or uploading a nightly build results document.
    View active action items that are flagged for discussion - To view action items that have a Flagged for Discussion attribute value that is set to "Yes" and a Status attribute value of Submitted, Accepted, Started, On hold, or Reopened.
    View active action items that are specific to code & build - To view action items that have an Action Item Type attribute value of Code & Build, and a Status attribute value of Submitted, Accepted, Started, On hold, or Reopened.
    View active action items of any type - To view action items that have a Status attribute value of Submitted, Accepted, Started, On hold, or Reopened.

Adding and modifying requirements, defect reports, and action items on the Code & Build subpage

In the Code & Build phase of a project, you code new features, fix bugs, and indicate features that are ready to be promoted to the Testing phase.

During this phase, there may be one or more additional tasks that you need to complete. You can add tasks, for example, reminders to conduct code reviews.

To add a requirement, defect, or action item on this subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build link on the Page Navigation toolbar or in the left navigation pane.
  4. Click Add new in the activity area, in either the Requirement, Defect Report, or Action item column.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Enter the required information for the requirement, defect, or action item.
  6. If prompted, click Next.
  7. For a defect, in the Application Lifecycle section, select Code & Build from the subpage in Lifecycle drop-down list.
    For a requirement, in the Application Lifecycle section, select Definition from the subpage in Lifecycle drop-down list. (Typically, new requirements should be assigned to the beginning of the lifecycle.)
    For an action item, in the Submission Information section, select Code & Build from the Action Item Type drop-down list.
    This ensures the artifact is returned on a query issued from the Code & Build subpage.
  8. Click Save Changes.

To indicate that a requirement or defect has been accepted into the project and coding can begin:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build link on the Page Navigation toolbar or in the left navigation pane.
  4. In the Requirements or Defect Report column in the activity area, click the Ready for Code & Build link.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. From the query results page, click the link for the requirement or defect that you want to accept into the coding subpage.
  6. Ensure the following settings are applied to this artifact:
    The value of the subpage in Lifecycle attribute set to Code & Build.
    The value of Accepted Into Current subpage? is set to Yes.
    The value of the Status attribute set to Submitted, Accepted, Started, On hold, or Reopened.
  7. Click Save Changes.
    You can now view this artifact by clicking the Currently in Code & Build query link on the Code & Build landing page.

Indicating when a requirement is ready for testing

To promote a requirement to the next stage of the process, you change the value of its subpage in Lifecycle attribute. This causes the attribute to be returned on the stage-specific query for the stage that you select.

To move a requirement or a defect from Code & Build to the Testing subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build icon in the Page Navigation toolbar or the left navigation pane.
  4. Click the Currently in Code & Build link in the Requirements or Defect Report column of the activity area.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
  5. Select the requirement or defect that you want to indicate as being ready for coding.
  6. In the Application Lifecycle section, select Testing from the subpage in Lifecyle drop-down list.
    Note that the Accepted Into subpage? attribute will be reset to No when you do this.
  7. Click Save Changes.

Reading and creating code and build documentation

You can access project documentation from a Documentation table on the Code & Build subpage. If you are responsible for authoring code or build documents, you can download templates for these documents from this page and upload draft or completed documents to this page. You or the project administrator can also add new documentation templates to the list.

If you have a content developer role in the project (or have both VersionControl - Commit and VersionControl - Add permissions granted by an administrator), you can also add information to this page as well as view this page. However, the project administrator may prefer to take requests for additions to this page and be the sole person who actually performs the updates.

The Documentation table on this page contains a View other project documents link. Clicking this link is equivalent to clicking the Documents and files link in the left navigation pane.

Important: If you experience any difficulty uploading documents on this page, ask your project administrator to be sure that two Subversion integrations settings are turned off for the project. The administrator should click the project link on the Projects page, clickEdit 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 view project documentation on the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build link on the Page Navigation toolbar or the left navigation pane.
  4. Scroll to the Process Documents table.
  5. Click the link for the document that you want to read.

To download a project document template from the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build link on the Page Navigation toolbar or the left navigation pane.
  4. In the Process Documents section, click the View document templates link.
  5. Click the link for the template that you want to edit.
  6. Save this file locally and edit it.

To add or update a project document on the Code & Build subpage:

  1. Click the Projects page.
  2. Click the link for a project that uses a project template.
  3. Click the Code & Build link on the Navigator.
  4. In the Process Documents section, click the Upload document link.
  5. Browse to the document that you want to upload.
  6. Click Save.
    Note that this document is saved in the project's version control repository. If you want to rename or delete this document, you must use your version control client.

Viewing and adding work products

On the Code & Build subpage, there are links in the activity area to various work products. The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.

A project administrator may have replaced the link to the build system with live data. However, if this has not been done, you can configure these links. You can also add code or build documents at any time.

To upload code and build documents:

  1. Click the Projects page and click the link for the project where you want to add this documentation.
  2. Click Code & Build on the Page Navigation toolbar or in the left navigation pane.
  3. In the Work Products column of the activity area, click View code & build documents.
    The activity area is either directly below the Page Navigation toolbar or at the top of the page. It is the area with a light blue background.
  4. On the Requirements Documents page, click Upload document.
  5. Browse for the file and click Save.

To configure the work products link to the build system:

  1. 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/
    Where My-Project is the name of the project you are working on.
  2. Use your version control tool to update the Code & Build top.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Code&Build/snippets/top.html
  3. Open the top.html file in an editor.
  4. 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 -->
    <ul>
    <li><a href="/nonav/cn-project-pages/help/customizing_alm_links.html" 
         onclick="return launch(this.href, 1);" title="Go to a Web-enabled build application 
         [Note: link may open in new window]" class="helplink">Build system</a></li>
    </ul>

    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 Build application">
    Requirements system</a></li>
    As shown in the example, you can change onclick="return launch(this.href, 1);" to onclick="window.open(this.href); return false;" to make the link open in a normal-sized browser window instead of the smaller-sized window.
    Remove onclick="return launch(this.href, 1);" if you do not want the link to open a page in a new browser window.
    Remove or edit title="Go to a Web-enabled build application [Note: link may open in new window]" if you do not want text to appear in a tool tip when the user moves the cursor over the link.
    Remove class="helplink" if you do not want the cursor to be a question mark icon for this link.
  5. Submit your changes.

Customizing the Resources links

At the bottom of the Code & Build landing page, you can provide information that points users to any other information that you think is relevant.

To edit the Resource Links table:

  1. 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/
    Where My-Project is the name of the project you are working on.
  2. Use Subversion to update the Code & Build bottom.html snippet.
    For example, using Subversion, this will be in My-Project/trunk/www/cn-project-pages/Stages/Code & Build/snippets/bottom.html
  3. Open the bottom.html file in an editor.
  4. In the section for resource links, edit a row in the table, such as the following:
    <tr class="a">
    <td>Customizing the ALM Baseline Project Template</td>
    <td><a href="http://www.collab.net/training/alm/Customizing_ALM.doc" onclick="window.open(this.href); return false;" title="Note: link may open in new window">http://www.collab.net/training/alm/Customizing_ALM.doc</a></td>
    </tr>

    For example, you can remove onclick="window.open(this.href); return false;" if you do not want the link to open a page in a new browser window.
    Or, you can remove or edit title="Note: link may open in new window" if you do not want text to appear in a tool tip when the user positions the cursor over the link.
  5. Alternate between class="a" and class="b" to provide different shades of gray in the table.
  6. Using Subversion, update this file and commit the changes.