Mobile: How To Install and Update the Android WalkMe Mobile SDK Using Gradle

Last Updated September 28, 2023

Download as PDF

This article explains how to install and update the WalkMe Android SDK using Gradle Build Tool.

Steps For Installation and Updating

Install

1. Modify build.gradle

   • Ensure that jitpack is in under "allprojects" repositories:

     allprojects {
          repositories {
               maven { url 'https://jitpack.io' }
          }
     }

   • Add abbisdk to the dependencies section
   • You can find WalkMe's latest SDK version here

     implementation ('com.github.abbiio:androidsdk:SDK_VERSION_NUMBER')

   • Example: ('com.github.abbiio:androidsdk:2.12.4')
   • Proguard

     If your app is using Proguard, add the following to the configuration:-keep class abbi.io.** {*;}

1. Unit Tests

   • If you have difficulty running your unit test tasks, add the following code to your Gradle file:

     testOptions { unitTests.all { jvmArgs '-noverify' } }

2. Gradle Install

   • You may click on "Sync Now" in Android Studio, or open the Terminal pointing to your project root and run the following command: gradle install

3. Integrate Your App

   • In your First Activity import section, add: import abbi.io.abbisdk.ABBI;
     • IMPORTANT: in case you're intializing other 3rd party SDKs. Please make sure to initialize WalkMe SDK first.
     • Within the onCreate function, include the following:

       // Java:
       ABBI.start("<YOUR_APP_KEY>", "<YOUR_APP_SECRET>", getApplication());
       
       // Kotlin:
       ABBI.start("<YOUR_APP_KEY>", "<YOUR_APP_SECRET>", application);

4. Verify the Integration

   • Look for this line in your logs: ABBI SDK
   • There you should find the current version of the SDK and the app ID you are using.

You're done! The WalkMe Console should now identify the app and confirm the integration.

How To Update the SDK Using Gradle

You must re-build your project, after which Gradle will fetch the last SDK version from jitpack. Find the latest Android SDK version here.