ArchiMate® model data can be exported from Enterprise Studio to Elasticsearch to create custom indexes that can be used for index patterns in Kibana dashboards in Horizzon. The Kibana connection is used for this.
Before you start exporting model data to Elasticsearch, make sure you have validated your Kibana mappings.
Exporting model data to Elasticsearch
How and from where you can export model data via your Kibana connection to Elasticsearch depends on whether you have only one mapping in the connection or multiple mappings. If you have a Kibana connection with only one mapping in it, then select your Kibana connection in the Connection view and click .
During export, the index name as defined in the Kibana connection is checked for validity. If the name does not meet the requirements as defined by Elasticsearch, all invalid characters will automatically be removed from the index name and the export will continue. So make sure your index name fits the requirements, or else the index name in Elasticsearch may be slightly different.
If you have a Kibana connection with more than one mapping, you can choose to export the model data using all mappings, only a selection of them, or just one of them by excluding the mappings in the connection that you do not want to use, and then perform the export.
If you only want to use a particular mapping, the easiest way is to perform the export from within the Kibana mapping itself instead of excluding mappings. To do this, open the canvas menu in the respective mapping view and click .
If the export is completed, the Export to document store window appears showing a summary of the export in a table:
Elasticsearch has created a custom index for the table with the exported data. This index is now available in Kibana and can be used to create a custom index pattern for your Horizzon dashboards.
Creating a Kibana index pattern with your custom Elasticsearch index
One of the steps in creating a dashboard in Kibana is creating an index pattern for the dashboard. The dashboard uses the index pattern to retrieve the data you have exported using the Kibana connection. To make sure your dashboard uses the right data you need to find the newly created custom index.
- Open Kibana in Horizzon.
- In the Kibana sidebar, click
to open the Kibana menu, and under Management, click Stack Management.
- In the sidebar menu, click Index Patterns, and then click Create index pattern.
In Index pattern name, type the name of the created custom index as defined in your Kibana connection. If export has been successful, the index will directly show up. If needed, complete the name of the found index so that it fully matches the name of the custom index.
You can use a wildcard * to find the proper index name. But when saving the index pattern it is also allowed to include a wildcard in its name. It can be useful if you want the index pattern to match multiple data sources.
However, please carefully consider whether to include a wildcard in the name or not. When recreating indexes in Kibana, there is the possibility, because of the wildcard, that unwanted (old) data sources will be matched and included, and therefor giving unexpected results in your data.
- Click Next step, and then click Create index pattern.
You have now created a custom index pattern for your dashboard. You can continue creating visualizations in Kibana via , Kibana > Visualize.
Example of a custom index pattern
Elasticsearch and Kibana are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.
ArchiMate is a registered trademark of The Open Group.