Event Tracking Guide

1 Event types
2 Enable event tracking

Event types

You have the possibility to track various events which occur during the usage of Gini Capture SDK. Event types are partitioned into different domains according to the screens that they appear at. Each domain has a number of event types. Some events might supply additional data in a dictionary.

Domain	Event type	Additional info keys	Comment

Domain	Event type	Additional info keys	Comment
Onboarding	`start`		Onboarding started
Onboarding	`finish`		User completed onboarding
Camera Screen	`exit`		User closed the camera screen
Camera Screen	`help`		User tapped “Help” on the camera screen
Camera Screen	`takePicture`		User took a picture
Review Screen	`back`		User went back from the review screen
Review Screen	`next`		User advanced from the review screen
Analysis Screen	`cancel`		User canceled the process during analysis
Analysis Screen	`error`	`"message"`	The analysis ended with an error. The error message is supplied under the “message” key.
Analysis Screen	`retry`		The user decided to retry after an analysis error.
Analysis Screen	`noResults`		The analysis ended with empty results.

Enable event tracking

In order to receive the events, implement the GiniCaptureTrackingDelegate protocol and supply the delegate when initializing Gini Capture SDK, for example:

let viewController = GiniCapture.viewController(withClient: client,
                                               importedDocuments: visionDocuments,
                                               configuration: captureConfiguration,
                                               resultsDelegate: self,
                                               documentMetadata: documentMetadata,
                                               trackingDelegate: trackingDelegate)

// Or when not using the default network implementation pod GiniCapture/Networking:
let viewController = GiniCapture.viewController(withDelegate: self,
                                               withConfiguration: captureConfiguration,
                                               importedDocument: nil,
                                               trackingDelegate: trackingDelegate)