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

Survey Add-On

Surveys are a great mechanism to increase data quality in LeanIX by reaching out to responsibles without tedious XLS lists, as well to collect further information, e.g. related to IT Security or GDPR

Poor data quality is costing organizations an average of 14 million $ / year (Gartner). As Enterprise Architects are often more involved with keeping data up-to-date than with creating value, we designed the Survey Add-On as one more tool in the EA repertoire. It allows you to collect information from responsible persons without the hassle of sending out individual mails.

License Information

The basic version of LeanIX Survey is included in most versions. In addition, the Add-On "Survey Powerfeatures" enriches the basic functionalities. It allows the use of Fact Sheet elements within your Survey, to group questions, and to calculate scores based on survey results.

To whom can surveys be sent?

You can send Surveys to
Viewer, Member, Admins and Contacts - (the same rights apply here as in the tool, see here)

Attention: The survey cannot be sent out to Contacts, when you have a "Fact Sheet segment" used (so that user can edit fields in the Fact Sheets)

As you can see, you cannot choose a contact:

Design your Survey

Information

Complementary to this guide you find a nice step-by-step video tutorial on how to create your first survey here: LeanIX Tutorial: Survey Add On

To create a new survey you need to go to the admin area and chose the Surveys add-on.

1

Create New Survey: Here you can start to create a new survey. It will bring you to the next screen.

2

Survey Titles: List of surveys that have been run or are still active.

3

Survey Runs: Number of times a survey has been run.

4

Create Date: Creation date of the survey.

The first part of creating a survey is the survey design. LeanIX offers you different questions types that can be dragged to and edited in the box on the right side of the screen.

1

Question Types: Gives you a choice of possible question types like text inputs, number inputs, date inputs, mulitiple choice, single select, Fact Sheet segments, calculated fields, and question groups

2

Edit Box: The area to edit your survey. You can either drag & drop your items there or upload an existing survey (see 4).

3

Save & Next: You can save your survey here and move to the next screen. Besides that you can have a preview of your survey or import/export it using the "..." button.

4

Import Survey: Gives you the chance to import existing surveys or templates for re-use.

Information

The Fact Sheet segments, calculated fields, and questions group are subject to our Survey Powerfeatures add-on. Feel free to get in touch with your CSM to get more information on that.

The Import Survey option brings you to a dialogue where you can either import a .txt file containing JSON code or you can directly paste the code to the editor on the right. To make your life easier for re-using surveys you can build a survey using the drag & drop functionality and then export the JSON to re-use it at a later point in time or for another workspace.

While creating the survey you will already have a good idea about how it is going to look like. Make sure to enter titles for all sections and the survey itself.

1

Survey Name & Section: Shows you all the sections you put into your survey.

2

Fact Sheet Segments: To include segments from the Fact Sheets to your survey just check the boxes that you want to include. The segments will appear in the survey and the answers will be directly saved in the fact sheet.

3

Configuration: Use this option to add explanations to questions or configure conditions to single questions.

Insert a link to a survey
If you want to insert a link to a survey this is the way how to proceed (see screenshot below):

  1. Paste the word in which you insert the link into this brackets "[...]"
  2. Insert the link directly behind those brackets in this parenthesis "(...)"

Attention:

Be aware, there should be no space between those two parentheses.

If everything works the way it should, it should look like this (see screenshot below).

Conditionality enables you to show/jump to a question depending on the answers given before. To configure a rule, you first need to choose a question the rule should be applied to and then specify the rule. In this example, the question "Are you sure you are the IT-Owner of the Application..." needs to be answered with "Yes" to let this question pop-up in the survey.

Once you finished the design of your survey you can have a preview pressing the Preview button on the top right of the survey designer. Be aware that Fact Sheet segments will be illustrated by a placeholder in the preview mode.

After the final check of your survey design you can move on to step 2 clicking Save & Next.

Run your Survey

