-
Notifications
You must be signed in to change notification settings - Fork 64
How to set up the Tracking System
ViSH has an integrated Tracking System (hereafter TR), which aims to facilitate developers the recording of users activity (in an anonymous way). This service can be used by the ViSH application or by external applications.
The service is disabled by default. You can enable it through the following options in the application_config.yml file. More info about this configuration file is available here.
| Key | Description |
|---|---|
| trackingSystemAPIKEY | To enable the TR on the ViSH application you should provide this key. While this key remains unspecified, the TR will remain disabled. If the value is provided, it will be the Key that external applications should provide to store records in the TR. |
| trackingSystemAPIURL | Its the URL where the TR will listen to the requests of the extenal applications. If should be a URL like this: http://#{ViSH domain}/tracking_system_entries. Its possible for a ViSH instance to store the activity of the users of other ViSH instance. This is specified through the {ViSH domain} value. |
For ViSH to store data on the TS is only neccesary to define the trackingSystemAPIKEY. In this case (for a ViSH application to store data in its own TR), the value of the key is not relevant.
For a external application to store data on the TS of a ViSH instance, both the trackingSystemAPIKEY and the trackingSystemAPIURL should be defined. The external application must send the trackingSystemAPIKEY in its requests to the TR service that will be listening on trackingSystemAPIURL.
- Currently (release 1.0), the following data is automatically recorded when the service is enabled:
- User activity in the interactive presentations (tracked and sent by the external application ViSH Editor).
- Data regarding the generation and acceptance of recommendations.
Developers are free to use the TS (using the REST API or directly from Ruby on Rails through the TrackingSystemEntry model) to track new data.
Currently, ViSH does not provide any analytics processor. The recorded data can be accessed directly from the database through the TrackingSystemEntry model.