Configuration file for the iOS SDK library

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

If set to no, you must configure the following settings.

Note: You cannot enable this setting and DoPostOnIntervals together. However, one of these options must be yes. By default, it is set to no to allow automatic posting.

Note: You cannot enable this setting and ManualPostEnabled together. However, one of these options must be yes.

To use the iOS SDK libraries:

• If DynamicConfigurationEnabled==yes, you need to call enableTealeafFramework.
• If you do not have the killswitch implemented, you need to have DynamicConfigurationEnabled==no for libraries to load.

Note: To extract the compressed POSTs, some additional server-side configuration can be required.

Valid values are 0 and higher. Default value is 5.

This setting is useful for Tealeaf only if HasToPersistLocalCache is set to YES in TLFResources.bundle > TealeafBasicConfig.plist. If HasToPersistLocalCache is set to NO, the value for MaxNumberOfFilesToCache is ignored.

If KillSwitchEnabled=no, the framework always starts.

If no and KillSwitchEnabled, the framework defaults to use random sampling.

Note: To enable secure transport between the logging framework and the target page, configure this URL to begin with https://. For more information about the target page, see Getting started with the Acoustic Tealeaf SDK for iOS using Swift and Getting started with the Acoustic Tealeaf SDK for iOS using Objective C.

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

Note: This value must be at least 1.

Valid values are 0 and higher. Default is 1.5.

If set true, disables auto-capture of UIAlertController and UIAlertView.

Note: Currently, the SDK captures custom alerts, even when this flag is set to true.

If set true, disables background capture of the alert when the background ViewController’s auto-capture is turned off.

If set false, all message types are sent back to the server.

If set to false, all message types are sent back to the server.

If RemoveIp is set to false and the device has an ipv6 address, the “ipv6” value in the json is set to the address (as a string). For example,

“ipv6”: “fe80::14a0:46b2:9ab1:2fa”

If RemoveIp is set to false and the device has an ip address, the “ip” value in the json is set to the address (as a string).
For example, “ip”: “209.268.86.31”

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

• 0 does not send log data.
• 1 has the highest priority (critical).
• 2 has a medium priority (important).
• 3 has the lowest priority (information).

This entry is replacing do in Tealeaf SDK 10.4.1 (and later).

• true (Capture Type 2s for this screen): Tracks the screen
• false (Don’t Capture Type 2s for this screen): Does not track the screen

Example: To enable tracking for the screen:

"ScreenChange": true

This entry is replacing screenViewName in Tealeaf SDK 10.4.1.

Provides the name of the screen to be shown during replay, instead of showing the view controller name or activity name. DisplayName is displayed during replay in the navigation list. If DisplayName is empty, view controller class name is used.

For example, the DisplayName for a payments page might be “Payment Screen”.

Example: To set the value of DisplayName to Payment Screen:

"DisplayName": "Payment Screen" 

This entry is replaying delay in Tealeaf SDK 10.4.1 (and later).

The delay in milliseconds before Tealeaf SDK takes a layout capture of a screen. Increasing the value of this setting increases the amount of time that must pass between when the layout is loaded and when the layout logging action occurs. The CaptureLayoutDelay value is used for ScreenChange and ScreenShot.

Example: To set the delay between layout load and layout logging to 500 milliseconds:

"CaptureLayoutDelay": 500

The delay in milliseconds to wait before capturing screenshot. Increasing the value of this setting increases the amount of time that must pass between when the screen is loaded and when screen logging occurs. The CaptureScreenshotDelay value is used for ScreenChange and ScreenShot.

Example: To set the delay between screen load and screen logging logging to 500 milliseconds:

"CaptureScreenshotDelay": 500

This entry is replaying takeScreenShot in Tealeaf SDK 10.4.1 (and later). Note that takeScreenShot applied only for type 2 load events but ScreenShot applies to type 2, 4, 10, 11.

Indicates whether or not to capture screenshots on the screen.

• true (Capture screenshots on type 2, 4, 10, 11): Takes a screen capture
• false (Don’t capture screenshots on this screen): Does not take a screen capture. If you do not want Tealeaf SDK to take any screenshots on a specific screen, set ScreenShot to false.

Example: To turn on screen capturing for the screen activity:

"ScreenShot": true

This entry is replaying CaptureScreenContents in Tealeaf SDK 10.4.1 (and later).

Indicates whether or not to track user events like types 4s or 11s.

• true (Capture type 4, 11): Tealeaf SDK resumes capturing user events (type 4, 11) on the specified screen.
• false (Don’t capture type 4, 11): Tealeaf SDK pauses, does not capture type 4, 11 events, and based on the value of CaptureScreenVisits, captures screen load/unload events.

Example: To turn on user event capturing for the screen activity:

"CaptureUserEvents": true

The event to capture layout on: Never, or on first user gesture, or on screen change.

• 2 (Capture Layout on screen change): Tealeaf SDK captures the layout as soon as the view controller is loaded.
• 1 (Capture Layout on first user gesture): Tealeaf SDK captures the layout after the end user makes a first gesture on a given view controller.
• 0 (Don’t Capture Layout):The layout is not captured.

Example: To capture layout on screen changes:

"CaptureLayoutOn": 2

The event to capture screenshots for view controller load events: Never, or on first user gesture, or on screen changes.

• 2 (Capture screen load screenshot on screen change): Captures screen load screenshot on screen changes. Tealeaf SDK captures the screenshot as soon as the view controller is loaded.
• 1 (Capture screen load screenshot on first user gesture): Tealeaf SDK captures the screenshot after the end user makes a first gesture on a specified view controller.
• 0 (Don’t capture screen load screenshot): Does not take a screen capture. Note that even if CaptureScreenshotOn is set to 0 and ScreenShot is true, the Tealeaf SDK continues to capture screenshots on other user events, such as type 4 and type 11. CaptureScreenshotOn applies only to screenshots on view controller load.

Example: To capture screen load screenshot on screen changes:

"CaptureScreenshotOn": 2

The event to capture the first screenshot on for a web view, if there is any.

• 2 (Capture webview screen load screenshot on screen change): Captures the webview screen load screenshot on screen changes.
• 1 (Capture webview screen load screenshot on first user gesture): Captures the webview screen load screenshot on the first user gesture.
• 0 (Don’t capture webview screen load screenshot): Does not capture the webview screen load screenshot.

Example: To capture webview screen load screenshot on screen changes:

"CaptureWebViewScreenshotOn": 2

This entry is replacing numberOfWebviews and isWebView in Tealeaf SDK 10.4.1 (and later). If you set isWebView = false in earlier releases, you can now set NumberOfWebViews = 0. Non-zero values for NumberOfWebViews indicate the number of web views on a view controller.

Indicates the amount of webviews on the page. Default value is 0.

Assigns an identifier to a target item. You can assign a readable identifier to the mid that maps to the target item. You can then configure events to fire when the identifier is encountered. You can use the same identifier for Android devices as well as iOS devices. When you assign the same identifier to your Android and iOS devices, you can create a single event in Event Manager that fires on the identifier. The event fires for both Android and iOS devices.

For example:

  "AppendMapIds": {
 "[PWDV,0][ABOL,0][FL,0][TH,0][LL,0][TW,0][LL,1][LL,0]": {
   "mid": "LoginButton"
   },
 "ibm.com.demoapp.main_activity_login:id\/send": {
   "mid": "LoginButton"
   }

Uses the mid setting to assign an identifier to two targets. The first target is for an iOS device and the second target is for an Android device. The target for both devices is identified as LoginButton. You can create a single event that fires when LoginButton is encountered in either application..