LeanIX - Product Documentation

Welcome to the LeanIX Product Documentation. Here you will find all the basic information you need to start working with LeanIX. We provide you with 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

Signavio Integration

This section provides an overview of how to configure your Signavio integration with LeanIX and unleash the power of integrating your architecture work with your Business Process Management.

Signavio Configuration Guideline

Signavio is a web-based tool for business process management. Connect it with LeanIX in order to link your application portfolio to business processes. The new integration 2.0 now allows mapping further Fact Sheets to glossary items in Signavio.
Check out our whitepaper about the Out-of-the-box EAM and BPM Integration to learn more.

In the following we will show you how to set up the integration step-by-step:

General Configuration

To configure the Signavio integration you need to go to the "Administration" area, then select Integrations in the left-hand panel. Here you have the possibility to configure and activate Signavio for your LeanIX workspace. Click on Configure to do so. You can the Status of the Signavio integration (active/inactive) for your workspace and check its current version.

Please make sure that you have your Signavio account with this domain: https://editor.signavio.com

In the Credentials tab, fill in all mandatory credentials: Fill in the Signavio URL, your Signavio Username, Password and your TenantID.

Check the box "Active" to activate Signavio for your workspace and save the settings.

📘

Information:

If you have more than one user be sure that you use the right TenantID. If the TenantID is not visible, uncheck the "Active" Box in the administration area in LeanIX and save it. Then check the "Active" Box and save it again. The TenantID should be visible again.

Configure the data exchange

The following screen allows you to set your basic settings for the Signavio integration.

1

Strict: Strict means that items on the slave side without corresponding master item are deleted on the slave side. This makes sure that both systems always have the same data.

2

Use Interval: Synchronization based on the pre-defined time interval (every 3 hours, between 6AM and 6PM CET/MEZ). This setting should be checked for the Sync hiearchy top-down.

3

Fact Sheet Type: Choose the Fact Sheet Type the information is synchronized to. Process is the most logical Fact Sheet Type to choose.

4

Process Hierarchy: Here you can choose between three different options, if your hierarchy should be synced bottom-up, top-down or not be synced. See next screenshot for details.

5

Published: Allows you to decide if all Signavio processes should be synchronized or only the published ones.

6

Edit Directories: It's available when choosing "Bottom-Up" or "Do not sync" hierarchy, and it enables you to select the Signavio directory you want to start synchronizing from. When selecting the "top-down" sync hierarchy, this changes into "Edit Hierarchy".

7

Edit Inbound Mappings: Allows to define Signavio attributes to be synchronized into Fact Sheet fields.

📘

Information:

For processes synchronization Signavio should always be the master LeanIX is the slave.

You can decide between three options to sync your process hierarchy:

  • Do not sync hierarchy will sync the complete Signavio directory you specified in the settings.
  • Sync hierarchy bottom-up searches for defined processes (based on LeanIX Fact Sheet) in configured Signavio Directories(and SubDirectories) and synchronizes all processes from bottom to the highest level processes.
  • Sync hierarchy top-down will start at the specified root node and synchronizes all processes walking down the hierarchy. Use interval is mandatory for this configuration.

When clicking on Edit Hierarchy the following window will open.
Here you need to fill in the Signavio ID of the root node Process in hierarchy to be synchronized.
At "Ignore Processes" you can insert Signavio IDs that should be ignored by the synchronization.

The following window will open when you selected Bottom-Up or Do not sync at the Hierarchy Processes. Here you can fill in the LeanIX Parent Fact Sheet or a list of Signavio Directory IDs, in which the process models should be searched. If none is given, the public root directory is used. The Directory ID is shown at the last part in the URL, after the last slash.

📘

Relationships created int he hierarchy

Parent-child relationships are created for the hierarchies detected between Processes in Signavio EXCEPT when we detect (in LeanIX) a double parent situation, then we choose a different relation in the fact sheets, which is RelToRequires.

Inbound Mappings Configuration for Processes

In this section we will explain how to configure different mappings from Signavio to LeanIX. For those mappings we will use the Edit Inbound Mappings modal. Description of the Edit Inbound Mappings modal:

1

FactSheet Field Name: Here the Fact Sheet field has to be selected to which the LeanIX Signavio Integration is going to write. We provide a list of all available and previously not select fields.

2

Mapping Type: Select between "Static" and "Signavio". This will change the behavior of the next field.

3

Information Source: In case "Static" was selected in the previous field, the String that is added here is written as a fixed value into the configured fact sheet field. In case "Signavio" was selected, a dot-separated path has to be specified here, which describes the path where the data can be found in Signavio.

4

Actions: Value Mappings.

Basic Case 1: Without Inbound Mappings

