JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

CodeSonar® 9.2p0 CONFIDENTIAL CodeSecure Inc
General

GUI Reference: File Search Results

Displays the results of file searches.

Files in the list of search results can involve any language or languages, provided the files satisfy the search constraints.

For the results of searches in other domains, see Search Results.

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

Navigating to

The File Search Results page can be reached in any of the following ways.

From Advanced Search: Execute an advanced search in the Files tab.
From Chart: Click on a region of a chart (if the chart is by "Number of Files").
From Chart Table: Click on a line in a table (if the table is by "Number of Files").
From the Simple Search Tool: Execute a search with a domain/scope setting that specifies the files domain.
From Source Listing
(within a browse sequence):		 If the File Search Results page is an establishing page for a file browse sequence, each Source Listing page that belongs to the sequence will also provide a browse sequence navigation link to the File Search Results page.

Page Properties

Output formats CSV, JSON, XML (file_search.xsd)
Visibility Filter Applied Visible Files
RBAC Permissions Needed
Page AccessANALYSIS_READ
PROJECT_READ
Page Contents/FunctionalityANALYSIS_READ
NAMEDSEARCH_WRITE
PROJECT_READ
For more information, see Searching: Permissions.

Contents and Usage

The following annotated screenshot shows the various parts of the File Search Results page.

annotated screenshot: Search Results page standard header breadcrumbs page heading save link Other Domains suggestions table of results standard footer

Standard Header See GUI Reference: Standard Header.
Breadcrumbs Home > [Other_ProjectTree_Ancestors >] Proj_Name > Analysis_Name > File Search Results
Home > [Other_ProjectTree_Ancestors >] Proj_Name > File Search Results
Home > File Search Results
depending on whether or not the search was restricted to a specific analysis or specific project, where
  • Home links to the GUI Home page.
  • Together with the Home link (corresponding to the root project tree), Other_ProjectTree_Ancestors represents the project tree ancestors of the analyzed project as a >-separated sequence of project tree names. Each name links to the corresponding Project Tree page.
  • Project_Name is the name of the analyzed project, and links to the corresponding Project page.
  • Analysis_Name is the name of the analysis to which the search was restricted (if any), and links to the corresponding Analysis page.
Page Heading Proj_Name : Analysis_Name : Search Results : Filess
Proj_Name : Search Results: Files
Search Results: Files
depending on whether or not the search was restricted to a specific analysis or specific project, where Project_Name and Analysis_Name are as described for the page breadcrumbs.
Save link Expands to provide functionality for saving the current search. See Save a Search for full details.

Saved file searches are available (subject to NAMEDSEARCH_EXISTS permissions) in several GUI locations:

  • The Files tab of the Advanced Search page provides a list of saved file searches: select a search from this list to execute it in its original scope (unless that scope no longer exists: see Searching: Saved Search Execution Scope: Files).
  • The Files tab of the Saved Searches page provides information about the current set of saved file searches, and provides deletion functionality. Click a row in the table of searches to execute the corresponding search in its original scope (unless that scope no longer exists: see Searching: Saved Search Execution Scope: Files).
  • The Visible Files selector provides a list of saved file searches: select a search from this list to impose the corresponding constraints on the page contents. The effect of the Visible Files selection is independent of the original scope of the search.
'Other Domains' suggestions Shortcut links to execute the same query in different domains.
  • One link is provided to for every domain to which the search query is applicable.
  • If the search is not applicable to any other domains, this section is not included.
Table of results A table describing all files that match the search conditions.
Standard Footer See GUI Reference: Standard Footer.

Saving a Search

See Searching: Saved Searches: Permissions for details of the permissions required to save a named search.

To save a search:

  1. Click to open the Save form, as in the example below.

    Annotated Screenshot Fragment: Save This Search link, with expansions

  2. To save the search, enter a name in the text box and click Save.

Navigating from

view a shortcut chart for the result set Select from the Charts > sub-menu in the table menu.
view a source file listing Click the corresponding line in the result table. The Source Listing will belong to a browse sequence for which the originating File Search Results page is the establishing page.

Related Tasks

 

To report problems with this documentation, please visit https://support.codesecure.com/.