LeanIX - Product Documentation

Welcome to the LeanIX Product Documentation. Here you will find all the basic information you need to start working with LeanIX. Besides that, we provide well-structured information on how to get more out of LeanIX, best-practices, and use-case specific guidelines. Feel free to spread this product documentation in your company and use it as a common information source to answer your colleagues’ most urgent questions.

Get Started

Configuration - Overview

LeanIX offers various opportunities to be tailored individually to a company's need. This page gives you an overview on what is possible in self-service and with LeanIX support.

Self-Service

Information

Most self-service options are available to all LeanIX customers, but some are edition-specific. Please reach out in case of doubt.

Individualize the appearance of a single Fact Sheet

As a LeanIX administrator, you have the following options to individualize the way your users work with a Fact Sheet:

1

Encourage the usage of Tags: Tags are a great way to cover your own requirements. Every user can create their own tags, while an Administrator can create tag groups.

Use the following link to learn more about Tagging.

2

Bring your own Subscription Types: Use role definitions (e.g. Application Owner, Software Architect) that are known by everyone in the company.

3

Configure the shown sections and attributes: Control what information is shown, and whether it is considered as mandatory.

Configure the shown sections of a Fact Sheet

The "Configure Fact Sheet" dialogue which is accessible both directly from a Fact Sheet and via the Administration area allows controlling whether individual sections are shown and whether they should be regarded as mandatory for Data Quality Management.

1

General Fact Sheet settings Via the settings tab, you could set properties like the name of a Fact Sheet, or control the Quality Seal.

Learn more about the Quality seal here: Data Quality Management

2

Set the weight of a section: Set the weight to "1" to treat this section as mandatory, or to "0" for optional.

Learn more about Fact Sheet Completeness here: Data Quality Management

3

Control whether a section should be shown: Use "Active" to show a section, or "Disabled" to hide it. "Disabled" will also deactive the associated filter facet in the inventory.

Best Practice

Especially in onboarding, it is helpful to hide all sections that are not in use. This allows users to focus on the required information. It is safe to hide a section - no data is removed, it is even still accessible via the API.

When applying the changes shown above, the Fact Sheet appearance changes as follows:

1

Successor and Predecessor are now flagged as Optional.

2

The entire dependency section has been hidden.

3

The Fact Sheet Completeness has been recalculated.

Configure your entire workspace

As an Administrator, you cannot only edit the appearance of a Fact Sheet, but many other settings in self-service:

1

The Administration area is always accessible via the drop-down at the top right.

2

Every user - not only administrators - can update their profile, change their password and control their notification settings.

3

In the Add-Ons area you can access Surveys and Metrics.

4

At administration, you can manage your users, control settings like Tagging or Subscription mode, and even set your own Logo & Color.

5

For developers and integrations, you find several tools here as well.

Information

You can find more information at Administration Overview.

Configuration Add-Ons

In addition to the Self-Service configuration, the Configuration Add-Ons allows you to modify the data model, fact sheet appearance, labels & descriptions, permission model and much more. The configuration is executed by LeanIX Customer Success.

License information

Depending on your edition, different Configuration Add-Ons are available. Please reach out to learn more.

When to use the Configuration Add-Ons?

LeanIX comes with a Best practice data model that is well-probed for all typical Enterprise Architecture use cases. The idea of the Add-Ons is not to create a completely new data model, but rather to tweak it such that it fits perfectly with your companies use cases and requirements. The following table show typical goals and how to achieve them.

Goal
Example
Description

Improve Usability

Reduce the number of tags

Tags are a powerful instrument to bring own information to LeanIX. Usability degrades however when two many tags are used (more than 5-7 for a Fact Sheets). The Configuration Add-Ons allow to turn certain tags into attributes - see https://docs.leanix.net/v4.0/docs/modeling-guidelines#section-tags-vs-attributes

Use explicit relations

Besides the best-practice data model, LeanIX allows you to use requires/required By relations to connect Fact Sheets, e.g. Processes to Interfaces. As this relations are untyped, usability decreases when using them to often. The Configuration Add-Ons allow you to turn them into regular relations.

