Remote Command: Usabilla

1. In your Xcode project, select File > Add Packages… > Add Package Dependency.
2. Enter the repository URL: https://github.com/tealium/tealium-ios-usabilla-remote-command.
3. Configure the version rules. Typically, Up to next major is recommended. If the current TealiumUsabilla version does not appear in the list, then reset your Swift package cache.
4. Select the TealiumUsabilla module to install, and select the app target you want the module to be installed in.

If your project has more than one app target and needs TealiumUsabilla module in more app targets, you have to manually add them in the Frameworks, Libraries, and Embedded Content section.

To install TealiumUsabilla in additional app targets:

1. Select your Xcode project in the Project Navigator.
2. In your Xcode project, select the app target under the TARGETS section.
3. Navigate to General > Frameworks, Libraries & Embedded Content and select the TealiumUsabilla module to add it to your app target.

To add additional modules from the Tealium Swift library, follow the Swift Package Manager instructions.

1. Remove tealium-swift and pod "Usabilla" if they already exist your Podfile. The dependency for tealium-swift is already included in the TealiumUsabilla framework.

2. Add the following dependency to your Podfile:

   pod "TealiumUsabilla"
   

   The TealiumUsabilla pod includes the following TealiumSwift dependencies:

   'tealium-swift/Core'
   'tealium-swift/TealiumDelegate'
   'tealium-swift/TealiumRemoteCommands'
   'tealium-swift/TealiumTagManagement'
   

3. Import the modules TealiumSwift and TealiumUsabilla in your TealiumHelper file, and any other files that access the Tealium class or the Usabilla remote command.

1. Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumUsabilla framework.

2. Remove the following line if it exists in your Cartfile:

   github "usabilla/usabilla-u4a-ios-swift-sdk"
   

3. Add the following dependency to your Cartfile:

   github "tealium/tealium-ios-usabilla-remote-command"
   

Tealium for Swift SDK (version 1.6.5+) requires the TealiumDelegate module to be included with your installation.

1. Install Tealium for Android (Kotlin) or Tealium for Android (Java) and add the Tealium Maven URL to your project’s top-level build.gradle file, if you haven’t done so already.

   allprojects {
     repositories {
       mavenCentral()
       maven {
         url "https://maven.tealiumiq.com/android/releases/"
       }
     }
   }
   

2. Import the Tealium-Usabilla remote commands by adding the following dependency in your app project’s build.gradle file:

   dependencies {
         implementation 'com.tealium.remotecommands:usabilla:1.0.0'
   }
   

The manual installation for Usabilla remote commands requires the Tealium for Swift library to be installed. To install the Usabilla remote commands for your iOS project:

1. Install the Usabilla SDK, if you haven’t already done so.

2. Clone the Tealium iOS Usabilla remote command repo and drag the files within the Sources folder into your project.

3. Set the remoteAPIEnabled configuration flag to true.

The manual installation for Usabilla remote commands requires Tealium for Android (Kotlin) or Tealium for Android (Java) to be installed.

To install the Branch remote commands for your Android project:

1. Add flatDir to your project root build.gradle file:

   allprojects {
         repositories {
           mavenCentral()
           flatDir {
               dirs 'libs'
           }
         }
   }
   

2. Add tealium-usabilla.aar to <PROJECT_ROOT>/<MODULE>/libs.

3. Add the Tealium library dependency to your build.gradle file:

   dependencies {
         implementation(name:'tealium-usabilla', ext:'aar')
   }
   

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s iOS (Swift) library:

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE")
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // Required to use Remote Commands

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }

    // Webview Tag
    let usabilla = UsabillaRemoteCommand() 

    // Local JSON
    //let usabilla = UsabillaRemoteCommand(type: .local(file: "usabilla"))

    // Remote JSON
    //let usabilla = UsabillaRemoteCommand(type: .remote(url: "https://some.domain.com/usabilla.json"))
    remoteCommands.add(usabilla)
}

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s Android (Kotlin) library:

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands, Dispatchers.TagManagement));
val usabilla = UsabillaRemoteCommand(TEALIUM_MAIN, config);

var tealium = Tealium.create(TEALIUM_MAIN, config) {

    // Webview Tag
    remoteCommands?.add(usabilla);

    // Local JSON
    //remoteCommands?.add(usabilla, filename = "usabilla.json");

    // Remote JSON
    //remoteCommands?.add(usabilla, remoteUrl = "https://some.domain.com/usabilla.json");
}

Additional (optional) initialization parameters are available for the Usabilla SDK:

• usabillaHttpClient = null
  Overrides the HttpClient object, which gives the possibility to inject a custom client to handle all the connections performed by the SDK. Learn more about the custom HTTP client.
• usabillaReadyCallback = null
  Overrides the UsabillaReadyCallback object, which is a callback used to communicate when the initialization process ends.
• autoFragmentManager = false
  Disables passive feedback (enabled by default). Passive feedback requires Android’s FragmentManager to be kept up-to-date and monitored using android.app.Application.ActivityLifecycleCallbacks.
• autoFeedbackHandler = false
  Disables handling of event tracking for passive and campaign feedback forms as well as auto-removing forms that have been submitted or dismissed (enabled by default). Two android.content.BroadcastReceivers are registered to listen for Usabilla events that handle both passive and campaign feedback form closures.

The following example shows usage of the optional parameters:

val usabilla = UsabillaRemoteCommand(TEALIUM_MAIN, config,
        usabillaHttpClient = null,
        usabillaReadyCallback = null,
        autoFragmentManager = false,
        autoFeedbackHandler = false);

The JSON Remote Command file feature for Android is only available in the Kotlin SDK. Initialize the Remote Command tag for Tealium’s Android (Java) library:

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);

RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config);
teal.addRemoteCommand(usabilla);

Additional (optional) initialization parameters are available for the Usabilla SDK:

• usabillaHttpClient = null
  Overrides the HttpClient object, which gives the possibility to inject a custom client to handle all the connections performed by the SDK. Learn more about the custom HTTP client.
• usabillaReadyCallback = null
  Overrides the UsabillaReadyCallback object, which is a callback used to communicate when the initialization process ends.
• autoFragmentManager = false
  Disables passive feedback (enabled by default). Passive feedback requires Android’s FragmentManager to be kept up-to-date and monitored using android.app.Application.ActivityLifecycleCallbacks.
• autoFeedbackHandler = false
  Disables handling of event tracking for passive and campaign feedback forms as well as auto-removing forms that have been submitted or dismissed (enabled by default). Two android.content.BroadcastReceivers are registered to listen for Usabilla events that handle both passive and campaign feedback form closures.

The following example shows usage of the optional parameters:

RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config,
        usabillaHttpClient = null,
        usabillaReadyCallback = null,
        autoFragmentManager = false,
        autoFeedbackHandler = false);