Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Overview

The License Compatibility Report provides information on the compatibility of libraries with different software licenses distributed together in the same product or project. 

The underlying logic for license incompatibilities is derived from the following links:

NOTE: The message “no occurrences” indicates that the library contains multiple licenses.

Accessing the Report

  1. From the main menu, select Reports > License Compatibility. The License Compatibility Report page is displayed.

  2. Select the scope for which the report should be created, as follows:

    1. Open the dropdown menu next to the report name and select the product or specific project on which you want to base the report. 

    2. Click Apply and wait for the data to load into the report preview table.

  3. To further filter the report, do as follows:

    1. Expand the Filter area, select an option from the By dropdown menu, and enter the value by which to filter.
      The options are: Library (default), License, Incompatible with License, and Incompatibility Type.

    2. Click Filter.

The License Compatibility Report is displayed.

NOTE:

  1. When there are no license compatibility issues, the message “No License Compatibility Issues Found” is displayed.

  2. The message “no occurrences” indicates that the library contains multiple licenses.

...

Understanding the Report Data

The License Compatibility Report provides the following columns of information in a table:

  • Library: Name of the open source library that has a license conflict. Click on the library name to access the Library Details page.

  • License: The library's license.

  • Incompatible with License: The license to which the library's license is incompatible.

  • Incompatibility Type: Displays the type of license for which there is an actual, suspected or potential incompatibility:

    • Incompatible: The library’s license is fundamentally incompatible and cannot be used under any circumstance.

    • Suspected: A suspected incompatibility is displayed when the license compatibility is dependent on the library’s hierarchy within the Product or Project, and the library’s hierarchy is unknown.

    • Potential: The library being evaluated is licensed under multiple licenses, meaning that you can choose under which license the library will be licensed.

  • Incompatibility Occurrences: Displays the number of libraries that include the suspected or actual incompatible license. When the scope is a product, it also displays the number of projects that are impacted by the incompatibility.

Clicking on a specific row in the table displays a lower table with details about the incompatible libraries. This table includes the following information on the occurrences of libraries with the conflicting licenses:

...

page

...

Project: The project in which the library is located. 

Exporting the Report

To export the report, click the Export dropdown menu at the top right corner of the report, and select the required export format:

  • Excel

  • XML

The exported report will reflect the selected context (product or project) and specified filters.

For examples of exported report types, see is available at: https://whitesourcedocs.atlassianmend.netio/wiki/spaces/WD/pages/1897922806/Copy+of+Working+with+WhiteSource+Reports#Exporting-a-Report.bundle/sca_user_guide/page/the_license_compatibility_report.html