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.

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.

  2. During the Matomo setup, add the Web site:

    Name =ARIS, URL = http://<host>:<port>.

    Alternatively, register ARIS as a Web site in an existing Matomo installation.

  3. After Matomo is set up, open the its configuration.

  4. Enable unique visitors processing for day, week, month, and range. Day, week, and month are enabled by default.

  5. Because ARIS relies on Matomo segments to behave as a filter, you must disable the segments cache for Matomo versions 3.12.0 and higher.

  6. Log in to Matomo.

  7. Create a user with view permission on the ARIS Web site and copy its authentication token to a text file.

    You need the token to parameterize the Matomo reports later in ARIS Architect and to configure the eventsubscriber runnable.

  8. Install the Custom Dimensions Matomo plugin.

  9. Activate the plugin.

  10. Create a new Custom Dimension named tenant for visits and two Custom Dimensions named resource-path and resource-type for visit actions. Set all of them to active and copy the IDs to the text file. You need the IDs to parameterize the Matomo reports later in ARIS Architect and to configure the eventsubscriber runnable.

  11. Make sure that site search tracking is enabled for the ARIS Web site.

  12. If the usage of published content is expected to be high, we recommend disabling archiving of browser-triggered Matomo reports. To prevent performance issues, you are recommended to set up auto-archiving as a background task that runs in a fixed interval. You must complete this task before running any scheduled ARIS reports that access the Matomo data.

Matomo is installed and configured to use ARIS.

Install the ARIS agent to the machine where Matomo is running and add the additional runnables.