siemens/sw360

Corrections on the license report

Opened this issue · 2 comments

mcjaeger commented

There are some minor corrections required.

General

  • generated document should have File name prefix "ProjectClearingReport..." and also the menue item renamed accordingly on generation page.

First page:

  • Header: "Readme OSS" -> "Project Clearing Report", also in the table on the first page "Product" -> "Project"
  • Title table "CT RDA" should be group (department /bunsiness unit) attribute from project
  • Cells with "Name", "Department" and "Role": should be project owner, project resp, and additional roles entries
  • "In case of Siemens components" -> "In case of internal components or sub projects ..."
  • Text "There are remaining risks " -> should not refernece [1] but section 1.4 "Remaining Risks"
  • general risks: Remove siemens references, and speak of organisation

Development Details:

  • "unknown languages" -> "N/A"
  • Platforms: Adding entriy fields for platforms at the same location as with programming languages and OS

2.4 Overview

  • "License" -> "Main License"

3 Obligations

  • Change section title to " 3 Obligations resulting from the use of 3rd party components"
  • "introduction text fixed with text "
    The following artifacts are available in the software catalogue sw360:
    • Readme_OSS
    • Source Code package"
  • Text in 3.2 at begin ad fixed text with: "Most of the integrated components are licensed under $List_of_licenses_sperated_by_comma_being_there_more_than_3times. To keep the clearing report clearly arranged these additional obligations are listed here.
  • Check if there will be obligations table for each component just as in 3.1

Sections "ReadmeOSS", "Buildinstructions" und "SourceCode Bundle"

  • link to attachment: if the project has an attachment of readme, then add the link to his attchment
  • add static text for build instructions and source code bundle
mcjaeger commented

@Myself: provide data to have actually the "the three times" thing.

thegrumpylion commented

PR: eclipse-sw360#526

One thing that is not implemented is "link to attachment". There are 2 issues with this.

The "LicenseInfoService" method "getLicenseInfoFile" needs to change signature to support passing to it information that are necessary to construct a valid URL to the attachment by the means of "PortalUtil.getPortalURL(request)" and "PortalUtil.getPathContext(request)" since we have no access to PortalUtil in the backend.

Even if there is a way to get all the information needed in the backend, there is still the issue that the signature of "OutputGenerator" abstract class method "generateOutputFile" needs to change to have the relevant data for the URL passed down to docx generator.

The questions then are

  • Should the LicenseInfoService be altered or there is a way to get information for constructing the URL in the backend?
  • Should the generateOutputFile signature change to generateOutputFile(configStruct) or just add another parameter to the current signature? If it's the latter, what should the type of that field be?