User Documentation

👋 Welcome to the LicenseDb-UI Wiki! This wiki provides a step-by-step guide on how to start using the application and it's available features. For instructions on how to contribute to the development of the project, follow this link - Developer Documentation

Table of Contents

• Overview
• Access Levels
• Main Pages
  • Dashboard (Home Page)
  • User Page
  • License Page
  • Obligation Page
  • Operations Page
• Settings Pages
  • Dashboard Settings
  • Obligation Settings

Overview

LicenseDb-UI is an open-source license management tool, which is intended to simplify license and obligation management for tools like Fossology, as well as other tools that may be integrated in the future. The goal is to streamline the workflow for legal teams by providing a centralized interface, eliminating the need to log into and navigate multiple tools.

LicenseDb-UI provides features to create, edit, and manage licenses and obligations.

Additionally, it supports importing and exporting these items in JSON format.

Licenses (& obligations) can be imported from FOSSology and exported to both FOSSology and SW360. It is also possible to import and export items to and from other external sources.

Access Levels

There are two access levels in LicenseDb-UI:

1. Normal Users:
   • Read-only access.
   • Cannot make changes to any items.
2. Admin Users:
   • Full access, including the ability to create, edit, and delete items.

Main Pages

Dashboard (Home Page)

• Features:

  • Changelog List View: Displays changes made to licenses and obligations.

    • The list can be filtered by changes made to "License" or "Obligation"
    

    • Users can view an extended version of individual items in a modal, where differences are highlighted.

      

    • Risk Level Pie Chart: Shows the percentage of risk levels associated with all licenses.

User Page

• Access: Admin-only.
• Features:
  • Lists all users in the system.
  • Create new users.

License Page

Refer to this link to know more about SPDX ids and expressions.

• Unique Field: shortname

• Displays a data table of all licenses.

• Provides column sorting and pagination.

  

• Detail View: Clicking a license opens an update form. Only admins can edit licenses.

  

• Search: Global search by license short name.

• Sorting: Sortable columns for key fields.

• Create New License: Button to navigate to the create license page (admin-only).

Create License Page

• Features:

  • Create new licenses.

  • Multiple obligations can be added to one license.

    

  • Dynamic External Reference Fields: Input fields from external sources that are not part of the standard format.

Obligation Page

• Unique Field: topic

• Structure: Similar to the License Page with create and update functionalities.

• Create obligation page:

  

• Features:

  • Global search by obligation topic.
  • No external YAML configuration is required for obligations.

Operations Page

• Access: Admin-only.

• Available options in the operations page.

  

• Features:

  • Import and export licenses and obligations in JSON format.

  • Ensure JSON follows the standard format to avoid errors.

    

Settings Pages

Dashboard Settings

• Features:
  • Add new cards to the dashboard.
  • Generate pie charts with fields, their names, labels, and values.

Obligation Settings

• Features:

  • Add or remove obligation types and classifications.

    

  • Updated values appear in select options for the type and classification fields when creating or updating obligations.

  • For classification add color from the ColorPicker (color name has to be types in manually)