Additional Configuration Specification

Configuration settings are expressed as name-value pairs, separated with an equals sign. Multiple settings should be semi-colon delimited. Some settings are specific to one or more functions and/or product types (i.e. Excel add-in versus SQL Server). Please note: none of these apply to the Excel "Web" Add-in. All settings have a default value that's listed below.

Setting Name Overview / Possible Values / Default Value Applies To
Timeout

Maximum number of seconds to wait for data source to transmit its data

Numeric (0 = infinite wait)


Default: 90

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
Caching

If true, data from requests are kept in memory to satisfy potentially the same request if it occurs within a set timeframe, aiding performance at the cost of currency of data. By default 50 pages are kept for a maximum of 10 minutes (per page).

Values: True or False


Default: True

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
ErrorHandling

Controls the error handling behavior of the function call.

Exception - an exception / hard error is generated.

ReturnValue - error details are returned as a string

NoData - an error is treated as "no data"

ExceptionRelaxed - a hard error is generated except for what could be considered potentially transient problems


Default Excel: ReturnValue (WebGetDynamicTable), Exception (others)

Default SQL: ExceptionRelaxed (WebGetTable, WebGetTableMetadata), ReturnValue (others)

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
ConsiderFooters

When False, HTML table footers are ignored during parsing. Footers may not be compatible with a regular table structure, making False the default.

Values: True or False


Default: False

WebGetSingleFromTable (All)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
MaxRequestCount

A maximum request count that is enforced over a time range that's defined by the MaxRequestIntervalSizeSeconds setting. The default is 15,000 requests per hour (per site) after which the MaxRequestFailAction setting determines whether the next request will return an error or wait.

Numeric (0 = unlimited)


Default: 15000

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
MaxRequestIntervalSizeSeconds

Defines the "last x seconds" during which no more than MaxRequestCount requests may be issued before the action defined by MaxRequestFailAction is applied.

Numeric (0 = unlimited)


Default: 3600

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
MaxRequestWaitSeconds

If the MaxRequestFailAction setting supports waiting for enough time to allow the MaxRequestCount & MaxRequestIntervalSizeSeconds settings to "age out" a prior request, then this setting specifies the maximum amount of time that a request will be left to wait. A large value for this setting implies request threads could be blocked for what seems like an indefinite period.

Numeric (0 = no waiting)


Default: 90

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
MinRequestIntervalMilliseconds

The minimum number of milliseconds between request starts (by site).

Numeric (0 = no delay)


Default: 25

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)
MaxRequestFailAction

Controls the action to take when the MaxRequestCount / MaxRequestIntervalSizeSeconds settings are exceeded.

WaitToMaxWithQuickFail - if a new request could be issued within MaxRequestWaitSeconds, the thread will wait; otherwise, the request returns an error

WaitToMax - always wait MaxRequestWaitSeconds

ReturnError - an error is always returned


Default: WaitToMaxWithQuickFail

WebGetSingle (All)
WebGetSingleFromTable (All)
WebGetMultiple (Excel)
WebGetTable (All)
WebGetDynamicTable (Excel)
WebGetTableMetadata (SQL)