Add runnables

The eventsubscriber runnable is an additional component to be deployed on the machine where Matomo is running. You basically need to add two additional runnables to your installation, the eventsubscriber runnable itself, and the cdf runnable (Cloud Decoupling Framework), which is required for communication between the components. CDF is a queue which can be used to decouple synchronous accesses to services.

This procedure assumes that you will add the cdf runnable to your ARIS installation and the eventsubscriber runnable to the Matomo server.

Prerequisites

Procedure

  1. Start ARIS Cloud Controller (ACC) on your ARIS Server.
  2. Enter the agent user's password.
  3. Make the ARIS Agent use the remote repository for downloading the runnables from.
  4. If you have installed the ARIS server using the setup, the ARIS Agent will be set to only take runnables from its local repository, to change that run the command:

    set local.repository.only=false

    The ARIS Agent will use the provided remote repository.

  5. To add the CDF runnable, enter the command:

    Example:

    configure cdf_m cdf_m

    Note that different from most runnables, the sizing m or l that you choose does not matter for the CDF runnable.

    When adding the CDF runnable, you will not be able to update this installation with an update setup. As the setup will recognize that the installation has been tampered with. You can either update the installation manually (see ARIS Update Cookbook) or you can remove the runnable with the ACC deconfigure command (see ACC help), then run the update setup and add and configure the new version of the CDF runnable again.

  6. Enable usage tracking in all abs runnable instances and in all copernicus runnable instances. Enter, for example:

    reconfigure abs_m JAVA-Dcom.softwareag.copernicus.tracking.enabled=true

    reconfigure copernicus_m JAVA-Dcom.softwareag.copernicus.tracking.enabled=true

  7. Install ARIS Agent on the machine where Matomo is installed. The ARIS Agent setup is available on DVD.

    This makes ACC available on this machine.

  8. To add the eventsubscriber runnable to the Matomo server, start ACC and issue the command, for example:

    configure eventsubscriber_m eventsubscriber_m

  9. Reconfigure zookeeper.connect.string to point to all machines with a ZooKeeper instance, for example:

    reconfigure eventsubscriber_m zookeeper.connect.string="arisapp33srv.eur.com:14281,arisapp45srv.eur.com:14281,<host>:<port>, ..."

    The eventsubscriber runnable will access Matomo via http://localhost:80/. If this default is not sufficient, reconfigure piwik.server.host, piwik.server.port, and piwik.server.path accordingly, for example:

    reconfigure eventsubscriber_m piwik.server.host="arisapp44srv.eur.com" piwik.server.port=8080 piwik.server.path="piwik"

  10. Reconfigure piwik.site.id to the ID of the ARIS Connect website in Matomo (see saved parameters from Matomo installation), for example:

    reconfigure eventsubscriber_m piwik.site.id=1

  11. Reconfigure piwik.visit.tenant.dimension.id, piwik.visit.action.resource.path.dimension.id, and piwik.visit.action.resource.type.dimension.id to the IDs of the tenant, resource-path, and resource-type Custom Dimensions that were created in Matomo, for example:

    reconfigure eventsubscriber_m piwik.visit.tenant.dimension.id=1 piwik.visit.action.resource.path.dimension.id=2 piwik.visit.action.resource.type.dimension.id=3

  12. Reconfigure piwik.authentication.token and set the authentication token of an appropriate Matomo user with view permissions for the ARIS Connect website (see saved parameters from Matomo installation). It is advisable to mask the value of the property with the ?= reconfigure operator in ACC, for example:

    reconfigure eventsubscriber_m piwik.authentication.token?="f722a764407aef36bf212c6665e53500"

  13. For the changes to become effective, you need to stop and restart eventsubscriber runnable.

The runnables are available. Make sure that they are running.

To use the Matomo reports in ARIS, you must specify the report parameters accordingly.