Custom Monitoring API (Flash)
From Agnitio WIKI
Flash-based presentations created in the Agnitio Manager 4.x for use in the Agnitio Planner 4.x, will by default have a set of Monitoring-events automatically added, that will capture usage-data for the given presentation. To add additional monitoring events to the presentation, content-developers use the Custom Monitoring API provided below, allowing the freedom to track specialised complex data, such as graphs, questionnaires, drop-downs, tick-boxes, etc.
Contents |
What constitutes a Custom Event
The Agnitio Manager 4.x automatically creates monitoring events for the following categories, that are defined as "System Events":
- slideEnter
- slideExit
- documentOpen
- referenceOpen
- documentsOrderName
- documentsOrderEmail
- documentsOrderDocuments
- signatureCapture
Any other events that should be tracked, should leverage the functionality in the Custom Monitoring API.
In addition to the Monitoring-events, the Agnitio Planner 4.x will also capture an array of data regarding the Meeting in which the presentation is used. For details on Meeting Info and on the structure of System events, please refer to the Monitoring Model Article
Initiating the use of the Custom Monitoring API
To use the monitoring API, you have to declare monitoringManager public property on the root:
public function get monitoringManager() : Object {
return _monitoringManager;
}
public function set monitoringManager(monitoringManager : Object) : void {
_monitoringManager = monitoringManager;
}
private var _monitoringManager: Object;
The monitoringManager property is initialized as soon as the asset is loaded into the viewer.
MonitoringManager properties and methods
submitEvent(category : String, label : String, value : *, valueType : String = null, categotyId : String = null, labelId : String = null, valueId : String = null) : void
- Submits monitoring event.
- category - Category name.
- label - Property name.
- value - Property value.
- valueType [optional(default = null)] - Complex value type identifier. For example for {x : 1, y : 2} valueType could equal "point".
- categoryId [optional(default = null)] - Category id. For example, the same categoryId "personalInformation" could be used for values "Personal Information", "Персональная Информация", "Personlige oplysninger".
- labelId [optional(default = null)] - Label id. For example, the same labelId "name" could be used for labels "Name", "Имя" or "Navn".
- valueId [optional(default = null)] - Value id. For example, the same valueId "female" could be used for values "Female", "Женщина", "Kvinde".
