SDKs
Help centerCommunityDevelopersAcademyStatus

Prepare the Connect library for production use on mobile devices

Suggest Edits

Have you tested the Connect SDK internally and are preparing to use it in production? Then it's time to take care of kill switch configuration and privacy protection.

Enabling privacy protection

Before releasing your app with the Connect SDK to production, you must take measures to secure your end users' personally identifiable information (PII). See instructions for your platform.

Updating the kill switch URL

A kill switch is a mechanism that lets you disable the Connect library remotely on end users' devices. Also, if you have set a custom data sampling rate when generating your app key, the kill switch feature will be randomly applied to user sessions to meet the required limit.

In your Android project, open /app/src/main/assets/TealeafBasicConfig.properties and find kill switch settings. Set KillSwitchEnabled to true and replace the default KillSwitchUrl value with the URL associated with your Connect subscription.

In your Xcode project, open a basic configuration file {app_name}/Pods/TealeafDebug/SDKs/iOS/Debug/TLFResources.bundle/TealeafBasicConfig.plist and replace the default KillSwitchUrl value with the URL associated with your Connect subscription.

#Kill switch settings
KillSwitchEnabled=false
#if KillSwitchEnabled=true, then fill the section of the settings below
KillSwitchUrl=https://lib-us-2.brilliantcollector.com/collector/switch/855e660c38824b4680602c6ac2a00zzz

Here is how to build your kill switch URL:

  1. Take your endpoint URL and replace collectorPost with switch.
  2. Append /{your_application_key} .

For example, your endpoint URL is https://lib-us-2.brilliantcollector.com/collector/collectorPost and your application key is 855e660c38824b4680602c6ac2a00zzz. In that case, the killswitch URL will be https://lib-us-2.brilliantcollector.com/collector/switch/855e660c38824b4680602c6ac2a00zzz.

📘

Note

Only after you enter a valid kill switch URL (or disable the feature if you do not need it), you can build and run your app integrated with the Connect SDK.

Uploading application images to Connect (optional)

When the Connect library captures a user session on a mobile device, it sends image files from your app to the Connect collector. These files are later used for session replay (Enhanced replay). The methodology is enabled out-of-the box and does not require any setup.

We offer an alternative methodology for native Android and iOS apps (Traditional replay or Non-enhanced replay). It creates an HTML representation of the mobile screen based on existing image assets. You may want to consider it in the following cases:

  • If your app restricts screen recording.
  • If it is necessary to reduce the amount of data transferred from end users' devices to Connect.

To start using the Traditional replay methodology for capturing user sessions, you will need to package all application images and upload them to Connect. For more information about this option, see the following article in our marketing guide: Copy native and hybrid application images to the replay server.

Updated 3 days ago