The Run Survey section enables you to scope your survey to a defined set of recipients, configure general survey settings, and configure the text of the survey invite according to its purpose.

Information:

Using the "Survey Test Run" option, each of the workspace users will receive an invitation to participate in the survey. It will be listed in the "TO-DOs" panel on the home screen.

1

Fact Sheets & Recipients: Enables you to narrow down the to specific Fact Sheets and subscribers that should be adressed by the survey.

2

Selection: Provides an overview of the number of recipients and addressed Fact Sheets of the survey after scoping it. Also, it shows how many Fact Sheets do not have a relevant subscriber.

3

E-mail Setting: Offers you the chance to change the language of the pre-configured mail template or insert your own text according to your needs.

Clicking on Fact Sheets or Recipients brings you to our standard search dialog. Here you can narrow down the list of applications you want to address in your survey using the filter options on the left side of the window. Besides scoping the survey you want to address the right persons to answer your questions. You can do that by choosing the needed subscription roles in a drop-down beneath the filter bar.

Best Practice

To focus your survey it is best practice to introduce subscriptions roles according to the role model you have in your organization. This will enable you to not only to address a responsible person but it will allow you to reach out to a specific e.g. Application Owner, Solution Architect or Data Security Officer.

Behavior in Surveys for only one fact sheet with several subscribed users

Notice: If you have several subscribed user to only one Fact Sheet and run a survey - it will be closed by the first one who answers it.

After scoping, the selection section gives you a comprehensive overview about recipients and referenced Fact Sheets.

In case there are Fact Sheets in scope that do not have the subscription role needed - and thus will not be received by any person - you can walk through a specific list of fact sheets without recipients and edit the subscriptions.

If you want to test your survey doing a Test Run you will find the option to do so on the bottom of the page. You can add any e-mail address here to see how the survey appears to your recipients.

Check Survey Status & Results

As soon as you run the survey you will be forwarded to the results and status page. Here you get an overview of general information regarding your survey.

1

Recipients: Number of recipients that already answered the survey compared to the number of overall recipients.

2

Fact Sheets: Number of Fact Sheets that have already received answers in comparison to overall number of Fact sheets.

3

Language: Actual language the survey has been sent out in.

4

Download & Settings: Provides the option to download your survey results, finish the survey or check for changes (e.g. new subscribers) while the survey is running.

Attention

Make sure to finish your survey as soon as all the answers are logged so nobody will be able to edit them afterward.

As soon as the recipient clicked on the survey link in the email, she/he that received the survey will be viewing the survey in a regular LeanIX window. In case you need to answer questions for more than one Fact Sheet you can jump to another Fact Sheet using the arrows on top of the survey.

Besides getting a notification via email, open survey request will appear up in your personal To-Do Panel on the home screen.

Information:

There are four different status for the surveys:

  1. New: the survey is new
  2. In progress: the user answered but didn´t finish
  3. Done: finalized
  4. Obsolete: answer not required based on two points:
    a) there is no user subscribed to the Fact Sheet
    b) attribute targeting in the Fact Sheet has changed, and the Survey is not in the pool anymore

The results of the survey will be shown in the survey-tab on the related Fact Sheet.

An exception is Fact Sheet Segments of your survey. This values will be directly edited as updated values in the Fact Sheet itself. To keep track of any changes you have the chance to look them up in the "Last Changes" section.

Check for changes in the Fact Sheets and recipients

Once the survey is designed, there are two options in the tab "Run survey" which provide added value:

  • Automatically check for changes: The system checks for changes and send out an email if further responses are required or marks survey responses as obsolete.

Important

When selected "Automatically check for changes" the survey will constantly check the changes in the scope of the filtered criteria.
Example:

  1. Tag "X" is selected in the survey filter
  2. Tag "X" is removed in the Fact Sheet which is part of the survey
    RESULT:
    I. The answers to the survey are removed from the survey tab of the Fact Sheet
    II. The answers can only be downloaded from the survey poll (admin area) - The status of the answers will be set to "Obsolete"
  • Send email on updates: Notify the recipients if a Fact Sheet is added or removed from the survey.

