HomeDocumentationProduct UpdatesProduct Roadmap
Request DemoWebsite

Reporting Framework and CLI

The LeanIX Reporting Framework and CLI allows you to build custom reports.

Overview

LeanIX offers a wide range of standard out-of-the-box reports. However, standard reports may be insufficient for your organization.

As a developer, you can build custom reports using the LeanIX Reporting Framework and Command-Line Interface (CLI). With this toolset, you can tailor reports to the needs of your organization.

The reporting toolset consists of two components:

  • LeanIX Reporting Framework: The framework provides a connection to the LeanIX app, which allows you to create custom reports within LeanIX using the report data and functionality.
  • LeanIX Reporting CLI: Command-line interface (CLI) tools let you run, build, upload, and publish custom reports to your LeanIX Workspaces and the LeanIX Store.

Reporting Framework

The Reporting Framework is embedded in the LeanIX app architecture. It communicates with the LeanIX app through the Reporting Library API. Based on this JavaScript API, you can build custom reports using a framework of your choice.

📘

Reference Documentation

To learn more about specific framework components, refer to the Reporting Framework documentation. The documentation provides a comprehensive reference for enumerations, classes, interfaces, type aliases, variables, and more.

The Reporting Framework provides a wide range of features, such as:

  • Filtering of Fact Sheet information
  • View selection
  • Tabular view of report data and support of Excel reports
  • Export to PDF and PNG files
  • Choice of visualization options

To learn more, see Features of the LeanIX Reporting Framework.

Reporting CLI

The Reporting CLI allows you to initialize, develop, and publish custom reports.

To learn how to use the CLI tool, run the lxr --help command. To get detailed help for individual commands and their options, run lxr help [command].

Required Knowledge

To work with the Reporting Framework and CLI, you should have a robust understanding of the following:

  • Command-line interface
  • A JavaScript framework of your choice
  • GraphQL APIs
  • REST APIs

Depending on the use case, you may need knowledge and skills in other areas.

Guides

To learn how to build custom reports using the reporting toolset, read our guides.