@leanix/reporting

This library allows you to develop your own custom reports for LeanIX EAM Tool (https://www.leanix.net). We also provide a command line interface (CLI) that helps you to develop, test and upload your reports easily, see https://github.com/leanix/leanix-reporting-cli.

Installation

Simply install the library via npm:

npm install @leanix/reporting --save

Usage

As a simple script tag inside your HTML

<script src="node_modules/@leanix/reporting/index.js"></script>
<script>
  // Now we have a global lx object.
  console.log(lx);
</script>

Using ES6 Module syntax

import '@leanix/reporting';

// Now we have a global `lx` object.
console.log(lx);
lx.init()
.then(function (setupInfo) {
  // Process setupInfo and create config object
  var config = {};
  lx.ready(config);
});

Typedoc

Since the reporting library is created using TypeScript we are able to provide documentation of the typings that you can find here: https://leanix.github.io/leanix-reporting/

Examples

Sometimes its easier to look at a few code examples than read through lines of documentation. Therefore we provide some snippets with code examples in the examples folder.

Features

To get an overview of all the features that the LeanIX reporting framework offers see: Features Overview

Basic concept of the LeanIX reporting framework

A report for LeanIX consists of HTML, JavaScript and CSS files, which are loaded into an iframe inside of the application. The report which is running within the iframe and the host application that contains the iframe communicate via a predefined set of messages (see: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage).

As a report developer you do not have to know about the messages. This library takes care of the communication with the host application and provides a simple API that you can use to request data, send commands to the host application or be informed about events happening outside of your report.

Init sequence

• lx.init(): Notifies the host application that the report wants to initialise. It returns a promise that is fullfilled with setup information that is provided by the host app (see: https://leanix.github.io/leanix-reporting/classes/lxr.lxcustomreportlib.html#init).
• lx.ready(config): Notify the host application that the report is ready to start processing data. You have to provide a configuration object that specifies the requirements of your report to the host (see: https://leanix.github.io/leanix-reporting/classes/lxr.lxcustomreportlib.html#ready).

Config object

The config object which has to be passed to lx.ready() acts as an interface between your report code and the reporting library. It allows you to define the requirements for your report, such as which data you want to fetch from LeanIX backend. In addition to that you have to register callback functions in the config object, which are called by the reporting library once certain events occur (for example when data has been fetched from the backend).

You can find the interface definition of the config object here: https://leanix.github.io/leanix-reporting/interfaces/lxr.reportconfiguration.html

Issues and Support

In case you encounter issues with the reporting framework, please contact support@leanix.net.