Requirement Selection and Views in QVscribe

Configuring Summary Analysis Using Filters in QVscribe for Polarion

When using QVscribe for Polarion, the QVscribe Analyzer will perform Analysis on any work item that has a description. To control what work items are included in the analysis, simply use the filter feature within Polarion.

Use the filter feature to control the specific work items in the summary analysis.

This feature currently supports Live Doc and Table Views.

Note: Using a filter on a Live Doc will put all items in the “read only” state, thereby causing the QVscribe authoring buttons to disappear on individual work items. As described above, Summary Analysis can be done, but authoring on individual work items cannot be done under these conditions.

Configuring Polarion for Document View

Enabling Authoring View for Work Items

QVscribe for Polarion offers the ability to open a specific work item while in Live Doc view. To use this feature the “status” of the work item must be active and visible within Polarion to see the QVscribe icon.

To enable this feature, follow the steps below.

  1. While in Live doc view, click the dropdown arrow next to the work item icon and choose “Configure”

2. Next to each work item type, there is a button titled “Select Fields”

3. If “Status” is not already in the right-hand box, find and select it in the left-hand box titled “Available Fields”, then click “Add”. “Status” will now be highlighted in the right-hand box. 

4. In the options underneath the selected fields, enable “Show in the Sidebar and Document”.  . There are two icons to represent where the status icon will appear. Set the status to “Show At” at the bottom right of the requirement, which is the icon on the right side.

5. Finally, select Render as “Icon & Text”

Save your settings as default to allow the QVscribe Authoring View Icon to be displayed when viewing work items in Live Doc View.

Summary View in QVscribe for Polarion

When viewing a Work Item with QVscribe for Polarion installed, the QVscribe icon will be displayed to the top right of the query filter. Selecting this icon will open the QVscribe Summary view for all analyzed requirements.

The summary view is organized into 3 key sections.

Quality Score Summary

This section will display all analyzed requirements within the selected Work Item. Each requirement will be categorized according to their level of risk. Selecting any of the score bars will navigate users to the Quality Analysis section filtered for the selected quality score.

At the bottom of this view, you can select the icon to change from the quality score summary to display the same requirements broken down by the specific quality issues.

Quality Warnings

The Quality Warnings sections will display the requirements that have issues that QVscribe recommends additional attention or review.

 

Selecting any of the warning categories will navigate users to the Quality Analysis section filtered for the selected quality warning.

Summary Navigation

The Navigation section provides easy access to the various analysis types available in the summary view.

Selecting any section from the navigation pane will display the associated analysis views available in the summary view.

This section also includes the overall score for all analyzed requirements in the selected Work Item.

Editing/Authoring in Summary View

Users will have the ability to edit/author requirements within the Summary view. This can be done when you open a requirement within the Quality Analysis.

Once you open up a requirement, you will see an icon in the top right beside the requirement. You can click this icon to edit/author the requirement.

This icon will bring you to your authoring/editing window. Click the pencil icon to edit the requirement, then you can edit the text within Polarion or click the QVscribe icon to edit within QVscribe.

This brings you to the authoring view, where you can make changes/edits. The QVscribe analysis will update to your changes showing you whether your score is improving.

 

Authoring View in QVscribe for Polarion

While viewing a Work Item with QVscribe for Polarion installed, when an item is in “Draft” status  for a specific work item, the QVscribe icon will be displayed.

QVscribe also provides the ability to open the authoring view in document view. Work Items that are editable will see the QVscribe icon next to the status of the work item.

Work Item text

If this QVscribe icon is clicked you will enter the QVscribe authoring view. This section provides access to the text of the work item with any alerts highlighted and colour coded. 

Within 2 seconds of any changes to the text, QVscribe will automatically rerun the quality analysis updating the score and any associated alerts according to the active configuration. You can also re-run similarity and unit consistency analyses by selecting the “re-run” icons that will appear.

Once the text updates are complete, simply close the QVscribe authoring view to update the text in the work item. 

Note: QVscribe will not commit any changes to Polarion. It will be important to complete your changes in Polarion as you normally would.

Alerts

The alerts section will identify all associated alerts with the selected text. Red alerts indicate issues that are affecting the quality score of the requirement while yellow alerts provide warnings recommending additional attention.

Selecting any of the alerts will expand the alert, displaying additional information about the alert for the author’s consideration.

Filters

The filters section provides users with the ability to filter the specific alerts that are displayed in the Authoring View. 

Selecting any of the alert categories will filter the alerts, displaying only the selected category. 

Additionally, the filter section provides the quality score for the requirement and also displays the link to select from a number of EARS Templates.  See QVscribe for Polarion EARS Templates section for more details.