Optimize - Advanced Configuration Guide Document

Setting Configuration Settings

Setting and changing configuration settings can be done both manually and programmatically. See the Core SDK - Setting Configuration Values for more details.

Optimize Configuration Settings

The following settings are known to the Webtrends Optimize SDK. Changing the values associated with any of them will change the behavior of the SDK as explained under each setting’s “Description”.

Key Token - Required

Description: Your Optimize Key Token, assigned to your account by Webtrends. This setting is required when using the Optimize SDK.
String Literal: “wt_opt_key_token"
Constant Name: kWTConfigKeyToken
Default Value: none
Acceptable Values: string — Your Webtrends-assigned key token


Domain ID - Required

Description: Your Optimize Domain ID, sometimes referred to as an account number, assigned to your account by Webtrends. This setting is required when using the Optimize SDK.
String Literal: “wt_opt_domain_id"
Constant Name: kWTConfigDomainId
Default Value: none
Acceptable Values: string — Your Webtrends-assigned domain ID


Account GUID

Description: Your Webtrends account GUID. In order to send Optimize conversion events to our data collectors, you must set either this or the wt_dc_dcsid setting.
String Literal: “wt_opt_account_guid"
Constant Name: kWTConfigAccountGuid
Default Value: none
Acceptable Values: string — Your Webtrends-assigned Account GUID, a 10-character alphanumeric string


Optimize Server Polling Interval

Description: The length of time (in milliseconds) to wait between polling the Optimize server for new tests. Setting this too low can have a dramatic negative effect on battery and network performance.
String Literal: “wt_opt_poll_interval_millis"
Constant Name: kWTConfigOptimizePollIntervalMilliseconds
Default Value: 21600000 (every 6 hours)
Acceptable Values: integer as a string — (any valid positive integer value)


Optimize Server Base URL

Description: This is the base URL for querying the Webtrends Optimize server.
String Literal: “wt_opt_url_base"
Constant Name: kWTConfigOptimizeUrlBase
Default Value: "http://ots.optimize.webtrends.com/ots/api/rest-1.1/"
Acceptable Values: URL as a string — (http: or https:, must contain ”/ots/api/rest-“ and end in ”/“)


Optimize Staging Mode

Description: Sets the mode of the tests to staging (true) or non-staging (false). Staging mode is generally only used in development. Once your application is deployed, this should be set to false.
String Literal: “wt_opt_staging_mode"
Constant Name: kWTConfigOptimizeStagingMode
Default Value: "true"
Acceptable Values: boolean as a string — ("true” or “false”)


Project Locations

Description: A comma-separated list of project locations that will be applied to this application. The project locations are defined in the Optimize UI. String Literal: “wt_opt_project_locations"
Constant Name: kWTConfigOptimizeProjectLocations
Default Value: none
Acceptable Values: array as a string — (A string containing a comma-separated list of project locations)


Remote Resource Download Timeout

Description: How long (in milliseconds) the SDK will wait for in-the-moment (non-cached) tests to download resources. For example, if a test calls for an image to be downloaded, the SDK will report an error if this threshold is exceeded.
String Literal: “wt_opt_download_timeout_millis"
Constant Name: kWTConfigDownloadTimeoutMilliseconds
Default Value: none
Acceptable Values: integer as a string — (Any non-zero positive integer)


Optimize Server Request Timeout

Description: How long (in milliseconds) the SDK will wait for the Optimize server to respond to control requests.
String Literal: “wt_opt_request_timeout_millis"
Constant Name: kWTConfigRequestTimeoutMilliseconds
Default Value: none
Acceptable Values: integer as a string — (Any non-zero positive integer)


Optimize Server Test Load Timeout

Description: How long (in milliseconds) the SDK will wait for loading the tests from Optimize server. Note that while waiting for the tests to completely load a spinner will be shown. String Literal: “wt_opt_test_loading_timeout_millis"
Constant Name: kWTConfigTestLoadingTimeoutMilliseconds
Default Value: 4000 Acceptable Values: integer as a string — (Any non-zero positive integer)


Optimize Server Tests Update Timeout

Description: How long (in milliseconds) the SDK will wait before updating the tests from Optimize server on application launch or activation.
String Literal: “wt_opt_tests_update_timeout_millis"
Constant Name: kWTConfigTestUpdateTimeoutMilliseconds
Default Value: 21600000
Acceptable Values: integer as a string — (Any non-zero positive integer)