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: Manage Warning Processors

This page allows the Administrator to enable and disable warning processors, and to add new warning processors.

Permission requirements for warning processor operations are discussed in Warning Processors: Permissions.



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

Navigating To

From Settings: In the Other Links tab, click Manage Warning Processors.
By URL: http://hub_location/manage_processors.html

Page Properties

Output formats none
Visibility Filter Applied none
RBAC Permissions Needed
Page Contents/FunctionalityG_ADD_WPROCESSOR
WPROCESSOR_DELETE
WPROCESSOR_EXISTS

Contents and Usage

The following annotated screenshot shows the various parts of the Manage Warning Processors page.

annotated screenshot: Delete Saved Searches page standard header breadcrumbs heading table of current processors remove warning processors button fields for adding a new processor standard footer

Standard Header See GUI Reference: Standard Header.
Breadcrumbs Home> Settings > Manage Warning Processors
Page Heading Manage Warning Processors
Table of current processors Table with
Remove Warning Processors button Click to uninstall one or more of the installed processors. See Uninstall Processors for full instructions.
Install Warning Processor A form for adding a new warning processor. See Install A New Processor for full instructions.
Standard Footer See GUI Reference: Standard Footer.

Uninstall Processors

Follow these instructions to uninstall one or more warning processors on the hub. Note that uninstalled processors will no longer be active on the hub, but the processor executables (and any supporting source files) are not deleted: you can reinstall them later using the procedure for installing a new processor.
You will need WPROCESSOR_DELETE permission for each warning processor you wish to uninstall.

  1. Click the Remove Warning Processors button under the table of current processors. The page will expand to provide more functionality, as shown below.

    screenshot fragment: expansion after clicking Remove Warning Processors

    Checkboxes The table now includes a column of checkboxes. Click in a checkbox to select the corresponding processor, click again to deselect.
    Check/Uncheck Buttons
    Check All Click to select all processors in the table (including those on other pages of a paged table).
    Uncheck All Click to unselect all processors in the table (including those on other pages of a paged table).
    Check These N Click to select all processors on the current page of the table. The number N corresponds to the number of processors on the current page. (Only present if table has multiple pages.)
    Uncheck These N Click to unselect all processors on the current page of the table. The number N corresponds to the number of processors on the current page. (Only present if table has multiple pages.)
  2. Use the checkboxes to select the processor or processors that you want to uninstall.
  3. Click the Remove Selected Warning Processors button to uninstall the processors you have selected.
  4. The page will be updated to display the new set of installed processors, along with a confirmation message.

Install A New Processor

Follow these instructions to install a new warning processor on the hub.
You will need G_ADD_WPROCESSOR permission.

  1. Perform any necessary customizations.
  2. Make sure the warning processor executable is stored in hubdir/processors/, where hubdir is the hub directory. This is the only permitted location for warning processors.
    1. If necessary, move the warning processor executable there now.
    2. Make sure that permissions are set so that it can be executed.
  3. Enter a label for the warning processor in the Label field. The label will be shown in the the table of current processors, and used to identify the processor (where applicable) in the Change Warning section of each Warning Report. Labels should be unique.
  4. Enter the file name of the warning processor executable in the Processor Executable field.
  5. If you want the processor to be applied automatically to incoming warnings, select the checkbox. If you want the processor to be available for interactive application only, leave the checkbox unselected.
  6. Click Install.
  7. The page will be updated to display the new set of installed processors, along with a confirmation message showing the warning's label, executable, and display script.

    screenshot fragment: installation confirmation message

 

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