CSV Import

Description

Imports artefacts, metrics, findings, textual information and links from one or more CSV files. The expected CSV format for each of the input files is described in the user manuals in the csv_import framework reference.

Note

Consult csv_import Reference for more details about the expected CSV format.

Usage

CSV Import has the following options:

  • CSV Separator ( separator , default: ;) Specify the CSV Separator used in the CSV file.​

  • CSV Delimiter ( delimiter , default: ") CSV Delimiter is used when the separator is used inside a cell value. If a delimiter is used as a char in a cell it has to be doubled.The ' char is not allowed as a delimiter.​

  • Artefact Path Separator ( pathSeparator , default: /) Specify the character used as a separator in an artefact's path in the input CSV file.​

  • Case-sensitive artefact lookup ( pathAreCaseSensitive , default: true) When this option is turned on, artefacts in the CSV file are matched with existing source code artefacts in a case-sensitive manner.​

  • Ignore source file path ( ignoreSourceFilePath , default: false) When ignoring source file path it is your responsbility to ensure that file names are unique in the project.​

  • Create missing files ( createMissingFile , default: false) Automatically creates the artefacts declared in the CSV file if they do not exist.​

  • Ignore finding if artefact not found ( ignoreIfArtefactNotFound , default: true) If a finding can not be attached to any artefact then it is either ignored (checked) or it is attached to the project node instead (unchecked).​

  • Unknown rule ID ( unknownRuleId ) For findings of a type that is not in your ruleset, set a default rule ID. The value for this parameter must be a valid rule ID from your analysis model.​

  • Measure ID for orphan artifacts count ( orphanArteCountId ) To save the total count of orphan findings as a metric at application level, specify the ID of the measure to use in your analysis model.​

  • Measure ID for unknown rules count ( orphanRulesCountId ) To save the total count of unknown rules as a metric at application level, Specify the ID of the measure to use in your analysis model.​

  • Information ID receiving the list of unknown rules IDs ( orphanRulesListId ) To save the list of unknown rule IDs as textual information at application level, specify the ID of the textual information to use in your analysis model.​

  • CSV File ( csv ) Specify the path to the input CSV file containing artefacts, metrics, findings, textual information, links and keys.​

  • Metrics CSV File ( metrics ) Specify the path to the CSV file containing metrics.​

  • Infos CSV File ( infos ) Specify the path to the CSV file containing textual information.​

  • Findings CSV File ( findings ) Specify the path to the CSV file containing findings.​

  • Keys CSV File ( keys ) Specify the path to the CSV file containing artefact keys.​

  • Links CSV File ( links ) Specify the path to the CSV file containing links.​

  • Reports artefacts mapping problem as ( level , default: info) When an artefact referenced in the csv file can not be found in the project, reports the problem as an information or as a warning.​

The full command line syntax for CSV Import is:

-d "type=csv_import,separator=[text],delimiter=[text],pathSeparator=[text],pathAreCaseSensitive=[booleanChoice],ignoreSourceFilePath=[booleanChoice],createMissingFile=[booleanChoice],ignoreIfArtefactNotFound=[booleanChoice],unknownRuleId=[text],orphanArteCountId=[text],orphanRulesCountId=[text],orphanRulesListId=[text],csv=[text],metrics=[text],infos=[text],findings=[text],keys=[text],links=[text],level=[multipleChoice]"