In this guide, you will learn:
- How to get started with the LeanIX Store
- How to become a Publisher and what our review criteria are
- How to publish your first custom report
The LeanIX Store provides access to custom reports. You can download reports from the Store to your Workspace. You can also publish your custom reports to the Store.
The LeanIX Store includes free and paid reports. LeanIX reserves the right to release a paid option and other asset types, such as survey templates, configurations, and snapshots, in the future.
The LeanIX Store is designed to:
- Further grow the LeanIX ecosystem by driving continuous product innovation in addition to the core product.
- Provide partners with a platform to share their knowledge and offer their expertise.
- Offer our customers quick access to best practice insights, such as domain- or industry-specific, to generate value in no time.
To navigate to the LeanIX Store from your Workspace, on the user menu, select Store.
To browse the LeanIX Store, select Browse and find the resources that you need.
Only administrators can download reports from the LeanIX Store. If your role is Member or Viewer, and you want to download a report, contact your Workspace administrator for assistance.
To download a report from the LeanIX Store:
To add a report to your Workspace:
- When signed in to the LeanIX Store, select a report, and then click Add to Workspace.
- Before proceeding, review the Terms & Conditions of the Provider.
- Agree to the Terms & Conditions of the Provider. The Terms & Conditions vary for each Content Provider.
- Once agreed, finish the process and close the overlay.
The report is added to your Workspace from which you signed in to the Store. Now, you need to make the report available in your Workspace.
To activate the report in your Workspace:
- In yout Workspace, on the user menu, select Administration.
- On the left navigation panel, under Advanced Settings, select Reports.
- In the list of reports, find the report that you downloaded from the Store, and click Show report to activate the report.
The report that you activated appears in the Reports section of the Workspace.
When adding new reports from the Store, please be patient. It may take up to 3 minutes to process all your data in the Workspace.
To become a Publisher on the LeanIX Store, build your own reports and then publish them to the Store.
The image below shows the workflow of publishing reports to the LeanIX Store.
To publish a report:
Set up a GitLab account.
- We rely on GitLab as a repository to manage the source code of both publicly available and privately used custom reports. Please make sure to have an account created with the same mail address as your LeanIX user before continuing.
- Please note that we have to approve each report before you can publish it to a LeanIX workspace. GitLab helps us to accelerate this process by using a shared source code repository.
If you're new to GitLab, see Use GitLab to learn how to get started. Set up your environment according to best practices, such as by adding an SSH key.
Sign in to the LeanIX Store, and then click Become a Publisher.
As a LeanIX Partner, you need to sign the Store Content Provider Agreement in order to have your publisher request approved. This contract governs topics such as ownership and intellectual property of a report. Please contact your LeanIX Partner Manager in case of questions.
As a LeanIX Customer, you can create custom reports for your own workspaces without an explicit agreement. If you want to share reports with other customers, you need to sign the Store Content Provider Agreement. Please contact your Customer Success Manager in case of questions.
Once you have created a publisher request, you will receive an email with further information.
In this section, we provide an overview of the criteria we will check during the custom report review process. Below are the steps that we follow when reviewing a report for publication.
As a general rule, the entire review process should not take longer than 10 business days, but can occasionally take longer, depending on the complexity and quantity of current review requests. If minor changes to an already existing report are to be reviewed, please let us know, so we can expedite the process.
For the reporting metadata, the following points are required:
Screenshots should be exactly 1280px x 800px with a maximum size of 1 MB.
Multiple screenshot should show a clear progression through the report
Screenshot should always show the full browser and not be cut.
Thumbnails should be exactly 1280px x 800px with a maximum size of 400KB.
- A report should always have a concise summary of its use cases, functionality, used Fact Sheet types and tags
- Is the report changing existing data (e.g. mutation)?
- Are configured data fields required
- Are specific tags required
- Which data is required for the report to work
Dependencies will be audited with npm audit more info, vulnerable dependencies will be rejected. Please provide information about cases, where changing the used library is not viable.
- The code should be commented extensively
- Traversing JSON response objects should include a null-checker
- API calls and especially mutations need to be clearly visible and must not obfuscate what data is used in which way
- Calls to an external API, other than an LeanIX API, are not allowed. Sending data to external systems is strictly forbidden. Get in contact with support, if your use case requires this functionality.
The code needs a readme file, where, as a minimum all steps required for installation are listed. If dependencies with special installation requirements are used, those will have to be listed as well.
Framework functionality should be used as much as possible and not be re-created, For details, see Review framework functionalities.
The licence status of all used dependencies will be checked.
Commercial dependencies should be clearly marked in the documentation, and confirmation of eligibility will be requested.
The report must run out of the box without producing any unhandled errors.
Reports should be using the same look and feel as default reports:
Reports need to have a clear use case.
As a Publisher, you can go to your dashboard in the LeanIX Store to view developed reports and their statuses.
In your LeanIX Store dashboard, navigate to Reports from the panel on the left, and then click the "+" icon next to Reports Management.
Fill out and save the form with report name. This will create a Gitlab Project link in your repository with the Gitlab account shared while requesting publisher access.
The newly created report is now displayed on the list and we open after creation.
You will be able to maintain the source code in GitLab. You can find the link to the repository in the detail view of the report. You can also change minor details such as description, logo, title etc.
There are three publishing modes to select from:
- The Public option allows any LeanIX customer to install the report and view the source code.
- Preview allows a user to view a sample of the report without the ability to install it to their workspace.
- The Private option allows you to select which workspaces the report is available to. It doesn't necessarily have to be your own company's workspaces.
If you choose Private as your publishing mode, you need to specify the workspaces where the report should be uploaded using the workspace IDs.
Once you have developed the report you can ask the LeanIX Customer Success Team to begin the review process by saving and clicking the "Submit for Review" button in the detail view of your Report.
Please ensure to have the final working code in Develop Branch before submitting your report for review.
During the review, the team will review the code and content. Technical implementation, functional suitability, and licenses used are considering during this process.
You will soon receive an email whether your report was approved or if there are questions and concerns that need to be addressed.
Once published, the report becomes available on the Store based on the publishing mode selected earlier.
Once the report is published, navigate to Published Reports, and click Create New Version to create new report versions.
You can submit new versions of your reports with enhanced features, functionality, or bug fixes. It will be subjected to the same review process as a new report and the process is identical. Please remember to raise the version number in your GitLab Project (package.json file). Otherwise, it may cause errors while adding the new version to the workspace.