Skip to main content

Installation

SmartCapture Face is distributed via a private maven repository. In order to use this module you will first need to obtain a set of AWS credentials from your GBG technical account manager.

Adding the Repository​

Within your project's settings.gradle, under dependencyResolutionManagement -> repositories you should add the following maven repository:

maven {
    url "s3://maven-mobile-repo/releases"
    credentials(AwsCredentials) {
        accessKey awsAccessKey
        secretKey awsSecretKey
    }
}

Note: While you can hardcode the access and secret keys here, the best practice is to keep these keys in a gradle properties file that is part of a gitignore or in a global gradle properties file that is not part of any repository. See GRADLE_USER_HOME here for more info.

Adding the Module​

Within your app or library's build.gradle, under dependencies add the following:

implementation 'com.gbgplc.idscan:commons:X.Y.Z'
implementation 'com.gbgplc.idscan:facecamera:X.Y.Z'

Where X.Y.Z corresponds to the version of the SDK you are installing.

Updating​

To update the install, all you need to do is change the version number to the version number you wish to use.

Note: There may be breaking changes or feature updates, you should still review the migration details and the integration details for the version you are updating to and may need to make code changes. This section simply talks about how to update the installed version.

Troubleshooting​

The above is all that is needed to install the SDK in most cases. The following discusses some less likely situations:

Transitive Dependencies​

By default all dependencies are transitive, which is to say, they will include all of their sub-dependencies automatically. If you have disabled transitive dependencies, you will need to manually add all of the sub-dependencies with their correct versions. To determine the correct versions of sub-dependencies for a given SDK version you will need to use AWS CLI or any visual AWS access tool to download the .pom file for the module and add all the dependencies from it by hand.

After an update you will need to re-review and update all dependencies.

GBG will not offer support for issues that arise from using an incorrect sub-dependency version and we recommend keeping transitive dependencies set to true.

Manual Install​

GBG will not offer support for manual install. Distribution via maven is a long standing industry standard and we have not found any benefit to supporting manual install.