Using ldcreport

Using ldcreport#

Command-Line#

ldcreport <project-file> [Report Types] [Report Options] -report:[FileFormat] -reportFile:<report-file>

ldcreport generates a variety of reports on a project. It can also be used to run custom reports created by users.

Please use the help option to generate the latest list of reports and options. As new reports are added, or as you write your own custom reports, the help option will show the complete list.

Examples#

  • ldcreport <ProjectFilename.ldz> -report:excel -reportFile:<ReportFilename.xlsx>

    Generate an excel report on the specified project.

  • ldcreport <ProjectFilename.ldz> -report:txt -impact -source:<PartitionName> -closure -reportFile:<ReportFilename.txt>

    Generate an report that shows everything that uses a specified partition. The report will go down to member level and will show the impact levels all the way up to transitive closure.

  • ldcreport <ProjectFilename.ldz> -report:txt -uses -source:<PartitionName> -reportFile:<ReportFilename.txt>

    Generate a report showing all the direct dependencies of a specified partition.

  • ldcreport <ProjectFilename.ldz> -reportFile:<ReportFilename.png> -reportview:2

    Generate a png image of the second display tab. If reportview argument is not specified or if an invalid view number is specified, an image for the first display tab is generated.

  • ldcreport <ProjectFilename.ldz> -$CUSTOM_REPORT_NAME -report:html -reportFile:<ReportFilename.html>

    Generate the custom report with the id CUSTOM_REPORT_NAME. For details on how to create a custom report, please see Scripting with Groovy : @Report

    ldcreport <ProjectFilename.ldz> -report:sarif -violations -reportFile:<ReportFilename.sarif>

    Generate a report in SARIF format. Supported for report types violations and impact. Also supported for custom report violations_with_lines, available in the scripts_extra directory of your Lattix installation.

Report Types#

-cycles
-largest_cycles
-member_cycles
-summary
-rules
-worklist
-violations
-flagged
-system_metrics
-architecture_metrics
-object_oriented_metrics
-public
-private
-unused
-impact
-uses
-external
-xmlExport

Report Options#

-source:partition-name|tag-name
-target:partition-name|tag-name
-sourceAtomFilter:AtomKind
-resultAtomFilter:AtomKind
-closure
-showmembers

File Format#

FileFormat:
  txt,xml,html,excel (produces XLSX workbook),excel97-2003 (produces XLS workbook)
  png,jpeg (for image export)
  sarif (for impact, violations or violations_with_lines report)

Success or Failure#

Return success or failure to the calling script, where failure is the inability to complete its processing.