Installing the Android SDK

Standard Integration¶

To integrate the Android Intelligence SDK into your application, you will need to pull the SDK artifacts from our Github Maven repository. This is a public repository, however currently Github credentials are still required to be provided.

// App level Build.Gradle Configuration

repositories {
    maven {
        name = "ws1-intelligencesdk-sdk-android"
        url = "https://maven.pkg.github.com/euc-releases/ws1-intelligencesdk-sdk-android/"
        // Here you will enter your Github Credentials
        credentials {
            username = "${GITHUB_USERNAME}"
            password = "$GITHUB_PERSONAL_ACCESS_TOKEN"
        }
    }
    mavenCentral()
    google()
}

android {
   packagingOptions {
        pickFirst '**/libc++_shared.so'
        pickFirst '**/libcrypto.1.0.2.so'
        pickFirst '**/libssl.1.0.2.so'
    }
}

def ws1IntelSdkVersion = "24.3.1"

dependencies {
    // Declare a dependency on the Intelligence SDK
    implementation "com.vmware.ws1:ws1intelligencesdk:$ws1IntelSdkVersion"
}

SDK Integration through Local Repository¶

The IntelligenceSDK and it’s dependencies will now be hosted in a Maven folder structure found in the Release section of our public Github Page: https://github.com/euc-releases/ws1-intelligencesdk-sdk-android

After downloading and unzipping the following repository folder, you can now reference and pull the IntelligenceSDK using the following structure:

   // App level Build.Gradle Configuration (Groovy)

   repositories {
       maven {
           url uri("/PATH/TO/FOLDER/ws1-intelligence-sdk-repository")
       }
       mavenCentral()
       google()
   }

   android {
      packagingOptions {
           pickFirst '**/libc++_shared.so'
           pickFirst '**/libcrypto.1.0.2.so'
           pickFirst '**/libssl.1.0.2.so'
       }
   }

   def ws1IntelSdkVersion = "24.6.1"

   dependencies {
       // Declare a dependency on the Intelligence SDK
       implementation "com.vmware.ws1:ws1intelligencesdk:$ws1IntelSdkVersion"
   }

Integration Alongside Workspace ONE SDK¶

When integrating the Intelligence SDK alongside the Workspace ONE SDK, we must make sure to exclude some commonly packaged dependencies in order for seemly compilation

// App level Build.Gradle Configuration

repositories {
    maven {
        name = "ws1-intelligencesdk-sdk-android"
        url = "https://maven.pkg.github.com/euc-releases/ws1-intelligencesdk-sdk-android/"
        // Here you will enter your Github Credentials
        credentials {
            username = "${GITHUB_USERNAME}"
            password = "$GITHUB_PERSONAL_ACCESS_TOKEN"
        }
    }
    maven { url 'https://vmwaresaas.jfrog.io/artifactory/Workspace-ONE-Android-SDK/' }
    mavenCentral()
    google()
}

android {
   packagingOptions {
        pickFirst '**/libc++_shared.so'
        pickFirst '**/libcrypto.1.0.2.so'
        pickFirst '**/libssl.1.0.2.so'
    }
}

def ws1IntelSdkVersion = "24.3.1"
def ws1SdkVersion = "24.01"

dependencies {
    // Declare a dependency on the Intelligence SDK
    implementation "com.vmware.ws1:ws1intelligencesdk:$ws1IntelSdkVersion"
    // WS1 Dependency
    implementation("com.airwatch.android:AWFramework:$ws1SdkVersion"){
        // Need following excludes as they are duplicated in Workspace ONE SDK
        exclude group: 'com.airwatch.android', module: 'awApteligentBridge'
        exclude group: 'com.crittercism'
        exclude group: 'org.jetbrains.kotlinx', module: 'kotlinx-serialization-runtime'
    }
}

Permissions Required¶

Add the following permissions to your app’s AndroidManifest.xml file.

• INTERNET

Required. Used to report data to Workspace ONE Intelligence. - ACCESS_NETWORK_STATE

Optional. Allows providing network connectivity information such as carrier and network type.

For more information on these permissions, refer to the Android Manifest documentation.

Permissions Needed for IntelligenceSDK Features¶

The IntelligenceSDK currently utilizes the following Android Permissions:

• ACCESS_FINE_LOCATION
• ACCESS_NETWORK_STATE
• ACCESS_WIFI_STATE
• BLUETOOTH
• BLUETOOTH_CONNECT
• CHANGE_NETWORK_STATE
• INTERNET
• READ_EXTERNAL_STORAGE
• READ_PHONE_STATE
• USE_BIOMETRIC
• WRITE_EXTERNAL_STORAGE

For more information on Android Permissions, please refer to the following Google Documentation.

Initializing Workspace ONE Intelligence SDK¶

The following initialization instructions are the same for both the standard (sdkonly) SDK and the NDK-enabled SDK.

Obtain your app ID from Workspace ONE Intelligence console.

1. To initialize Workspace ONE Intelligence SDK add the following code at the beginning of the onCreate() of your main Activity:

Crittercism.initialize(getApplicationContext(), "CRITTERCISM_APP_ID");

Or initialize Workspace ONE Intelligence SDK with a CrittercismConfig argument

CrittercismConfig config = new CrittercismConfig();
config.setAllowsCellularAccess(false);
Crittercism.initialize(context, "CRITTERCISM_APP_ID", config);

1. You may need to add the following import, if Android Studio has not automatically added it already:

import com.crittercism.app.Crittercism;

Your Android app is now integrated with Workspace ONE Intelligence and you can go ahead and build it. Additional features require adding more code to your project.

Configuring Proguard Symbolication¶

Symbolication is the process of translating stack traces into a human-readable form by mapping hexadecimal addresses to function names using symbol file(s). Workspace ONE Intelligence automatically symbolicates crashes once you have uploaded your app’s symbol file(s).

For Android applications, developers have the option to obfuscate their function names using the ProGuard tool in order to reduce app size and to prevent others from reverse engineering the app source. In order to replace the obfuscated name with a human-readable name, developers use a Proguard mapping file.

Setting Up ProGuard¶

1. Add the following lines to your project’s proguard.cfg file:

-dontwarn com.crittercism.**
-keep public class com.crittercism.**
-keepclassmembers public class com.crittercism.**
{
    *;
}

1. To get line number information, make sure that you keep the file names and line numbers in your ProGuard .cfg settings file.

-keepattributes SourceFile, LineNumberTable

This information will be visible in all stacktraces, however - even those that are not symbolicated.

To have your crashes automatically deobfuscated and grouped, you must upload a mapping.txt file on to the Settings tab of your App.

Each mapping.txt file you upload is associated with a version of your app. We deobfuscated crashes for only one version with each mapping.txt file.

At this point, you have enabled Workspace ONE Intelligence SDK to receive Application Performance Information from your application