Fine-tune data completeness

On the best-practice data model, LeanIX allows you to define sections as mandatory or optional for Fact Sheet completeness. With the Configuration Add-Ons , you can fine-tune this to attribute level.

Support new Use Cases

GDPR

GDPR is a great opportunity for EA, as it requires to maintain a high data quality around the Applications, Data Objects and Interfaces of a company. The Data Protection Officers often have a highly specialized view on their requirements. The Configuration Add-Ons allowf you to support this view without decreasing the general usability.

IT Service Management

In many companies, the concept of a Business Service is established to bridge the gap between Business Capabilities and Applications. LeanIX customers found ways to bridge the gap within the existing data model (e.g. use an Application with a tag "Business Service", use a third-level Business Capability as Business Service), but especially when considering an integration with an ITSM system like ServiceNow, it makes sense to consider a dedicated "Business Service" Fact Sheet.

Advanced IT Architecture Management

Customers use the IT Component Fact Sheet to address use cases like Technology Stack - Reference Models and Cost Management. For this, the standard model of IT Component, Tech. Stacks and Providers works great. More mature customers try to bring more dimensions of their IT Architecture into LeanIX, e.g. instances or platforms, to address use cases like Microservice or Container Management. Here, usability can suffer quickly from an overfrauded IT Component Fact Sheet, and it make sense to consider e.g. a dedicated "Environment Fact Sheet".

Tweak Permission Model

Special roles

LeanIX helps companies to establish a vivid, open collaboration about their IT landscapes. However, there are cases where company augment this openness by deliberately introducing exceptions, e.g. allowing only some persons to see costs or other explicit content, or allowing a data protection officer to have the sole opportunity to set a certain approval. In this case, the Configuration Add-Ons can help you to bring in new roles or permissions.

Working with sub-organizations

In large companies, it is often desirable to create an open exchange, but the way towards this goal is long. If your company consists of sub-organisations that are not (yet) allowed to share certain content, the Configuration Add-On might help you to bring in this information into a shared workspace while maintaining a clear separation.

Concrete example

The following screenshot shows a simple configuration to address the GDPR use case. Within the Application Fact Sheet, a new Section called GDPR is created. The included attributes are handled as all every other attribute in LeanIX

How does it work?

Behind the scenes, LeanIX Customer Success uses five different models to conduct the configuration:

The Data Model allows adding new Attributes (e.g. Text, Number, Single Select, Multi Select), Relations, Fact Sheets, External IDs and Validators. Standard functionality is available for all new Elements (Filter, Table View, Import / Export, Survey, Dashboard, Accessibility via GraphQL API).

The View Model allows changing the appearance of each single Fact Sheet Type by fine-tuning the look of existing and new elements (e.g. assign symbols and colors to Single-Select Fields, control per attribute whether it is included in completeness calculation).

The Translation Models allow individualizing help texts, label, section names, report names and more. Different languages are supported - currently EN and DE in the standard model.

The Authorization Model allows to fine-tune existing roles (e.g. make a certain attribute only editable by an Admin) or creating an entirely new role with certain privileges.

The Reporting Model allows changing the menu structure for existing and of custom reports, as well as configuring own Matrix, Landscape, World-Map or Roadmap reports.

FAQ

Q: Why can't I just reuse an existing Fact Sheet Type for another purpose (e.g. use the Provider Fact Sheet which is not in use to model a Business Service)?
A: The existing Fact Sheet Types are highly specialized to serve their role in the Best Practice Data Model and for the supported use cases. Certain reports rely on the out-of-the-box dependencies. Hence, you run the risk to seriously confuse your users when misusing the existing types.

Q: Why is configuration not available in self-service?
A: The adaptions allow powerful modifications on the data model that might cause data loss or legal violations if used in a wrong way. As LeanIX is responsible for the data integrity and quality of service, these modifications can currently not be executed in self-service.

Configuration - Overview


LeanIX offers various opportunities to be tailored individually to a company's need. This page gives you an overview on what is possible in self-service and with LeanIX support.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.