You are looking at documentation for an older release. Not what you want? See the current release documentation.
Installation
eXo Platform has partnered with Lecko to offer an engagement analytics solution that allows to monitor user engagement and let you drive end user adoption of eXo Platform.
This solution is presented as an add-on: the eXo Engagement Analytics by Lecko which can be installed via the addons manager using this command:
./addon install exo-lecko
eXo Engagement Analytics by Lecko add-on is used to collect metrics from activity streams via a job and it dumps them in a flat file on disk.
Having dumped all the needed metrcis, another job uploads the generated file on Lecko servers to be loaded in the Analytics server.
Learn more about how eXo Engagement Analytics by Lecko add-on works in the section How does it work?.
Configuration
To customize eXo Engagement Analytics by Lecko add-on, you can configure it through exo.properties file.
The table below contains all the needed parameters to customize eXo Engagement Analytics add-on:
| Property | Description | Default value |
|---|---|---|
| exo.addons.lecko.job.start.expression | Defines the export start time. | 0 0 21 * * ? |
| exo.addons.lecko.job.stop.expression | Defines the export end time. | 0 0 6 * * ? |
| exo.addons.lecko.job.enabled | Allows to activate/deactivate the addon. When set to true it activates eXo Advanced Analytics add-on. | true |
| exo.addons.lecko.directory.out.name | Defines the destination folder of the analytics export. | ${java.io.tmpdir}/lecko |
| exo.addons.lecko.out.name | Defines the name of the file to be exported. | dump |
| exo.addons.lecko.SftpHost | Defines the destination FTP hostname. | |
| exo.addons.lecko.SftpUser | Defines the destination FTP username. | |
| exo.addons.lecko.SftpPassword | Defines the destination FTP password. | |
| exo.addons.lecko.SftPortNumber | Defines the destination FTP port. | |
| exo.addons.lecko.SftpRemotePath | Defines the destination FTP path. | |
| exo.addons.leckoSftp.ProxyAddress | Defines the proxy hostname or IP. | |
| SftpProxyPort | Defines the proxy port. |