Chapter 2. Configuration file
This configuration file for the Android SDK library is placed into the asset folder of an Android application. It is named TLFConfigurableItems.properties, which is a Java properties file.
Log level settings
The log level settings configure base logging settings.
Table 9. Log level settings
Item ID
LoggingLevel
Description
The current logging level, applies only when log level is not indicated in log statement. 0 has the highest priority.
Values
Integer, 0-5
DisplayLogging
LogViewLayout
OnScreenTransition
To disable logging, start Tealeaf.Disable().
See Chapter 5, “Reference,” on page 105.
When set to true, debug log statements are displayed in LogCat. Filter for the
UICAndroid tag.
When set to true, UICAndroid logs the screen layout. When set to False, the screen layout is not logged.
Boolean
Boolean
Kill switch settings
These settings control the kill switch and whether to use a white list of phone whose events can be captured.
Table 10. Kill switch settings
Item ID
KillSwitchEnabled
Description
If true, the framework checks the kill switch target page before starting. You must specify the following properties.
Values
true
/false
KillSwitchUrl
KillSwitchMaxNumberOfTries
KillSwitchTimeInterval
If KillSwitchEnabled=false, the framework always starts.
Defines the URL to check for the kill switch. The framework requires a successful response to initialize when KillSwitchEnabled is set to true .
URL
The number of times the framework checks for the kill switch URL before giving up. This value should be set to at least 1.
Integer
The time to wait before rechecking the kill switch URL if it is not responding
Seconds
© Copyright IBM Corp. 1999, 2015
95
Table 10. Kill switch settings (continued)
Item ID
UseWhiteList
Description
If true and KillSwitchEnabled, the framework requires a phone id to assign before calling Enable to check the white list of phone ids.
Values
true /false
WhiteListParam
If false and KillSwitchEnabled, the framework defaults to use random sampling.
Parameter that is used to send the white list ID corresponding to the phone ID.
Current white list server uses id
Local cache file settings
You use these settings to configure use of the device's local cache.
Table 11. Local cache file settings
Item ID
HasToPersistLocalCache
CachingLevel
CachedFileMaxBytesSize
Description
If true, data is stored in local storage on the device, instead of in memory.
The following settings must also be configured.
The current caching level. Applies only when HasToPersistLocalCache is true.
0 has the highest priority.
Maximum number of bytes to be stored on device.
Values
true
/false
Integer, 0-5
Bytes
Post settings
These settings control the logging level, URL, volume, and frequency of posts to the target page.
Table 12. Post settings
Item ID
PostMessageUrl
Description
The URL for posting data to your server.
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 Chapter 1, “Tealeaf installation and implementation in an
Android application,” on page 1.
PostMessageLevelWiFi The logging level of events to be sent to the server over Wi-Fi when network performance is good. 0 has the highest priority.
PostMessageLevelCellular The logging level of events to be sent to the server over the cellular (3G) network.
0 has the highest priority.
Values
URL
0 -5
0 -5
96
IBM Tealeaf Android SDK: IBM Tealeaf Android SDK Guide
Table 12. Post settings (continued)
Item ID
MaxStringsLength
ManualPostEnabled
Description
Maximum string length to be sent to target page per value in log statements.
Prevents long strings from taking up storage and bandwidth.
Note:
This value must be set to at least 1.
If true, the framework sends data to the server only when your application calls requestManualServerPost .
Values
Integer true /false
DoPostOnIntervals
If set to false, you must configure the following settings.
Note:
You cannot enable this setting and
DoPostOnIntervals together.
If true, the framework sends data to the server at regular time intervals that are specified by PostMessageTimeIntervals when the application is in the foreground.
This value must be set to true if
ManualPostEnabled=false
.
Note:
You cannot enable this setting and
ManualPostEnabled together.
PostMessageTimeIntervals How often the framework sends data to the server when DoPostOnIntervals is set to true.
Note:
This value must be set to be greater than PostMessageTimeout plus
PostMessageDelayTimeToSendData
.
PostMessageTimeout The timeout for the framework's posts to the server. While the framework does not receive a server response within this timeframe, the framework keeps trying to send data.
true /false
Seconds
Seconds
Masking settings
These settings control privacy masking.
Table 13. Masking settings
Item ID
HasMasking
MaskIdList
HasCustomMask
SensitiveSmallCaseAlphabet
SensitiveCapitalCaseAlphabet
SensitiveSymbol
Description
It can be true or false to mask values of controls. If
HasMasking=true
, then complete next value.
Comma delimited ids or regular expressions to find ids.
It can be true or false to use next values below if true.
Character to be used by small case letter.
Character to be used by capital case letter.
Character to be used by symbol.
Values
Boolean
String
Boolean
String
String
String
Chapter 2. Configuration file
97
Table 13. Masking settings (continued)
Item ID
SensitiveNumber
Description
Character to be used by number.
Values
String
Filter message type setting
This setting controls the message types that are sent back to the server.
Table 14. Filter message type setting
Item ID
FilterMessageTypes
Description
If set to TRUE, only the MessageTypes included in the comma-separated list are sent back to the server. If set to
FALSE , all message types are sent back to the server.
Values
TRUE
/ FALSE
Cookie settings
These settings control cookies.
Table 15. Cookie settings
Item ID
CookieSecure
CookieExpiresFormat
Description
If set to TRUE, a secure parameter is added to the cookie. This can only be used in https post urls.
This setting is used to indicate the cookie expiration format.
Values
TRUE / FALSE
Valid date formats:
ASCTIME , RFC1036, or RFC1123
Session timeout setting
This setting controls session timeouts.
Table 16. Session timeout setting
Item ID
SessionTimeout
Description
When SessionTimeout is set, the expiration of cookie is the current time plus the session timeout value.
Values
Minutes
Screen shot settings
These settings control screen shots.
Note:
You can store screen shots in memory instead of in local memory on the device. To enable screen shots to save in memory, you must set
HasToPersistLocalCache to false in the local cache file settings.
Table 17. Screenshot settings
Item ID
ScreenshotFormat
Description
The format of the screen shot.
Values
PNG / JPG
98
IBM Tealeaf Android SDK: IBM Tealeaf Android SDK Guide
Table 17. Screenshot settings (continued)
Item ID
PercentOfScreenshotsSize
PercentToCompressImage
Description
The percentage of screen capture's original pixel dimensions at which posted screen captures are submitted, 1-100.
Percentage to compress image. This setting can only be used for JPG images. PNG images ignore this setting and default to 100.
Values
Integer 1-100
Integer 1-100
Internal settings: do not change
Do not change these settings unless directed to do so by IBM Tealeaf.
Table 18. Internal settings: do not change
Item ID
PostMessageSocketTimeout
CompressPostMessage
BufferLimit
BufferPercent
TimeIntervalBetweenSnapshots
Description Values
The socket timeout for the framework's posts to the server. While the framework does not receive a server response within this timeframe, the framework keeps trying to send data.
Seconds true / false When set to true, HTTP POSTs submitted from the framework are compressed in compress format.
Note:
To extract the compressed
POSTs, some additional server-side configuration can be required. See
Chapter 1, “Tealeaf installation and implementation in an Android application,” on page 1.
The number of messages to store in memory to be sent to server.
Percentage to remove from BufferLimit before it gets saved to cache if enabled.
The time interval for taking snapshots of environmental data
Integer
Percentage
Seconds
Chapter 2. Configuration file
99
100
IBM Tealeaf Android SDK: IBM Tealeaf Android SDK Guide
