Appendix A: Default Base Configuration

The builtin default base configuration contains settings for the rules and writers section of the Solicitor configuration file which will be used if the project specific config file omits those sections.

Listing 70. Default Configuration
  "rules" : [ {
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LicenseAssignmentProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseAssignment.drt",
    "ruleGroup" : "LicenseAssignmentProject",
    "description" : "setting license in case that no one was detected or overwriting a wrongly detected license (project overrides; 'old' rule structure)",
    "deprecationWarnOnly" : true,
    "deprecationDetails" : "Use of decision table LicenseAssignmentProject is deprecated, use LicenseAssignmentV2Project instead. See release notes of release 1.4.0 for migration hints"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LicenseAssignmentV2Project",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseAssignmentV2.drt",
    "ruleGroup" : "LicenseAssignmentV2Project",
    "description" : "setting license in case that no one was detected or overwriting a wrongly detected license (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/LicenseAssignmentV2Sample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseAssignmentV2.drt",
    "ruleGroup" : "LicenseAssignmentV2Defaults",
    "description" : "setting license in case that no one was detected or overwriting a wrongly detected license"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LicenseNameMappingProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseNameMapping.drt",
    "ruleGroup" : "LicenseNameMappingProject",
    "description" : "mapping different spelling of license name to the SPDX-ID format (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/LicenseNameMappingSample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseNameMapping.drt",
    "ruleGroup" : "LicenseNameMappingDefaults",
    "description" : "mapping different spelling of license name to the SPDX-ID format"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/MultiLicenseSelectionProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/MultiLicenseSelection.drt",
    "ruleGroup" : "MultiLicenseSelectionProject",
    "description" : "ignoring non applicable multi licensing alternatives (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/MultiLicenseSelectionSample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/MultiLicenseSelection.drt",
    "ruleGroup" : "MultiLicenseSelectionDefaults",
    "description" : "ignoring non applicable multi licensing alternatives"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LicenseSelectionProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseSelection.drt",
    "ruleGroup" : "LicenseSelectionProject",
    "description" : "selecting the effective license (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/LicenseSelectionSample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LicenseSelection.drt",
    "ruleGroup" : "LicenseSelectionDefaults",
    "description" : "selecting the effective license"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LegalPreEvaluationProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LegalPreEvaluation.drt",
    "ruleGroup" : "LegalPreEvaluationProject",
    "description" : "legal preevaluation based on the standards defined in some generic policy (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/LegalPreEvaluationSample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LegalPreEvaluation.drt",
    "ruleGroup" : "LegalPreEvaluationDefaults",
    "description" : "legal preevaluation based on the standards defined in some generic policy"
  },{
    "type" : "dt",
    "optional" : true,
    "ruleSource" : "file:${cfgdir}/rules/LegalEvaluationProject",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LegalEvaluation.drt",
    "ruleGroup" : "LegalEvaluationProject",
    "description" : "final legal evaluation (project overrides)"
  },{
    "type" : "dt",
    "optional" : false,
    "ruleSource" : "classpath:com/devonfw/tools/solicitor/rules/LegalEvaluationSample",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/rules/rule_templates/LegalEvaluation.drt",
    "ruleGroup" : "LegalEvaluationDefaults",
    "description" : "final legal evaluation - THESE ARE DUMMY RULES"
  } ],
  "writers" : [ {
    "type" : "xls",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Solicitor_Output_Template_Sample.xlsx",
    "target" : "${cfgdir}/output/OSS-Inventory_${project}.xlsx",
    "description" : "The XLS OSS-Inventory document",
    "dataTables" : {
      "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
      "APPLICATION" : "classpath:com/devonfw/tools/solicitor/sql/allden_applications.sql",
      "APPLICATIONCOMPONENT" : "classpath:com/devonfw/tools/solicitor/sql/allden_applicationcomponents.sql",
      "LICENSE" : "classpath:com/devonfw/tools/solicitor/sql/allden_normalizedlicenses.sql",
      "MODELROOT" : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql"
    }
  },{
    "type" : "xls",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Solicitor_Output_Template_Sample.xlsx",
    "target" : "${cfgdir}/output/OSS-Inventory_aggregated_${project}.xlsx",
    "description" : "The XLS OSS-Inventory document",
    "dataTables" : {
      "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
      "APPLICATION" : "classpath:com/devonfw/tools/solicitor/sql/allden_applications.sql",
      "LICENSE" : "classpath:com/devonfw/tools/solicitor/sql/normalizedlicenses_aggregated_applications.sql",
      "MODELROOT" : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql"
    }
  },{
    "type" : "velo",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Solicitor_Output_Template_Sample.vm",
    "target" : "${cfgdir}/output/OSS-Report_${project}.html",
    "description" : "The HTML OSS-Report",
    "dataTables" : {
      "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
      "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
      "OSSLICENSES" : "classpath:com/devonfw/tools/solicitor/sql/ossapplicationcomponents.sql",
      "UNIQUELICENSES" : "classpath:com/devonfw/tools/solicitor/sql/uniquelicenses.sql"
    }
  },{
    "type" : "velo",
    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Solicitor_Output_Template_Sample_v2.vm",
    "target" : "${cfgdir}/output/OSS-Report_${project}_v2.html",
    "description" : "The HTML OSS-Report",
    "dataTables" : {
      "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
      "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
      "OSSLICENSES" : "classpath:com/devonfw/tools/solicitor/sql/ossapplicationcomponents_guessedlicenses.sql",
      "UNIQUELICENSES" : "classpath:com/devonfw/tools/solicitor/sql/uniqueguessedlicenses.sql"
    }
  },{
    "type" : "velo",
    "templateSource" : "file:${cfgdir}/templates/Pflichtangaben.vm",
    "target" : "${cfgdir}/output/Pflichtangaben_${project}.html",
    "description" : "Das Dokument mit Pflichtangaben",
    "dataTables" : {
      "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
      "OSSLICENSES" : "classpath:com/devonfw/tools/solicitor/sql/ossapplicationcomponents.sql",
      "UNIQUELICENSES" : "classpath:com/devonfw/tools/solicitor/sql/uniquelicenses_with_application_components.sql",
      "NOTICEFILES" : "classpath:com/devonfw/tools/solicitor/sql/noticefiles.sql",
      "NONCOMMERCIALCOMPONENTS" : "classpath:com/devonfw/tools/solicitor/sql/applicationcomponents_with_noncommerciallicenses.sql",
      "NONCOMMERCIALCOMPONENTS_LICENSES" : "classpath:com/devonfw/tools/solicitor/sql/applicationcomponents_with_noncommerciallicenses_with_licenses.sql"
    }
  },{
	    "type" : "velo",
	    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Solicitor_Diff_Template_Sample.vm",
	    "target" : "${cfgdir}/output/Diff-Sample_${project}.html",
	    "description" : "Difference Sample",
	    "dataTables" : {
	      "LICENSE" : "classpath:com/devonfw/tools/solicitor/sql/allden_normalizedlicenses.sql"
    }
  },{
	    "type" : "velo",
	    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Source_Download_Script.vm",
	    "target" : "${cfgdir}/output/download_sources_${project}.sh",
	    "description" : "Script for downloading sources which need to be included in the distribution from Maven-Central and NpmRepository",
	    "dataTables" : {
	      "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
	      "ARTIFACTS" : "classpath:com/devonfw/tools/solicitor/sql/sources_tobeincluded.sql"
    }
  },{
	    "type" : "velo",
	    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/Quality_Report.vm",
	    "target" : "${cfgdir}/output/Quality_Report_${project}.html",
	    "description" : "Quality Report",
	    "dataTables" : {
		  "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
          "ENGAGEMENT"  : "classpath:com/devonfw/tools/solicitor/sql/allden_engagements.sql",
	      "MULTIPLE_EFFECTIVE_LICENSES" : "classpath:com/devonfw/tools/solicitor/sql/multiple_effective_licenses.sql"
    }
  },{
		"type" : "velo",
	    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/ScancodeScript.vm",
	    "target" : "${cfgdir}/output/scancode_${project}.sh",
	    "description" : "Script for downloading sources and running them through scancode to create a copyright report",
	    "dataTables" : {
	      "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
	      "ARTIFACTS" : "classpath:com/devonfw/tools/solicitor/sql/scancode_sources.sql"
    }
  },{
		"type" : "velo",
	    "templateSource" : "classpath:com/devonfw/tools/solicitor/templates/ScancodeScanScript.vm",
	    "target" : "${cfgdir}/output/scancodeScan.sh",
	    "description" : "Script for running and copying scancode output to directory",
		"dataTables" : {
	      "MODELROOT"  : "classpath:com/devonfw/tools/solicitor/sql/modelroot.sql",
	      "ARTIFACTS" : "classpath:com/devonfw/tools/solicitor/sql/scancode_sources.sql"
    }
 }]
Last updated 2022-11-30 15:22:16 UTC