In case no mappings are specified in the Inbound Mappings Modal, the integration will synchronize the name as well as the description of a Signavio Process into a Fact Sheet.

Basic Case 2: Write static values to fields

In case you want to write the same value into all Fact Sheets that are synchronized by the integration, you have to specify a static mapping. In our example, we first created a custom field in the data model for our specified Fact Sheet type called comment. We now select comment as the FactSheet Field Name, Static as the Mapping Type and we specified the value Synchronized by LeanIX Signavio Integration in the Information Source column.

Basic Case 3: Write Signavio attributes to fields

In case you want to write an attribute of a Signavio process into a Fact Sheet field during the synchronization. In this example, we first created the language field and selected it as FactSheet Field Name. For Mapping Type we select Signavio, and fill the Information Source with the dot-separated path to the attribute.

For a detailed explanation of how to obtain the path, we can see the Appendix A: Signavio Endpoints. In our example, the value editordata.model.properties.language for Information Source refers to the Language of a Signavio Process. In the Signavio Editor UI, the Language can be found under the More Attributes subsection of the Attributes section. The integration will now synchronize the Language specified in each Signavio Process into the Fact Sheet Field Language.

Basic Case 4: Write value mappings

In case you want to map the value from a Signavio attribute into a different value for a Fact Sheet field, you need to specify the mapping. For our example, we want to modify the incoming Language from its Signavio value into the two-letter international code, so English will be synchronized as EN , German as DE.

We configure the same values for Inbound Mapping as we did in the previous example for mapping the language attribute to a Fact Sheet field. Then we select the Value Mappings button in the Actions column to open the Edit Value Mappings dialog. In the dialog we can specify our mapping as described above.

With the next synchronization, the values specified in the mapping will be written into the fact sheet field language based on our mapping. In case there is no mapping specified for a Signavio Value we will see a warning in the SyncLog entries, and the previous value in the Fact Sheet will be deleted.

Synchronize Applications to Signavio

👍

Best Practice

To guarantee single sources of truth for your data in IT it is common sense to not only sync your processes with LeanIX but also use the applications mastered in LeanIX in your Signavio solution.
Important: Please be aware that currently you can fill in the Signavio glossary only one language from application descriptions or merge multiple sources in one Singavio field. But you can't feed application data in multiple languages on Signavio side.

To synchronize Application to Signavio go to the Glossary Category Mappings section. Select Applications as Fact Sheet Type and fill in the following information:

  • Fact Sheet Type: Specify the fact sheet type or subtype.
  • Glossary Category ID: This Signavio Glossary ID identifies the glossary category this Fact Sheet type will be linked to. (This ID can be found in the URL of the associated dictionary object.)
  • LeanIX Relation: If a relation is provided, links from a Signavio Process to a glossary item of the current type will be mapped to this relation.
  • Master: Synchronization is performed by reading from the master side and writing to the slave side.
  • Strict: If it is checked, it implies that missing elements in the master side will be removed in the slave side. For LeanIX as master, fact sheets not found in the Glossary Category ID column specified will be removed from the Signavio Dictionary.
  • Actions: The button Edit Filter opens a dialog with similar functionality as the Inventory to further filter the selected Fact Sheets. Delete allows to delete a configuration row.

Once you have filled in all the required information click on Sync Now to start the synchronization to Signavio.

📘

Information:

All Applications from LeanIX will be displayed and synchronized to Signavio. To get an overview about your sync and if everything is working fine you can check the Sync Logging in the administration area in LeanIX. Here you get more information about your sync jobs.

If there is an error message by synching the Applications to the glossary, please check if there are no duplicates.
Check the display name. Maybe an Application already exists in another glossary.
There are two options to solve the issue, you can move the Application to the correct glossary or delete the Application in the old glossary and make a new sync.

To see all Applications from LeanIX in Signavio please click on "Dictionary" in the left panel at Signavio.

All applications are synchronized to the dictionary you selected in the basic settings. Usually, the Applications should be synced to the Dictionary "IT-Systems". Select "IT-Systems" at the right menu bar to get an overview of all the LeanIX Applications.

Synchronize Signavio Glossary Items to Fact Sheets

In case you want to create Fact Sheets based on Glossary Items, select the target Fact Sheet type in Fact Sheet Type column. In case of subtypes, they can be selected in this column as well. The Glossary Category ID defines the category where the glossary items will be taken from. Optionally, we could choose the relation type. Then we select Signavio as Master. Finally, the Strict Mode can be checked if we want to delete all Fact Sheets of the specified type that are not synchronized from Signavio.

Appendix A: Signavio Endpoints

