Skip to main content

Get help for ARIS

On-premises - Set up and configure Matomo

If you want to generate auditing-based dashboards from ARIS content, you must set up and configure the external web analytics application Matomo. Matomo is not included in this ARIS package.

The following describes the Matomo usage in a distributed environment. You can also install Matomo on an existing ARIS server. In this case, the ARIS agent is already installed, and you must only add the additional runnables to the ARIS server. Note that running ARIS and Matomo on one and the same server may result in a considerable loss of performance.

Prerequisites

  • You have the ARIS for Matomo - Ext. Enterprise (YAYMX) license.

  • You have the ARIS Enterprise Admin license privilege.

  • You have disabled the Do not track browser option.

  • You have a valid Matomo subscription.

  • You have installed ARIS agent on the machine on which Matomo is running.

  • You have enabled site search tracking for the ARIS website.

Procedure. Procedure

  1. Set up Matomo. You must install a Web server, PHP, a database, and deploy the Matomo Web application. For further information, refer to the Matomo installation guide. During the Matomo setup, gather the information to configure ARIS.

  2. Go to the Matomo website and create a new page. Enter your e-mail address and the website address you want to observe.

  3. Accept the terms and conditions and the data processing agreement (DPA).

  4. Click Start improving your websites now. You will receive an e-mail with a link.

  5. Click this link and specify your password. Remember the URL of the page on which you set your password. You will need it in ARIS when you configure the Matomo integration.

  6. Click Settings Settings > Websites > Custom Dimensions.

  7. Click Configure a new dimension.

  8. Enter a name. We strongly recommend that you enter tenant as the name.

  9. Enable Active.

  10. Click Create.

  11. Under Visit Dimension, the ID of the custom dimension is displayed. Remember this dimension ID. You will need it in ARIS when you configure the Matomo integration.

  12. Under Action Dimension, click Configure a new dimension. Enter resource-path as the name, enable Active and click Create. The ID of the Action Dimension is displayed. Remember this dimension ID. You will need it in ARIS when you configure the Matomo integration. Do the same for the resource-type. You will need the IDs to parameterize the Matomo reports later in ARIS and to configure the eventsubscriber runnable.

  13. Select Personal > Security to generate a new token.

  14. Click Create new token.

  15. Click icon_epc_copy Copy to copy this token to the clipboard. You can copy this token only once. Remember this token. You will need it in ARIS when you configure the Matomo integration.

  16. In ARIS, click Application launcher Application launcher > Administration Administration > External system integration.

  17. Enable Enable Matomo integration.

  18. Enter the URL of your Matomo website.

  19. Enter the authentication token.

  20. Enter the custom dimension in the ID of tenant dimension for Matomo field.

  21. Enter the ID of the resource-path in the ID of resource path for Matomo field.

  22. Enter the ID of the resource-type in the ID of resource type for Matomo field.

  23. Click Apply.

You have set up the ARIS-Matomo integration. The configuration of the Matomo integration is saved when the default tenant is backed up. It can be restored.

To check whether everything is set up correctly, log out of ARIS and log in again. Log in to your Matomo site and click Dashboards. If everything is set up correctly, you will see a dashboard and the first two events that were tracked.

All actions from the same computer within a time frame of 30 minutes are regarded as one visit, regardless of which browser or tenant is used.

Logged are all activities under Published content. In the modeling component, nothing is logged. Searches and search types are logged.

The client IP address is logged. The client sends a request, and the server responds. The IP address seen by the server is the client IP address. If the user uses a browser from a company network, the client IP address can be a company address.

Please refer to the Matomo documentation for further details:

How is a visit defined in Matomo?

What data does Matomo track?

How does Matomo detect unique and returning visitors?

How is a unique visitor counted in Matomo?

Why the reports are not up to date in Matomo Cloud?