Skip to main content
Version: 2.0.X

Tracking Component

0. SDK Mobile baseline requirements​

SDK Mobile is a set of libraries (Components) that offer a series of functionalities and services, allowing their integration into a Mobile application in a simple and fully scalable way. Certain components must be installed depending on the use case required. Its high level of modularity allows other new components to be added in the future without affecting those already integrated into the project.

For more information on the base configuration, go to the Getting Started section.

1. Introduction​

The component dealt with in the current document is called Tracking Component. It tracks and monitors the information obtained while executing the rest of the SDKMobile components, sending it to the Platform services. This data can be tracked in real-time on the Platform, while the process is running on the client's device.

Unlike the rest, this component does not work individually, it works transversally with the rest of the components installed in the SDKMobile. To track the information, it is kept in the background while the SDKMobile process is running.

2. Integration of the component​

Before integrating this component, it is recommended to read the documentation related to

Getting Started and follow the instructions in that document.

This section will explain step by step how to integrate the current component into an existing project.

2.1. Dependencies required for integration​

To avoid conflicts and compatibility problems, if you want to install the component in a project containing an old Facephi libraries (Widgets) version, these must be removed entirely before installing the SDKMobile components.

  • Currently, FacePhi libraries are distributed remotely through different dependency managers. Mandatory dependencies that must be installed beforehand:

    implementation "com.facephi.androidsdk:tracking_component:$sdk_tracking_component_version"

3. Start a new operation​

When you want to perform a specific operation to generate the associated information correctly in the platform, the newOperation command must first be executed.

This command must have been executed before launch.

To learn more about how to start a new operation, it is recommended to consult the Getting Started documentation, which details and explains what this process consists of.

4. Available controllers​

ControllerDescription
TrackingControllerTracking the main controller
TrackingErrorControllerController to handle any errors that occur
ExtraDataControllerDriver to get the ExtraData that allows communication from client to server with SelphIDSdk installed.

5. Component configuration​

To configure the current component, see the initialisation section in Getting Started.

5.1. TrackingController configuration​

This parameter must be included

SDKController.initSdk(
    ...
    trackingController = TrackingController(),
)

5.2. Error control settings​

The callback can be configured to control tracking errors:

SDKController.launch(
     TrackingErrorController {
        Napier.d("Tracking Error: ${it.name}")
     }
)

Section 7 shows the possible error values that exist.

5.3. Obtaining the ExtraData for communication with the Platform​

The call to get the extraData needs information on the current operation, forcing it to have previously performed a newOperation.

val result = SDKController.launch(
    ExtraDataController()
)
when (result) {
    is SdkResult.Success -> logs.add("ExtraData: OK")
    is SdkResult.Error -> logs.add(
        "ExtraData: KO - ${result.error.name}"
    )
}

6. Use of the component​

As previously mentioned, once the tracking component has been initialised and configured, launching it will not be necessary, as it will keep running in the background while the rest of the components are running.

7. Receipt of the result​

7.1. Receipt of errors​

In the error part, we will have the TrackingError class.

INIT_IDS_ERROR,
LICENSE_ERROR,
APPLICATION_CONTEXT_ERROR,
OPERATION_RESULT,
OPERATION_ID,
SESSION_ID,
CUSTOMER_ID,
STEP_CHANGE,
ASSET_LINK,
ASSET_UPLOAD,
OCR_DATA,
INIT_OPERATION,
NO_OPERATION_CREATED_ERROR,
TOKEN_ERROR,
NETWORK_CONNECTION,
SEND_BYTEARRAY