Signavio provides endpoints to obtain Signavio Processes as well as Glossary Items as structured data.
The LeanIX Signavio Integration currently provides access to three Signavio endpoints. The path within the structured data can be specified in the Information Source field of the configuration with a starting keyword that refers to each endpoint.

  • For Processes: /p/editordata?id=(id) keyword: editordata
  • For Processes: /p/model/(id)/info keyword: model
  • For Glossary Items: /p/glossary/(id)/info keyword: glossary

In the following sections we will describe how to explore the data that can be obtained from those endpoints using the Chrome Browser.

For Processes

Editordata Endpoint

In this section we are going to explain how to use the Developer Tools of the Chrome Browser to explore the data retrievable from the /p/editordata?id=(id) endpoint.

  • Open up a process in Signavio with the model editor
  • Open the Developer Tools (Customize and Control (three dots) > More Tools > Developer Tools)
  • Select the Network tab in the Developer Tools and reload the model editor page
  • The Developer Tools now show all the calls the browser does when loading the model editor
  • Enter 'editordata' into the filter, to only see the call to the /p/editordata?id=(id) endpoint
  • Select the entry and select to the Preview tab
  • The Preview tab will show the data that is available via the /p/editordata?id=(id) endpoint
  • The complete data that is shown is available to the LeanIX Signavio Integration via the editordata keyword
  • One of the more interesting sections of this map is the model.properties map, which for example contains custom fields

Process Language Example

In the previous configuration examples we wanted to write the language of a process into a custom Fact Sheet field. The image below shows the language attribute within the JSON retrieved from the editordata endpoint using the Developer Tools. The path to the language has to start with the editordata keyword, because we obtain the data from this endpoint. Then the path within the data structure has to be added which is model.properties.language. Finally we have the complete path editordata.model.properties.language that can be added into the Information Source field.

Model Endpoint

In this section we are going to explain how to use the the Developer Tools of the Chrome Browser to explore the data retrievable from the /p/model/(id)/info endpoint. The Signavio model editor dose not call the endpoint itself, thats why we are going to use the /p/directory/ endpoint to retrieve the same data as given by the /p/mode/(id)/info endpoint.

  • Open up a process in Signavio with the model editor
  • Open the Developer Tools (Customize and Control (three dots) > More Tools > Developer Tools)
  • Select the Network tab in the Developer Tools and reload the model editor page
  • The Developer Tools now show all the calls the browser does when loading the model editor
  • Enter 'p/directory/' into the filter, to only see the call to the /p/directory/ endpoint
  • Select the entry and select to the Preview tab
  • The Preview tab will show the data that is available via the /p/directory/ endpoint
  • The data given from this endpoint is a list of all the processes in the same directory
  • Select the entry where href: "/model/(id)" matches the id of the current process which can be found in the url
  • The subsection rep contains the same data as provided via the /p/model/(id)/info endpoint
  • The data shown below the rep keyword is available to the LeanIX Signavio Integration via the model keyword
  • An example of the data that can be retrieved from this endpoint is the published status which would have the Information Source path model.status.publish

Glossary Endpoint

In this section we are going to explain how to use the the Developer Tools of the Chrome Browser to explore the data retrievable from the /p/glossary/(id)/info endpoint. The /p/glossary/(id)/info endpoint itself is not used by the browser when loading a glossary item but it is still possible to explore the data via the /p/glossary endpoint that is used to get the data.

  • Open up Signavio dictionary
  • Open the Developer Tools (Customize and Control (three dots) > More Tools > Developer Tools)
  • Select the Network tab in the Developer Tools
  • Select a Glossary Item
  • The Developer Tools now show all the calls the browser does when loading the Glossary Item
  • Enter 'glossary' into the filter to get a subset of the calls
  • Select the last call and select the preview tab
  • Select the entry with the key value pair rel: "info"
  • The subsection rep contains the same data as provided via the /p/glossary/(id)/info endpoint
  • The data shown below the rep keyword is available to the LeanIX Signavio Integration via the glossary keyword
  • An example of the data that can be retrieved from this endpoint is the category name which would have the Information Source path glossary.categoryName

Appendix B: Advanced Tab

Signavio Integrations allows additional options to control the synchronization at a higher level of detail. Next to the Basic section in the settings page we also have the Advanced section, which shows the complete configuration as a data structure and allows us to modify it using a provided JSON editor.

The difference in using the Basic section compared to the Advance section is that we can introduce more complex expressions in certain properties. To avoid edition of these complex expressions using the Basic section, they are shown as disabled input fields.

To review more complex cases, which expand upon the basic cases that have so far been covered. By exploring the structure of the configuration data and demonstrate how to modify it for more complex synchronization scenarios. Please see the Signavio documentation in the Technical Documentation.

Updated 3 months ago

Signavio Integration


This section provides an overview of how to configure your Signavio integration with LeanIX and unleash the power of integrating your architecture work with your Business Process Management.

Suggested Edits are limited on API Reference Pages

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