9. Baselines Topic

The Baselines topic appears in the Navigation pane when a project is open. (The topic is hidden when working in the Repository scope.) Browsing and reading Baselines with Polarion QA requires the presence of a license for Polarion ALM and/or Polarion REQUIREMENTS on the server.

Baselines capture and preserve the state of your project at some point in time. Baselines are typically created for major development milestones and for releases. It is possible to generate comparison reports that compare two baselines and report on the changes that took place between the earlier and the later baseline.

The Baseline Time Machine feature enables users using a supporting license to browse any baseline just as if it were the current project state. All artifacts appear in the state they were when the baseline was created, and queries and reports retrieve only information from the baseline.

Working with Baselines

The following sections explain how to work with the major features of baselines.

Creating a Baseline

You can create a new baseline any time you deem it necessary. Your team or company may have a policy that specifies when baselines must be captured. Basically, you should create a baseline whenever the project reaches some state that might need to be reviewed at some later time. If it turns out you really don't need some baselines, you can always delete them. You must have permissions for any baseline-related activity you want to do: creating, modifying, viewing, reporting, etc.

To create a new baseline:

  1. Open the Project for which you want to create a new baseline.

  2. In the Navigation pane, select the Baselines topic.

    The Baselines page displays a table of all existing baselines, if any. There is always a row for the current state of the project.

  3. Click the Create button in the page toolbar. The Create New Baseline dialog appears.

  4. Enter a name for the baseline in the Name field. This name will uniquely identify the baseline.

  5. In the Revision field, select a repository revision to associate with the baseline you are creating. The head revision is the default. It captures the current Head revision of the project, with all artifacts, as of the moment the system creates the baseline.

    You can create the baseline for a different revision. Select Specific in the Revision field and use the Revision Picker dialog to select the desired revision.

  6. In the Description field enter some descriptive text so that others can understand the nature of this baseline later to see if they want to use it in a baseline comparison report.

  7. Click the Finish button to create the new baseline. It now appears as a row in the Baselines table.

Modifying an existing baseline

It is possible to modify the name and/or description of an existing baseline. It is not possible to alter the artifacts captured in the baseline.

To modify an existing baseline:

  1. Open the Project that contains the baseline.

  2. In the Navigation pane, click the Baselines topic.

  3. Locate the baseline you want to edit in the Baselines page and click (Edit ) icon in the Actions column of the baseline's row.

  4. Edit information as desired and click the Finish button.

Comparing Baselines

You can generate an on-screen printable report that compares two or more baselines to each other or any baseline to the head/current revision.

To generate a baseline comparison report:

  1. Open the Project in which you want to compare baselines.

  2. In the Navigation pane, click the Baselines topic.

  3. In the Baselines page, select two baselines you want to compare by checking the box on the relevant baseline's row in the table. If you want to compare a baseline against the head revision, check the Head/Current row and the desired baseline's row.

  4. Click the Compare to generate the comparison report.

The baseline comparison report job launched. You can check the status of the job in the Monitor topic. When the report generation job is finished, a row is added to the table of reports in the Comparison Reports section of the Baselines page. This section is hidden by default. Click Show Comparison Reports to reveal or re-hide the section. The Actions column provides 2 actions for the generated report: Remove and Show Report.

Viewing Baselines Comparison Reports

Note

Viewing with Polarion QA requires presence of a Polarion ALM or Polarion REQUIREMENTS license on the server

The selected baseline comparison report displays as a modal dialog after you click the Show Report action in the table of generated reports. The report contains several sections:

  • Timepoints compares activity in Timepoints between the revision(s) and/or baseline(s).

  • Categories compares activity in Categories between the revision(s) and/or baseline(s).

  • Work Items compares activity in Work Items between the revision(s) and/or baseline(s).

  • Plans compares activity in Plans (changes of Plan fields and added/removed Work Items) between the revision(s) and/or baseline(s).

TIP

You can expand and collapse each section using the icon at the right-hand edge of its title bar.

Browsing, Searching, and Reporting Baselines

Note

Viewing with Polarion QA requires presence of a Polarion ALM or Polarion REQUIREMENTS license on the server

The Baselines Time Machine feature is so-named because it literally enables you to go back in time and browse, search, view or run reports in a baseline just as if the baseline were the current project state. The main differences are that no artifacts can be changed, and current artifacts that did not exist at the time of the baseline do not appear when browsing and will not be found by searches or report queries.

To enter a baseline via Time Machine:

  1. Locate the baseline you want to explore in the Baselines page (Navigation > Baselines).

  2. Click on the name of the baseline in the Name column.

You are now browsing the project in the state it was when the baseline was captured. You can always tell that you are working in a baseline by the banner showing the baseline name, which appears in Navigation below the project name.

To exit the baseline and return to the current project state, click the closer on the baseline banner in Navigation.

Figure 9.1. Baseline Banner

Baseline Banner

A banner in Navigation signifies that you are working with the project in the Time-Machine