From the administration point of view, we can also check if there are changes in any of the Fact Sheets, which in result will impact the survey. In the tab Status & Results, click on the option "Check for changes", the system will then display a message when changes are made in the Fact Sheets.

Advanced: Send Surveys to Contacts

There might be a situation where you want to send surveys to persons that are not using LeanIX. To do this make sure that your edition includes the feature to subscribe contacts to Fact Sheets. To find out more about handling contact check our section Working with Fact Sheets.

So if you want to send surveys to a contact without inviting them to LeanIX the following steps are required:

  1. Add your business contacts to the Fact Sheets that are responsible for and give them a defined Subscription Role (e.g. “Business Contact”). To find out about how to define your own subscription roles, please have a look at our section Subscription Roles.
  1. Design your survey as described above.

  2. Go to “Run Survey”

  3. Go to “Fact Sheets – Click here to select” to select the Fact Sheets and Subscribers you want to address

  4. On the right-hand side choose “All users (incl. contacts)” from the drop-down (see attachment)

  1. Narrow down the filter for the recipients to subscription role (e.g. “Business Contact”), so that just your business contacts are getting the survey.
  1. As you proceed with the survey process, the survey will now be sent out to the contacts without inviting them.

Information:

When using our survey power feature Fact Sheet Segments the survey cannot be sent to contacts. This is because you need the right permissions to be able to edit information within the fact sheets. As soon as you want the recipient to directly edit information in a Fact Sheet, the addressed person needs to be an active LeanIX user.

We strongly recommend to include as many people to contribute to LeanIX as possible. So do not hesitate to invite your business contacts to the tool.

When the Fact Sheet Segments are not running in the survey that means that the segments were deactivated for the Fact sheet.

To deactivate the Fact Sheet segments please follow the next steps:
Go to Administration - Fact Sheet Types - Application - Advanced and disable Fact Sheet Segments that are shown in the survey. The solution is to recreate the survey without disabling the Fact Sheet segments.

Advanced: Calculated Fields

License Information:

Calculated Fields are only available when using the "Survey power features" Add-On.

The "Calculated Fields" functionality provides Survey Designers the option to quantify the survey results and to derive a certain score. It takes standard JavaScript as an input and is expected to return an Integer, as demonstrated in the following example:

// Enter any JavaScript code to calculate a value based on the user's responses
// saved in the 'answers' object and return that value at the end. The response to
// any single questions can be accessed either by the question's index or label text.
// (Hidden questions and Fact Sheet questions are always present in the array with the
// value 'null'. Questions groups have no impact on the answers array whatsoever.)
// The following example is based on the availability demo survey:


var score = 0;
score += answers[0] === 'Many outages' ? 10 : 0;
score += 5 - answers['Which channels of communication did you use to inform your users about availability issues?'].length;
score += /crucial customer/i.test(answers[4]) ? 50 : 0;
return 'Overall score: ' + score;

Best Practice & Examples

IT Security assessments are one typical use case in which Surveys are helpful. Learn more in our whitepaper:

Streamlined IT Security Management with LeanIX Survey

Other typical examples are illustrated here:

Survey Add-On in LeanIX

Finally, check the following video to learn more, especially related to data quality.

LeanIX Webinar: Better data quality with survey add-on

Advanced: Survey API

We provide an open API to access survey runs and results. Check out https://dev.leanix.net/v4.0/docs/api-overview#section-poll-api-custom-surveys to learn more.

Survey Add-On


Surveys are a great mechanism to increase data quality in LeanIX by reaching out to responsibles without tedious XLS lists, as well to collect further information, e.g. related to IT Security or GDPR

Suggested Edits are limited on API Reference Pages

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