Skip to content

Installation

How to install Document Reader SDK.

Overview

graph LR
  A(Document Reader SDK) --> B(API);
  A --> C(Core);
  B --> D(Common);
  A -.- E[(Database)];

Document Reader SDK consists of two frameworks: API and Core.

API framework provides the external interface for controlling the process and getting the result. It depens on the Common framework that is an interface for working with the camera and other modules that are used in other Regula SDKs.

Core framework provides the recognition functionality where all the processing happens. This is the internal framework, it is used by the API framework only and is not accessible for developers. However, it should be referenced in the project.

Database contains the documents' data. It's mandatory to have it if you use the Core type that supports document type recognition.

Requirements

Installation

Gradle

URL

Add the following lines to the settings.gradle file:

settings.gradle
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        jcenter()
        maven {
            url "https://maven.regulaforensics.com/RegulaDocumentReader"
        }
    }
}

Dependencies

1. Add the API and Core libraries as dependencies and make sure transitive is set to true for API. To always use the latest release, simply add the following lines of code to the build.gradle file of your project:

build.gradle
1
2
3
4
implementation 'com.regula.documentreader.core:fullrfid:+@aar'
implementation ('com.regula.documentreader:api:+@aar'){
    transitive = true
}

Alternatively, you can pin to a specific version (e.g. 1.0.0):

build.gradle
1
2
3
4
implementation 'com.regula.documentreader.core:fullrfid:1.0.0@aar'
implementation ('com.regula.documentreader:api:1.0.0@aar'){
    transitive = true
}

2. Sync the project.

Manual Integration

1. Go to our Maven repository.

2. Download the latest Document Reader API version.

3. Find the .pom file there, open it, and check the version of the Common API.

4. Download that Common API version.

5. Download one of the Document Reader Core libraries depending on the functionality that you need and the license capabilities.

6. Copy the downloaded files to the libs folder located at the root directory of your project. If there is no such a folder, create it.

7. Add the libs directory to the settings.gradle:

settings.gradle
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        jcenter()
        flatDir {
            dirs 'libs'
        }
    }
}

8. Add the downloaded files to the app level build.gradle file of your project, for example:

build.gradle
1
2
3
4
5
dependencies {
    implementation(name:'api-6.4.7224', ext:'aar')
    implementation(name:'api-6.4.1048', ext:'aar')
    implementation(name:'fullrfid-6.4.7188', ext:'aar')
}

9. Sync the project.

Next Steps