Skip to main content

Adding or Editing Scan Servers

Before users can assign project codebases to a Scan Server in order to scan them, the Scan Server must first be installed either on the same instance as the Code Insight Core Server or on a separate instance, as described in Installing Code Insight. (The Scan Server must have the same version as the Core Server.) As Code Insight System Administrator, you must then “add” the Scan Server to the Code Insight system—that is, identify the server to the Code Insight Core Server to make it available for scanning purposes, as described in this section.

If multiple Scan Servers have been installed, you can add more than one of these servers, thus providing the means for users to distribute codebase scans across servers. Keep in mind each of these Scan Servers should be installed on a separate instance with a unique host ID and port identification. The codebase for a given project can be assigned to only one Scan Server (but multiple project codebases can be assigned to a single Scan Server). All codebases assigned to a given Scan Server are stored on that server in a location that you specify.

The following procedure describes how to add an installed Scan Server to the Code Insight system and, once added, how to edit its properties as needed.

For information about Code Insight scans and their assignment to project codebases, see “About Code Insight Scans” in the “Using Code Insight” chapter in the Code Insight User Guide.

To add or edit your Scan Server, do the following:

  1. Ensure that the Scan Server that you want to add or edit is running. (The Scan Server starts when the Tomcat server is started, as described in Starting and Stopping Tomcat.)

    • For a Scan Server whose properties you are editing, ensure its status is green in the list of Scan Servers on the Scan Servers tab, which you access using steps 2 and 3 below.

    • For a Scan Server whose status you want to change from disabled to enabled, manually determine whether Tomcat is running on the instance. (The gray status on the list of Scan Servers does not indicate whether Scan Server is running.)

    • For a Scan Server that you adding, manually determine whether Tomcat is running on the instance.

  2. Select the Scan Servers tab. The tab displays a grid listing the Scan Servers that have been added.

  3. Do either of the following:

    • To add a new Scan Server, click Add.

  4. Complete or update the fields the following fields:

  5. On the Code Insight Dashboard, click administration. The Administration page appears with a list of side tabs. (You can also access this page by clicking the icon in the upper right corner of the Code Insight web page to open the Code Insight main menu. From this menu, select ADMINISTRATION.)

  • To edit an already-defined Scan Server, click the (Edit) button in its entry. The Scan Server dialog appears.

    FieldDescription
    AliasThe user-defined name for the Scan Server. This value must be unique among all Scan Servers identified to the Code Insight system, including disabled ones. (See Status is this table for a description of enabled and disabled Scan Servers.)
    HostThe hostname (such as krl\.eng\.companyA\.com ) or IP address of the instance hosting the Scan Server. If the Scan Server is on the same instance as the Core Server, enter localhost . The same host-and-port combination must be unique among the enabled Scan Servers. (See Status is this table for a description of enabled Scan Servers.)
    PortThe port used by the Scan Server on the host instance. By default, the port is 8888 . The same host-and-port combination must be unique among the enabled Scan Servers. (See Status is this table for a description of enabled Scan Servers.)
    CL Path(Optional) The path for the Code Insight Compliance Library (CL), downloaded from the Product and License Center (see Installing the Compliance Library). If the path is specified, the CL is accessed as part of the scan to perform exact-file and source-code fingerprint (snippet) matching. Elements of scanned codebase files are compared with information contained in the CL to generate file-level evidence on which you can take action. The validity of the entered path is checked when you click Save . Alternatively, leave this field blank to scan your codebase without using the CL. (Code Insight provides the scan profile “Basic Scan Profile (without CL)” to perform the scan.) This type of scan generates inventory from Code Insight’s Automated Analysis feature but has limitations, as described in About Scanning without the Compliance Library. Keep in mind that, when you run a scan using the CL, you obtain a deeper, more comprehensive scan on your codebase.
    Codebase PathThe path on the Scan Server where Code Insight will store and manage all uploaded code for projects that use this Scan Server. Ensure you have adequate disk space to store the codebases. The recommended starting size for this directory is 500GB. The directory must already exist. The validity of the entered path is checked when you click Save . Once the Scan Server is added to the Code Insight system, you cannot edit this field.
    StatusBy default, the Scan Server is enabled for scanning. However, if necessary for an existing Scan Server, select Disabled to make the Scan Server unavailable for further scans. Once disabled, the server is no longer displayed in the Scan Server dropdown list during project creation or when setting global project defaults. Additionally, this field becomes read-only on the Edit Project window. Note the following when attempting to disable a Scan Server: If this Scan Server is the system default Scan Server (as defined on the Project Defaults tab), you must change this default to another server before you can disable the current server. See Setting Project Defaults for instructions on updating the default Scan Server. If this Scan Server is associated with one or more projects, a warning is displayed before you can disable the server. Once you click Yes , the Start Scan and Upload Project Codebase options are disabled on the Summary page for each project associated with the server. If you attempt to re-enable a disabled Scan Server when another currently enabled Scan Server has the same host-and-port combination or alias, you receive an error when you click Save .
  1. Click Save to add the Scan Server to the Code Insight system. Errors are generated when the following conditions exist:

    • The Scan Server you are adding or editing is not running.

    • The version of the Scan Server you are adding is different from the Core Server version.

    • The codebase path or CL path is invalid.