Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Purpose

GreenID Mobile applications can now be tested using a mobile emulator, instead of a physical mobile device. The emulator-enabled SDKs are not fully functional inside an emulator, but they can display the initial pages and they do an error handoff to the client application when the document capture process would normally begin. The words "Simulator detected" will appear in the error description.

This alternative set of emulator SDK libraries allows developers to write the necessary integration code and run and test their applications by whatever means they choose initially. When they are ready to test the application with actual devices, they simply replace the emulator version of the SDK libraries with the fully functional ones.

Integration steps

  1. Backup existing libraries in the project
    • Copy the existing 'catfishairdocscansdk', 'catfishairselfiesdk' and 'ifacerec-VIX-Linux-x.x.x.yyy' libraries in your project to safe location.
    • Remove the three dependencies above from your project libs folder and you should have the following libraries of GreenID left

      Image Added

  2. Acquire new emulator-enabled libraries
    • As of May 2018, the emulator-enabled libraries are distributed alongside the normal greenID SDK files.

      Image Added

  3. Import new mock libraries
    • Open your project in Android Studio.
    • Copy the aar files labelled mock_ to your app's /libs folder.

      Image Added

    • Comment out the following line in the dependencies in the projects ‘build.gradle’ file:
      implementation(name: 'catfishairdocscansdk', ext: 'aar')
      implementation(name: 'catfishairselfiesdk', ext: 'aar')
      implementation(name: 'ifacerec-VIX-Linux-6.4.0.538', ext: 'aar')

      Image Added

    • Add the following lines to the dependencies section of your project's ‘build.gradle’ file:
      implementation(name: 'mock_catfishair_libraries-1.0(2)-release', ext: 'aar')
      implementation(name: 'mock_imagus_libraries-1.0(2)-release', ext: 'aar')

      Image Added
    • Run Gradle sync to ensure all dependencies are included correctly and resolved.

      Image Added

  4. Test new mock libraries
    • Create a new Virtual Device in Android studio by clicking on the following icon:

      Image Added

    • This will bring up a new screen as follows:

      Image Added

    • Click on the create virtual device button and select your device specific options.

      Image Added

    • Select the hardware requirements of your application. Device type etc.

      Image Added

    • Select your supported operating system. If it is your first time creating a virtual device, it might take a few minutes to download the Android operating system image. This happens only once though.

      Image Added

      Image Added

    • Startup your new emulator by clicking the play symbol

      Image Added
    • Click run on the application quick run and select the Android emulator as your target device.

      Image Added

Sample Code example

The greenID Sample Code example project found at http://greenidmobile.vixverify.com/ has been configured to allow both emmulator and physical device libraries to co-exist in the same project.

Inspect the project's "build.gradle" file for information on how to do this.

The project allows for two build variants, one for emulator, and one for physical devices.