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
You have a running ARIS server installation.
You have access to the ARIS Agent setup.
You have basic knowledge of how to use the
.ARIS Cloud Controller can be used in multiple modes.
To start ACC under a Windows operating system click Start > All Programs > ARIS > Administration > Start ARIS Cloud Controller. If you have changed agent user credentials you must enter the user name and/or the password.
To start ACC under a Linux operating system, execute the acc10.sh shell script instead. To do so, enter: su -c acc10.sh aris10.
You always run the ACC connected to your ARIS Agent(s), either using the usual command line switches to connect to a single agent (-h, -u, -pwd ) in case of a single node installation or using a node file (passed to the ACC with a -n switch) or by manually issuing add node commands in case of a distributed installation.
Start ACC using the start menu shortcut that was created with setup. Otherwise, make sure to always pass in the proper generated.apptypes.cfg file to this ACC using the -c command line switch. It is important that the generated.apptypes.cfg file is of the same version as the version of the installation to which you want to add the runnables.
Make sure to open specific ports between the ARIS Server and the server where the eventsubscriber runnable will be running. These are the zookeeper client port and the ActiveMQPort of the cdf runnable.
You have access to the Matomo configuration values (IDs and token).
Procedure
Start ARIS Cloud Controller (ACC) on your ARIS Server.
Enter the agent user's password.
Make the ARIS Agent use the remote repository for downloading the runnables from.
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.
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 ), then run the update setup and add and configure the new version of the CDF runnable again.
ARIS Cloud Controller can be used in multiple modes.
To start ACC under a Windows operating system click Start > All Programs > ARIS > Administration > Start ARIS Cloud Controller. If you have changed agent user credentials you must enter the user name and/or the password.
To start ACC under a Linux operating system, execute the acc10.sh shell script instead. To do so, enter: su -c acc10.sh aris10.
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
Install ARIS Agent on the machine where Matomo is installed. You can download the ARIS Agent setup from the ARIS Download Center.
This makes ACC available on this machine.
To add the eventsubscriber runnable to the Matomo server, start ACC and issue the command, for example:
configure eventsubscriber_m eventsubscriber_m
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"
Reconfigure piwik.site.id to the ID of the ARIS website in Matomo (see saved parameters from Matomo installation), for example:
reconfigure eventsubscriber_m piwik.site.id=1
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
Reconfigure piwik.authentication.token and set the authentication token of an appropriate Matomo user with view permissions for the ARIS 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"
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.