GUI Reference: Warning and File Browse Sequences

• Introduction
• Navigating Browse Sequences
• Browse Sequence Changes
• When Problems Occur

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Introduction

Where possible, the CodeSonar GUI will provide warning browse sequences. A warning browse sequence facilitates stepping through Warning Reports for the warnings in a recently-viewed table without needing to navigate back and forth to the table. Similarly, the GUI will provide file browse sequences that facilitate stepping through Source Listings.

Warning Browse Sequences

A Warning Report will belong to a warning browse sequence if one of the following is true.

• It was navigated to by clicking a table entry in an Analysis: Warnings tab or Warning Search Results page.
  Then it belongs to a warning browse sequence consisting of:
  • the set of warning instances contained in that table (ignoring table pagination),
  • in the order in which they appear.
• It was navigated to by clicking a <Prev or Next> link in another Warning Report.
  Then it belongs to the same warning browse sequence as the originating Warning Report.

Warning Report pages that belong to a browse sequence will include browse sequence navigation links relative to that sequence.

File Browse Sequences

A Source Listing will belong to a file browse sequence if one of the following is true.

• It was navigated to by clicking a table entry in an Analysis: Files tab or File Search Results page.
  Then it belongs to a file browse sequence consisting of:
  • the set of file instances contained in that table (ignoring table pagination),
  • in the order in which they appear.
• It was navigated to by clicking a <Prev or Next> link in another Source Listing.
  Then it belongs to the same file browse sequence as the originating Source Listing.

Source Listing pages that belong to a browse sequence will include browse sequence navigation links relative to that sequence.

Terminology

We use the following general terminology.

Summary

The following table summarizes the properties of the available browse sequence kinds.

Navigating Browse Sequences

If a Warning Report belongs to a warning browse sequence (or a Source Listing belongs to a file browse sequence), navigation links for the browse sequence will be displayed in the page heading.

Page Type	Browse Sequence Navigation Links
Warning Report	<Prev Navigate to the Warning Report for the previous warning in the browse sequence. If the first (or only) warning is shown in the current Warning Report, this option is not available. numw of numtotal Navigate to the establishing page for the warning sequence. numw is the sequence position of the warning shown in the current Warning Report. numtotal is the total number of warnings in the browse sequence. Next> Navigate to the Warning Report for the next warning in the browse sequence. If the last (or only) warning is shown in the current Warning Report, this option is not available. A Warning Report that belongs to a warning browse sequence will also offer a Save and Next button alongside the Save changes button in its Change Warning form.
Source Listing	<Prev Navigate to the Source Listing for the previous file in the browse sequence. If the first (or only) file is shown in the current Source Listing, this option is not available. numw of numtotal Navigate to the establishing page for the file sequence. numw is the sequence position of the file shown in the current Source Listing. numtotal is the total number of files in the browse sequence. Next> Navigate to the Source Listing for the next file in the browse sequence. If the last (or only) file is shown in the current Source Listing, this option is not available.

Browse Sequence Changes

Browse sequences are based on the search and sort queries used to construct the establishing page. The results of these queries may change while you are browsing the sequence.

• The set of pages in the sequence can change. For example, if the establishing page for a warning browse sequence showed active warnings, the contents of the browse sequence will be changed if someone changes the State of one of those warnings to Fixed.
• The ordering of pages within the sequence can change. For example, if the warnings in a warning browse sequence are sorted by Owner, changing the Owner of one of those warnings can change its position within the browse sequence.

In many cases, the browse sequence can be seamlessly adapted to reflect these changes. If it cannot, CodeSonar will provide a mechanism for reestablishing the browse sequence as described below.

When Problems Occur

There are two main problems that can affect browse sequences: substantial sequence changes and session loss.

Problem: Substantial Sequence Change

In some cases the browse sequence may undergo changes substantial enough that it cannot be automatically adapted. If this happens, CodeSonar will display a message next to the browse sequence navigation links, including a link to the establishing page for the sequence.

To reestablish the sequence:

1. Use the link provided to navigate to the establishing page.
2. Choose a table entry to open a Warning Report (or Source Listing, for file browse sequences) that belongs to the browse sequence.
   You should now be able to browse through the sequence using the navigation links.

Problem: Session Loss

User sessions can be lost in various ways, including the following.

• A session can time out (or be deliberately stopped by a user with sufficient credentials).
• An anonymous session will be discarded in favor of a signed-in user session if you sign in.
• A signed-in user session will be discarded in favor of an anonymous session if you sign out.

If a user session is lost, browse sequence information associated with that session will also be lost. CodeSonar will display an error message indicating that it could not maintain the browse sequence, but will generally not be able to provide a link to the establishing page. However, the establishing page may still be available in your web browser history.

To reestablish the sequence:

1. If possible, use your web browser history to navigate back to the establishing page.
   Otherwise:
   1. Manually navigate to an establishing page.
      • If the browse sequence was based on the contents of a Warning Search Results or File Search Results page, perform the corresponding search again.
      • If the browse sequence was based on the contents of an Analysis page Warnings or Files tab, navigate to the Analysis page and then choose the appropriate tab.
   2. Select your desired visibility filter.
   3. Perform any required table sorting.
2. Choose a table entry to open a Warning Report (or Source Listing, for file browse sequences) that belongs to the browse sequence.
   You should now be able to browse through the sequence using the navigation links.