Usage of CIB modules on Android Technical Guide (EN)

3. SDK

3.2. Integration

General
Setting the licence
Check the license

General

The CIB modules are delivered for Android as AAR. The AAR can be integrated into an existing Android application as follows. Android Studio is used as development environment.

The sample integration ("showcase") included in the delivery can also be used as a template for the integration.

  1. In Android Studio, choose „File“ „New“ „Module“.
  2. Select „Import .JAR/.AAR Package“ and click „Next“.
  3. Select the path to the AAR with the CIB modules and click "Finish
  4. Afterwards, click on „Sync Project with Gradle Files“ in the toolbar.


Setting the licence

The license consists of your customer name (“Company”) and a key (“Key”). These must be set as strings via a resource file in your existing project, such as a “strings.xml”. To do this, add the following lines to an existing “strings.xml”.

<item name="cibPdfToolboxLicenseCompany" format="string" type="string" 
translatable="false">REQUEST FROM CIB SUPPORT</item>
<item name="cibPdfToolboxLicenseKey" format="string" type="string" 
translatable="false">REQUEST FROM CIB SUPPORT</item>
<item name="cibOcrLicenseCompany" format="string" type="string" 
translatable="false">REQUEST FROM CIB SUPPORT</item>
<item name="cibOcrLicenseKey" format="string" type="string" 
translatable="false">REQUEST FROM CIB SUPPORT</item>    

Set the separately handed out license key pairs as values. The values must be set exactly as you received them from us.


Check the license

Note:
A license can include or exclude certain functions. To be sure whether there is a license problem, the trace file must be checked. Proceed as follow.

  1. Make sure that the property "TraceFilename" is set with a valid file path when you call the respective CIB module.
  2. Start your Job.
  3. After the job is finished, open the file path specified under "TraceFilename" on the device. This is where the trace of the job is located.
  4. Open the trace file. If the license is valid, it should contain the following line, among others:

LICENSE: Valid license.

If this is not the case, check your license. If the problem persists, please contact the CIB Support.