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

Getting Started

This section will give you a general overview of the LeanIX structure, introduce you to features necessary to manage your user account, and show you how to invite other users to LeanIX.

Navigating in LeanIX

The LeanIX home screen gives you easy access to key functionalities. It contains:

  • The major navigation panel (on top)
  • General information about your Fact Sheets (Fact Sheets are the central element in LeanIX, used to store information on your architectural objects)
  • Support button (that you will find on any screen within LeanIX)
1

Dashboard: Takes you to your dashboard, similar to the one captured above

2

Inventory: Leads you to the Inventory where you can access and modify all Fact Sheets within your Workspace

3

Reporting: Provides access to LeanIX' Report area that allows you to visualize the information from the Inventory in Best Practice formats as well as individual reports

4

Jump to a Fact Sheet: Offers full text search to find any Fact Sheet in the inventory or jump directly to a Fact Sheet

5

Invite: Allows you to ask other users to join LeanIX

6

Admin: On the very right you find a drop down to access your profile and the administration area as well as the options to logout or switch workspace

7

Cockpit: The cockpit provides a comprehensive view on the most important information of your fact sheets

8

Support: If you need any kind of help using LeanIX, the Support button gives you the chance to contact the LeanIX-Support directly

Invite Other Users to LeanIX

Collaboration is crucial to a succesful EA. To invite other users to the LeanIX workspace, select the Invite button in the upper right side of your home screen.

Type in the email address of the user/s you want to invite, and select their user rights. You can choose between Viewer, Member or Admin.

Finally, you can write an invitation message either by using the precast message, or by crafting your own. When you are done, select the Invite button, and an e-mail automatically goes to the user or users you invited.

When the invitee clicks on the link they receive in the invitation e-mail, LeanIX will guide them through the registration process. If they are already a member of an existing workspace, they can use their existing credentials.

Update Your Profile

One of the first steps before starting to get work done in LeanIX is to complete your profile and choose a profile picture.

You are also able to see the date of your last login and your current User Role. By default the following User Roles are available:

  • Admin: Has permission to configure the workspace
  • Member: Has permission to update all information in the Fact Sheets
  • Viewer: Has permission to read information and to add comments

Reset Your Password

If you want to reset your password while logged in, select your profile picture in the upper right corner, then go to My Settings > Password.

Notifications

You can set e-mail notifications and and stay on top of any changes done to your workspace. For example, you can be notified when a new Fact Sheet is created, a Lifecycle of a Fact Sheet enters the next phase, or a user comments on a Fact Sheet you are subscribed to, to name just a few of the notification options.

Notifications are a powerful tool to keep track of your Data Quality and enable collaboration within the tool. This is why we recommend keeping notifications active, at least until you develop a LeanIX community that is self-sufficient.

Information:

Above are just a few basic administrative features. See the Administration Overview for in-depth information on managing your workspace.

Getting Started


This section will give you a general overview of the LeanIX structure, introduce you to features necessary to manage your user account, and show you how to invite other users to LeanIX.

Suggested Edits are limited on API Reference Pages

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