| width | 70% |
|---|
Baseline Concept
This could be for example a milestone, the creation of or a new branch
Baselines serve as basis for later comparison and measuring of changes within requirements.In Requirements for JIRA baselines can be created any time projects
all requirements and the baseline was created on subsequent
all fields of issue and their corresponding values.
The state complies to the revision of the issues was
| Info |
|---|
Tip: Baselines can be created through filtered tree results! |
View existing baselines
View all baselines from every projectBaselines can be compared after creation.
A comparison always consists of two baselines.
Also the baselines do not necessarily have to be created on the same project.
| width | 30% |
|---|
| Panel | ||||
|---|---|---|---|---|
On this page:
|
How to use baselines
Create a new baseline
- Switch to the tree-view of the project you want to create the baseline on
- either click on Requirements in the main navigation bar and select a project from Current Project or Recent Projects
- or Select Requirements > View All Projects from the main navigation bar and select a project from the list
- Right click the folder from the project tree you want to create the baseline on
- Select Create Baseline
- Enter a name and a description for the new baseline and click Create
Usage
Purpose | How to invoke | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Create baseline | Right click the desired folder for the baseline in the project tree view, select Create Baseline, enter the name and description of the new baseline and select Create.
| ||||||||
View all baselines | Select Requirements > View All Baselines from the |
R4J dropdown. The resulting table lists the baselines in all R4J projects. The table can be filtered and reordered by column. |
View baselines |
in a |
project |
Select Baselines in the project tree |
view. The resulting table of |
- either click on Requirements in the main navigation bar and select a project from Current Project or Recent Projects
- or Select Requirements > View All Projects from the main navigation bar and select a project from the list
| Info |
|---|
For every issue the revision history located in the issue detail view also states the number of baselines including this issue. |
Select a baseline from the list to display it's content
With the buttons above the baseline content you can
- Filter the displayed fields of all issues contained in the baseline
- Collapse all contained issues
- Export the baseline content to XML or Excel
- Add a Signature for the baseline (Note that submitted signatures are irrevocable)
Edit a baselines description
- Switch to a baseline view of your choice
- Click on the Edit icon next to the baseline you want to edit
- Enter a new description and click Edit
Delete a baseline
- Switch to a baseline view of your choice
- Click on the Delete icon next to the baseline you want to delete
- Click Delete to delete the baseline
Compare Baselines
- Switch to a baseline view of your choice
- Select the two baselines you wish to compare
- Click Compare selected baselines
Baseline Comparison Reference
Comparison Content
A baseline comparison lists all issues from the compared baselines.
For every issue all fields are listed and the values from the particular revision of the issue in each of the two baselines are compared.
If the value of a field has changed between two baselines that field is highlighted in color.
If an issue is part of only one baseline the entire issue is highlighted in color.
For the baseline that contains the issue the values of all fields are displayed.
For the other baseline an indication is displayed, that the corresponding issue isn't contained.
Filtering Comparison Results
Quick Filters
It is possible to filter the issues from a baseline comparison using quick filters.
To apply a quick filter click on the corresponding button in the baseline comparison.
To remove a quick filter click the button again.
The following quick filters can be applied:
Only Changed IssuesOnly issues that are contained in both baselines and have changed between the two baselines are displayed in the comparison.
It doesn't matter whether the left or the right baseline contains the newer revision of an issue and therefore the changes
baselines can be filtered and reordered by column. | |
Compare baselines | In the list of baselines, select the two baselines you wish to compare and select Compare selected baselines. See section Baseline Comparison for more information. |
View baseline details | In the list of baselines, select a baseline to open the Baseline Details. The baseline details are displayed from oldest to latest issue. The buttons above the details allow you to perform the following actions:
|
Edit baseline name and description | In the list of baselines, select the edit icon. |
Delete baseline | In the list of baselines, select the delete icon. |
Baseline Comparison
| Anchor | ||||
|---|---|---|---|---|
|
A comparison of two baselines lists every requirement that is in at least one of the baselines. In the case of requirements that exist in both baselines, the values of the fields in each revision are displayed side by side. Fields with different values in the baselines are highlighted. In the case of requirements that exist in only one baseline, all fields in the revision are highlighted. An indication that the requirement is missing in the other baseline is displayed.
There is an option to compare two baselines in tree view. The switch “Compare as Tree” allows the tree views and values of the issue fields in each revision to be displayed side by side. The highlights and indicators of differences in issue and field values also apply like in the list view.
| Status | ||||
|---|---|---|---|---|
|
The fields displayed in the comparison can be changed by selecting Display Fields and selecting or deselecting fields in the list.
You can enable the rendering of wiki markup in text fields by selecting Visual.
Text diffs, the red and green highlight on exact character changes, are disabled for RTE fields when using visual mode. Images are displayed with a placeholder for past revisions and baselined revisions, since Jira and R4J do not track attachment history.
The following quick filters are available for comparing baselines:
Only Changed Issues | Only requirements that are contained in both baselines and have different values for at least one field are listed. Only the fields included in the list of displayed fields are taken into consideration when determining if a requirement has changed. That is, if the value of a field is different, but the field is not included in the current setting of Display Fields, the requirement is not regarded as being changed. |
Only on Left Side | Only issues that are contained exclusively in the left baseline are displayed. |
Only on Right Side | Only issues that are contained exclusively in the right baseline are displayed. |
Filter Fields
It is possible to select the issue fields displayed in the comparison.
Click on the Filter Fields button located in the top right corner to open a list of fields available.
By default all issue fields are displayed. To remove issue fields from the comparison uncheck the corresponding entry in the list.
Click on Clear selected items to uncheck every entry of the list.
Click on Filter to apply the selection, Reset to reset the selection back to the default values and Cancel to revert the changes.
This means that although an issue might have changed between the selected baselines, it won't be displayed with the quick filter applied if the fields that received those changes aren't visible.
Baselines from different projects can be compared, but in general comparing baselines in different projects is not useful, since the two sets of items do not overlap. However, if you are practicing Requirements Reuse, comparing baselines in different projects can be valuable. For example, suppose you have a “catalog” project, consisting of standard requirements. A new project starts by including all the requirements in the catalog. A comparison of baselines in the two projects would now show no differences. As the project progresses, it replaces standard requirements with project-specific copies when the needs of the project diverge from the standard. A comparison of baselines in the two projects would now display exactly those copies and hence show how the project has diverged from the standard catalog.
Baseline Signatures
Baselines can be electronically signed. For example, a project may require that the members of its Change Control Board review the baselines of important milestones. Baselines are provided to the members via links. Each member is expected to sign off with a digital signature and mandatory free text comment (e.g. approved, rejected).
Once a signature has been submitted it cannot be changed or revoked.
Baseline Tree View
This view displays the issues and pages in the baseline as a tree, which allows better visualization and overview of the items in the baseline.
Functions in this view are limited to the following:
Select an issue, folder, or page to view its baselined details.
Issue details include all baselined fields under “Details“ section, a rendered “Description“, and a comma-delimited list of “Attachments“ and “Issue Links“.
Folder details only include the folder name and statistics.
Page details only include the page version.
Context menu in the Root Folder to “Show current in issue navigator“ redirects to the Jira issue navigator showing the issues included in the baseline.
Switch between the Baseline Flat List View and the Baseline Tree View.
Add a signature to a baseline. See Baseline Signatures.
There are limitations to older versions of R4J where positions and paths of tree items are not stored in the baseline. These cases are handled with a default display, where items without positions are displayed in the tree from latest to oldest, items without paths are displayed in the root folder and folders sorted alphabetical.