Connection String Attributes

Introduction

This page lists all possible attributes you can use in ConnectionString or WITH clause of SQL Query. If you are not sure how to write correct connection string then perform following steps.

Search for odbcad32 in the start menu. Click to launch it.
Configure desired properties in the grid and check Query Preview to make sure everything is correct.
Click on [Copy Connection String] button to generate full connection string.

Connection String Examples

Syntax: (Direct Connection string without DSN)

Driver={ZappySys Xml Driver}[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;]

Syntax: (Using DSN)

DSN=YourDsnName;[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;]

Connection String Attributes

Attribute

Label

Description

AccessMode
(Setting of XmlConfigurationParams)

AccessMode

Defines how to read data from file path/URL or direct string

Available Options

Option	Description
DirectPath	DirectPath
DirectValue	DirectValue

ConnectionStringFile
(Setting of XmlConfigurationParams)

ConnectionStringFile

ConvertFormat
(Setting of XmlConfigurationParams)

ConvertFormat

Output convert raw XML document to JSON (Recommended). This option is ignored if OutputRawDocument=false. Once you do that any further parsing downstream must use JSON Parser rather than XML Parser.

Data
(Setting of XmlConfigurationParams)

DirectValue

Direct String you like to use as a datasource. This attribute always takes precedence if both Data and Src defined (i.e. File/Url). You can also use AccessMode=1 along with Data='...' in WITH clause to use Direct String rather than URL/File.

EnableCustomReplace
(Setting of XmlConfigurationParams)

EnableCustomReplace

Enables custom search / replace in the document text after its read from the file/url or direct string. This replace operation happens before its parsed. This option can be useful for custom escape sequence in source document which is causing issue in the parser. You can replace such unwanted characters fore parser starts parsing the text.

IgnoreContentLengthHeaderForGzipResponse
(Setting of XmlConfigurationParams)

IgnoreContentLengthHeaderForGzipResponse

ReplaceWith
(Setting of XmlConfigurationParams)

ReplaceWith

String you like to replace with (Only valid when EnableCustomReplace option is turned on). If you added --regex or --regex-ic at the end of your SearchFor string then ReplaceWith can use special placeholders (i.e. $1, $2...) based on regular expression groups. For example you SearchFor=(\w+)(@\w+.com) to search for emails then to mask emails you can something like this for ReplaceWith = ****$2 (where $2 is domain part and $1 is before @)

SearchFor
(Setting of XmlConfigurationParams)

SearchFor

String you like to search for (Only valid when EnableCustomReplace option is turned on). If you want to enable Regular Expression pattern search then add --regex or --regex-ic (for case-insensitive search) at the end of your search string (e.g. ORDER-\d+--regex OR ORDER-\d+--regex-ic (case-insensitive search) )

2D Array Settings

ArrayTransColumnNameFilter
(Setting of XmlConfigurationParams)

Array Transformation ColumnName Filter

Filter expression to use to extract column names for array transformation.

ArrayTransCustomColumns
(Setting of XmlConfigurationParams)

Columns Names for Array Transformation

When you have 2D array but don't have column list specified in a separate array then use specify column names here. Use comma separated list (e.g col1,col2,col3 ). Column name Order must match value order.

ArrayTransEnableCustomColumns
(Setting of XmlConfigurationParams)

Use Custom Columns for Array Transformation

When you have 2D array but don't have column list specified in a separate array then use this option (e.g. { arr: [[10,11],[21,22]] } ). If you selected Column less array or JSON Lines option then this property means Column Names coming from First Line of array.

ArrayTransformType
(Setting of XmlConfigurationParams)

Array Transformation Type

Array Transformation you want to apply. Useful for case when you have 2-Dimensional arrays with rows/columns in separate arrays.

Available Options

Option	Description
None	None
TransformSimpleTwoDimensionalArray	Simple 2-dimensional array (e.g. {cols:[..], rows:[[..],[..]]} )
TransformComplexTwoDimensionalArray	Complex 2-dimensional array (e.g. {cols:[{..},{..}], rows:[{f:[..]},{f:[..]}] )
TransformKeyValuePivot	Key/Value to Columns
TransformMultipleColumnsExpressions	Multiple columns using expressions
TransformColumnslessArray	Columnless array (e.g. [[..],[..]] )
TransformJsonLineArray	JSON Lines - Single Dimension Array(s) (i.e. [..][..] )
TransformPivotColumnlessArray	Pivot - Columnless array (e.g. [..] )

ArrayTransRowValueFilter
(Setting of XmlConfigurationParams)

Array Transformation Row Filter

Filter expression for row values (Not applicable for simple array transformation).

Array Handling

ElementsToTreatAsArray
(Setting of XmlConfigurationParams)

Element names to treat as array

Comma separated element names which will be treated as Array regardless how many times element repeats at the same level. By default only those elements are treated as array if element appears more than once at the same level.

Cache Settings

CacheEntryTtl
(Setting of XmlConfigurationParams)

Cache entry lifetime, sec

This property indicates how many seconds data is kept in cache (in case caching is enabled)

CacheFileLocation
(Setting of XmlConfigurationParams)

Cache file location

This property allows you to set cache file location (you have to set Cache persistence mode to Storage)

CacheStorage
(Setting of XmlConfigurationParams)

Cache storage

Specifies cache storage - in-memory only or local data file

Available Options

Option	Description
Memory	Memory
File	File

CachingMode
(Setting of XmlConfigurationParams)

Cache mode

Enables or disables cache usage for metadata / data

Available Options

Option	Description
Disabled	Caching disabled
Metadata	Cache metadata
All	Cache all

Encoding / Culture Settings

CharacterSet
(Setting of XmlConfigurationParams)

CharacterSet

Character set for text (e.g. utf-8 )

Culture
(Setting of XmlConfigurationParams)

Culture

Culture code (e.g. pt-BT). This helps to parse culture specific number formats (e.g. In some culture you may have comma rather than decimal points 0.1 can be 0,1)

Encoding
(Setting of XmlConfigurationParams)

Encoding

Encoding of source file

Available Options

Option	Description
Default	Default
ASCII	ASCII
UTF8	UTF-8
UTF16	UTF-16 LE (i.e. Unicode Little Endian)
UTF32	UTF-32
UTF8WithoutBOM	UTF-8 Without BOM
UTF32WithoutBOM	UTF-32 Without BOM
UTF7	UTF-7
UTF7WithoutBOM	UTF-7 Without BOM
UTF16WithoutBOM	UTF-16 Without BOM
BigEndian	UTF-16 BE (i.e. Unicode Big Endian)
BigEndianWithoutBOM	UTF-16 BE Without BOM

Error Handling Settings

ConsumeResponseOnError
(Setting of XmlConfigurationParams)

Consume response on error

When error occurs no data is returned. Use this option to get content eventhough error occurs. When this option is checked you can't use [continue on error when specific string found in response] option

ContineOn404Error
(Setting of XmlConfigurationParams)

Continue on error #404

Set this parameter to True if you want to continue execution if HTTP error #404 is returned by API

ContineOnAnyError
(Setting of XmlConfigurationParams)

Continue on any error

If this parameter is set to True then any HTTP error returned by API will be ignored

ContineOnErrorForMessage
(Setting of XmlConfigurationParams)

Continue on message

If value of this parameter is found in API status response text - query processing will be continued

ContineOnErrorForStatusCode
(Setting of XmlConfigurationParams)

Continue on status code

Query processing will be continued in case HTTP status code of response is equal to the value of this parameter

ConvErrorHandlingMode
(Setting of XmlConfigurationParams)

Error handling for data conversion

Determines whether some data conversion errors are ignored or stop query processing.

Available Options

Option	Description
ThrowError	Stop execution on data conversion error
Ignore	Ignore data conversion errors

ErrorStatusCodeToMatch
(Setting of XmlConfigurationParams)

Error on status code

HTTP status code of API response will trigger error in case it matches the value of this parameter

ErrorSubstringToMatch
(Setting of XmlConfigurationParams)

Error on message

If API status response contains the value of this parameter - execution will be terminated by error

MatchForEqual
(Setting of XmlConfigurationParams)

Match StatusCode for Equal

If true then error statuscode is checked for equal condition else checked for not equal condition.

Filter Settings

ElementScopeSeparator
(Setting of XmlConfigurationParams)

Child scope separator

Scope separator for nested properties (Child properties under selected filter). For example you may have $.contacts[*] as your filter and for each contact you may have nested node e.g AddressInfo / ZipInfo / Zip. By default column name will be AddressInfo.ZipInfo.Zip (Default separator is dot) but if you want column name like AddressInfo_ZipInfo_Zip in the output then change this property to any custom value (e.g. _). If you dont set this property then dot will be used.

FilterForParentColumnsWithArrayType
(Setting of XmlConfigurationParams)

Filter for parent columns of array type

Set this option to true if you want to output parent columns which are of array type. By default any parent column which is an array is not included in output. See also FilterForParentColumnsWithArrayType property if you set this property

IncludeParentColumns
(Setting of XmlConfigurationParams)

Include parent columns

If this option is enabled then parent properties of non-array type will be output along with regular row attributes.

IncludeParentColumnsWithArrayType
(Setting of XmlConfigurationParams)

Include parent columns of array type

Set this option to true if you want to output parent columns which are array. By default any parent column which is an array is not included in output. See also FilterForParentColumnsWithArrayType property if you set this property

IncludeParentWhenChildNull
(Setting of XmlConfigurationParams)

IncludeParentWhenChildNull

By default child and parent information is not included in the output if children not found for specified expression. For example if you want to extract all orders from all customers nodes then you can type $.Customers[*].Orders[*]. This will fetch all orders from all customers. By default customers records without orders wont be included in the output. If you want to include those customers where orders not found then check this option (Output null information for order attributes). This behavior is similar to LEFT OUTER JOIN in SQL (Left side is parent, right side is child). This option is ***resource intensive*** so only check if you really care about this behavior.

LevelSeparator
(Setting of XmlConfigurationParams)

Parent scope separator

Property level separator used in generated property name (separator for outer properties - Above selected filter node). Use this if default separator is producing duplicate property name which is conflicting with existing name.

LevelsToScan
(Setting of XmlConfigurationParams)

Maximum levels to scan

Specifies how many nested levels should be scanned. 0 means no limitations to scan.

ParentColumnPrefix
(Setting of XmlConfigurationParams)

Parent prefix

Value of this parameter will be used as prefix of parent element. Empty means default prefix will be used.

ThrowErrorWhenNoMatch
(Setting of XmlConfigurationParams)

Throw error on Filter no-matches

Determines whether error is thrown in case data table name element is missing from response or no data row is returned.

Value
(Setting of NameValuePair)

Value

HTTP Settings-1 (General)

IsMultiPart
(Setting of XmlConfigurationParams)

Is File Upload Request

Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)

==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )

==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. File content type is determined based on extension.
See below Example of uploading multiple files along with additional fields.

file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.txt
SomeField1=aaaaaaa
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterId

RequestContentTypeCode
(Setting of XmlConfigurationParams)

Request ContentType

Specifies content type for data you wish to POST. If you select Default option then system default content type will be used (i.e. application/x-www-form-urlencoded). If you specify Content-Type header along with this option then header value takes precedence.

Available Options

Option	Description
Default	Default
TextPlain	Text (text/plain)
ApplicationJson	JSON (application/json)
ApplicationXml	XML (application/xml)
TextXml	XML (text/xml)
TextXmlUtf8	XML (text/xml;charset=UTF-8)
TextHtml	HTML (text/html)
ApplicationFormUrlencoded	Form (application/x-www-form-urlencoded)
ApplicationOctetStream	Binary (application/octet-stream)
Raw	Raw (No content-type)
MultiPartMixed	Multipart Mixed (multipart/mixed)
ApplicationGraphql	GraphQL (application/graphql)

RequestData
(Setting of XmlConfigurationParams)

Request data (Body)

User defined data that will be sent in HTTP Request (e.g. Upload file data, Form POST data etc). In case Request method is set to 'POST' system will automatically set content-type header to 'application/x-www-form-urlencoded' unless you selected different Request Content Type.

RequestMethod
(Setting of XmlConfigurationParams)

Request Method

Http Web Request Method (e.g. POST, GET, PUT, LIST, DELETE...). Refer your API documentation if you are not sure which method you have to use.

RequestTimeoutMs
(Setting of XmlConfigurationParams)

Request timeout (milliseconds)

Http request Timeout in milliseconds (1000 ms = 1 second). This setting determines how long you want to wait before throwing error if server doesn't respond in specified timeout. Set this to 0 if you want to use system default value (i.e. 100 seconds)

SupportCompression
(Setting of XmlConfigurationParams)

Support compression

Enable this to support HTTP compression

UserAgent
(Setting of XmlConfigurationParams)

User agent

Value of this parameter will be sent in HTTP User-Agent header

HTTP Settings-2 (Advanced)

EnableBodyPlaceholderForMultiPart
(Setting of XmlConfigurationParams)

EnableBodyPlaceholderForMultiPart

By default placeholders (e.g. <%access_token%> or [$a.MyColumn$]) are not replaced when you Enable MultiPart File Upload option to speedup performance. However in some case if you like to use placeholder inside file content you trying to use as Body then enable this option.

IgnoreSSLCertificateErrors
(Setting of XmlConfigurationParams)

Ignore SSL certificate errors

Set this parameter to True if SSL certificate errors must be ignored

PreventAutoRedirect
(Setting of XmlConfigurationParams)

Prevent Auto Redirect (301, 302 redirect)

By default HTTP 301 and 302 redirects are allowed. For some reason you want to disable it then set this option.

StreamReadWriteTimeoutMs
(Setting of XmlConfigurationParams)

Read/write timeout, ms

Defines timeout for API requests and responses. 0 means no time limits

UseSslVersion
(Setting of XmlConfigurationParams)

SSL/TLS version

SSL/TLS Version for HTTPS requests

Available Options

Option	Description
Default	System Default
Ssl3	SSL v3.0
Ssl3Plus	SSL v3.0 or higher
Tls	TLS v1.0
TlsPlus	TLS v1.0 or higher
Tls11	TLS v1.1
Tls11Plus	TLS v1.1 or higher
Tls12	TLS v1.2
Tls12Plus	TLS v1.2 or higher
Tls13	TLS v1.3
Any	Any Version

Log Settings

LoggingLevel
(Setting of XmlConfigurationParams)

Log level

Sets level of messages logged

Available Options

Option	Description
None	None
Error	Error
Debug	Debug
Info	Info

LogPath
(Setting of XmlConfigurationParams)

Log file location

Sets location for the log file (empty value means no log written)

LogSize
(Setting of XmlConfigurationParams)

Maximum log file size (Mb)

Sets limit for log file size (0 means no limit, old log entries will be discarded if size limit is reached)

GroupName
(Setting of ColumnsMetadata)

Group name

OverrideMode
(Setting of ColumnsMetadata)

OverrideMode

Metadata Settings

MetaScanMode
(Setting of XmlConfigurationParams)

Metadata Scan Mode / Multiplier

Metadata guess mode / multiplier to detect length by scanning rows defined in

Available Options

Option	Description
Auto	Auto
Strict	Strict - Exact length
Guess2x	Guess2x - 2 times bigger
Guess3x	Guess3x - 3 times bigger
Guess4x	Guess4x - 4 times bigger
TreatAsUnicodeString	Set all columns as string
Guess10x	Guess10x - 10 times bigger
TreatStringAsMaxLength	Set string columns with MAX Length - i.e. DT_WSTR(4000)
TreatStringAsBlob	Set string columns as BLOB - i.e. DT_NTEXT

MetaTreatStringAsAscii
(Setting of XmlConfigurationParams)

Treat string as ASCII

When this option is true, it detects all string values as DT_STR (Ascii) rather than DT_WSTR (Unicode)

RowsToScanForMetadata
(Setting of XmlConfigurationParams)

Number of rows scanned to collect metadata

If metadata isn't defined for query the driver will try to scan some rows to guess fields parameters

TreatBlankBoolAsNull
(Setting of XmlConfigurationParams)

Treat blank BOOLEAN value as NULL

TreatBlankDateAsNull
(Setting of XmlConfigurationParams)

Treat blank DATE/TIME value as NULL

TreatBlankNumberAsNull
(Setting of XmlConfigurationParams)

Treat blank NUMERIC value as NULL

Other Settings

DateParseHandling
(Setting of XmlConfigurationParams)

Date data type

Specifies how dates are parsed.

Available Options

Option	Description
None	Keep date as string
DateTime	Convert to DateTime (Timezone lost)
DateTimeOffset	Convert to DateTimeOffset (Preserve Time zone)

EnableBigNumberHandling
(Setting of XmlConfigurationParams)

Enable Big Number Handling

When this option is checked, sytem allows to parse large number (Higher than Int64) in JSON document (i.e. { id: 76000009353950433247780 } ). If you do not turn on this option then it may throw error if large number is encountered. This option is SLOW becuase it has to perform additional checks in order to avoid Large number overflow error so do not turn on unless you getting Large number error.

EnablePerformanceMode
(Setting of XmlConfigurationParams)

Enable Stream Mode

Enables memory optimized mode. You may lose certain functionality when you turn on this. Only turn on this feature if you getting out of memory error.

FloatParseHandling
(Setting of XmlConfigurationParams)

FloatParseHandling

Specifies how decimal values are parsed when reading JSON. Change this setting to Decimal if you like to have large precision / scale.

Available Options

Option	Description
Double	Default (Double [~15-17 digits])
Decimal	Decimal (High Precision / Scale [~28-29 digits] )

Recursive
(Setting of XmlConfigurationParams)

Scan files recursively

Scan files recursively when you read from local files (i.e. include files from sub folders).

Output Settings

DateFormatString
(Setting of XmlConfigurationParams)

Date format

Specifies date format

DefaultRowLimit
(Setting of XmlConfigurationParams)

Default data row limit (i.e. LIMIT / TOP clause)

Use this option if you like to limit number of rows fetched by any query. If you use LIMIT clause in the query then this option is ignored.

EnableArrayFlattening
(Setting of XmlConfigurationParams)

Enable Array Flattening

Enables deep array flattening for selected filtered hierarchy. When you turn on this property it will flatten each property of each array item and expose as column (e.g. If you have Filter set as $.customers[*] and for each customer you have an array of Addresses then you may see output columns like Addresses.1.City, Addresses.1.State, Addresses.2.City, Addresses.2.State .... Addresses.N.City, Addresses.N.State). You can control how many array items you want to flatten by setting MaxArrayItemsToFlatten property.

EnablePivot
(Setting of XmlConfigurationParams)

Enable Pivot

When this property is true then Column is converted to Row. Pivoted names will appear under Pivot_Name column and values will appear under Pivot_Value field.

EnableRawOutputMode
(Setting of XmlConfigurationParams)

Enable Raw Document Output Mode

Output as raw JSON/XML document rather than parsing individual fields. This option is helpful if you have documents stored in a file and you want to pass them downstream as raw JSON string rather than parsing into columns.

EnableRawOutputModeSingleRow
(Setting of XmlConfigurationParams)

Enable Raw Document - Single Row (Disable parser, allow any format)

Enable Raw Document Output Mode for any format (i.e. XML, Html, Text, Json). Unlike other option EnableRawOutputMode, this option doesn't invoke parser to extract documents by finding row terminator. It will source string as row value in single row/ single column.

ExcludeColumns
(Setting of XmlConfigurationParams)

Excluded properties

List of comma separated element names which you want to exclude from output. Specify parent element name to exclude all child nodes.

FileCompressionType
(Setting of XmlConfigurationParams)

FileCompressionType

Compression format for source file (e.g. gzip, zip)

Available Options

Option	Description
None	None
GZip	GZip
Zip	Zip
TarGZip	TarGZip

IndentOutput
(Setting of XmlConfigurationParams)

Indent output

Indent JSON output to improve readability.

MaxArrayItemsToFlatten
(Setting of XmlConfigurationParams)

Max Array Items To Flatten

Maximum number of array items to flatten. inner array flattening. Adjust this property to control how many columns being generated. This option is ignored if you set EnableArrayFlattening=false

RawOutputDataRowTemplate
(Setting of XmlConfigurationParams)

RawOutputDataRowTemplate

RawOutputExtractMode
(Setting of XmlConfigurationParams)

RawOutputExtractMode

Available Options

Option	Description
None	None
Json	Json
Xml	Xml
Regex	Regex

RawOutputFilterExpr
(Setting of XmlConfigurationParams)

RawOutputFilterExpr

Use this property to define one or multiple expressions (i.e. JsonPath,XPath,Regex) to extract information from source. This property is only valid when EnableRawOutputModeSingleRow=true and RawOutputDataRowTemplate is set.

SaveContentAsBinary
(Setting of XmlConfigurationParams)

SaveContentAsBinary

Pagination Settings

EnablePageTokenForBody
(Setting of XmlConfigurationParams)

EnablePageTokenForBody

If you wish to pass extracted pagination token in the body of next request then set this option to true. You can use [$pagetoken$] placeholder anywhere in the Body where you wish to insert extracted Page token. You must set encoded token you can use <%nextlink_encoded%> inside SuffixForNextUrl Property. If you dont use SuffixForNextUrl then raw nextLink or Token will be inserted inside the body. If you dont specify [$pagetoken$] placeholder in the body then NextPage Token will be appended at the end.

FirstPageBodyPart
(Setting of XmlConfigurationParams)

FirstPageBodyPart

Use this property to set request body fragment for first page. HasDifferentNextPageInfo must be set to true to use this property.

HasDifferentNextPageInfo
(Setting of XmlConfigurationParams)

HasDifferentNextPageInfo

Set this to true if you wish to specify different URL, Header, Body or Filter for first page and next page (i.e. Paginated response). Some APIs like Amazon MWS, NetSuite, Zuora) you may need to set this to true.

IncrementBy
(Setting of XmlConfigurationParams)

Page number increment

Page counter increment. By default next page is incremented by one if this value is zero. You can also enter negative number if you want to decrease page counter.

NextPageBodyPart
(Setting of XmlConfigurationParams)

NextPageBodyPart

Use this property to set request body fragment for any request after first request. HasDifferentNextPageInfo must be set to true to use this property.

NextUrlAttributeOrExpr
(Setting of XmlConfigurationParams)

Next Url AttributeName or Expression

Specifies attribute name or expression (e.g. $.pageInfo.nextUrl ) that contains next page Url (for the case data contains next Url attribute). If no attribute with such name is found or its value is null then data fetch is completed

NextUrlEndIndicator
(Setting of XmlConfigurationParams)

Next Url Stop Indicator Value

Specifies value which indicates last page to stop pagination. If you have specified StopIndicatorAttribute then you can use Regular expression rather than static value to indicate last page. To use regular expression value of this property must start with regex= prefix. Example : regex=FALSE|N (assuming you set StopIndicatorAttribute to something like $.hasMore)

NextUrlSuffix
(Setting of XmlConfigurationParams)

Next Url suffix

If you want to include certain text (or parameters) at the end of Next url then specify this attribute (e.g. &format=json)

PagePlaceholders
(Setting of XmlConfigurationParams)

PagePlaceholders

When HasDifferentNextPageInfo=true you can set this property to indicate first page and next page. You can specify different URL, Header, Body or Filter for first page and next page (i.e. Paginated response). Use [$tag$] as placeholder anywhere in the URL, Header, Body or Filter and at runtime system will replace it with correct value (first page or next page value). Syntax to specify placeholder for first page vs next page is like a connectionstring url=FirstPageValue|NextPageValue;header=FirstPageValue|NextPageValue;body=FirstPageValue|NextPageValue;filter=FirstPageValue|NextPageValue; You can use one or more key/value pairs to make things dynamic (e.g. url, header, body or filter) .For example if you have pagination in your API and First URL is http://abc.com/api/items/get and to get more records you have to call http://abc.com/api/items/getNext then you can use [$tag$] as placeholder in the URL http://abc.com/api/items/[$tag$] and specify this property with first page tag and next page tag as url=get|getNext (Tags are separated using vertical bar).

PagingByUrlAttributeName
(Setting of XmlConfigurationParams)

Page number Url parameter name

e.g. Type page_num if URL looks like this => http://abc.com/?page_num=1&sort=true (page number via query string)
--or-- Type <%page%> if page number is inside URL path like this => http://abc.com/1/?sort=true (e.g. replace page number in url with placeholder http://abc.com/<%page%>/?sort=true)
Page number will be incremented by one for next URL until last page is reached or [Max Page Number] is reached. This parameter also controls pagination mode [ByResponseHeaderContinuationToken]. When this mode is used you can enter RESPONSE_HEADER_NAME --OR-- NEXT_QUERY_PARAM=RESPONSE_HEADER_NAME --OR-- NEXT_QUERY_PARAM=RESPONSE_HEADER_NAME(regular_expression). If NEXT_QUERY_PARAM (left side) is omitted then Response Header value is sent to next request in the same Header name. If you like to pass response header value in the next URL then use two parts (e.g. cursor=X-CONTINUE-TOKEN) ... this example will read X-CONTINUE-TOKEN header from response and pass it to next request in the URL like http://myapi.com/?cursor=[value-from-previous-response]. You can also use advanced syntax using Regular expression to extract substring from response header value (e.g. cursor=X-CONTINUE-TOKEN(\d*)) will extract only numeric part from header value. Another example is cursor=X-CONTINUE-TOKEN(^((?!null\b).)*$) ... this will return value if its other than "null" (word). For more information about using regular expression check this link https://zappysys.com/links/?id=10124

PagingByUrlCheckResponseErrString
(Setting of XmlConfigurationParams)

Error string

Response is treated as invalid if it contains specified error string.

PagingByUrlCheckResponseMaxBytes
(Setting of XmlConfigurationParams)

Maximum response length

Maximum length of valid response (bytes).

PagingByUrlCheckResponseMinBytes
(Setting of XmlConfigurationParams)

Minimum response length

Minimum length of valid response (bytes).

PagingByUrlCheckResponseStatusCode
(Setting of XmlConfigurationParams)

'Not found' status code

Expected HTTP status code to stop pagination (This is only used if [Last page trigger] is set based on HTTP StatusCode).

PagingByUrlCurrentPage
(Setting of XmlConfigurationParams)

Starting Page Number

Specifies starting page number. This will be incremented each time when next request is made until last page is reached.

PagingByUrlEndStrategy
(Setting of XmlConfigurationParams)

Last page trigger

Specifies the way last page is detected.

Available Options

Option	Description
DetectBasedOnResponseSize	Detect last page based on response size (in bytes)
DetectBasedOnResponseErrorMessage	Detect last page based on error message (sub string)
DetectBasedOnResponseStatusCode	Detect last page based on status code (numeric code)
DetectBasedOnRecordCount	Detect based on missing row (stop when no more records)
DetectBasedOnMultipleRules	Detect based on multiple rules (i.e. mix of status(es), size, error)

PagingByUrlLastPageWhenConditionEqualsTo
(Setting of XmlConfigurationParams)

Use condition to detect last page

Enables or disables usage of condition to detect last page.

PagingByUrlMaxPages
(Setting of XmlConfigurationParams)

Maximum page number

Maximum page number until which auto increment is allowed. Type zero for no limit. Next URL contains next page number (increment by one) until last page is detected or [Max Page Number] limit is reached.

PagingMaxPagesExpr
(Setting of XmlConfigurationParams)

PagingMaxPagesExpr

Expression to extract Maximum pages to loop through.

PagingMaxRowsDataPathExpr
(Setting of XmlConfigurationParams)

PagingMaxRowsDataPathExpr

When you enable PagingMaxRowsExpr (end pagination based on MaxRowCount) then you need to count records coming in each response. This expression extract all rows found under specified expression (e.g. $.orders[*] if all records found under orders node).

PagingMaxRowsExpr
(Setting of XmlConfigurationParams)

PagingMaxRowsExpr

Expression to extract Maximum records to loop through. Some APIs don't stop pagination and keep returning last page data when you try to read data after last page. Specify expression (e.g. $.total_rows ) to read total pages to loop through using this property. This setting is ignored if you set PagingMaxPagesExpr.

PagingMode
(Setting of XmlConfigurationParams)

Paging mode

Specifies the mode of fetching multiple pages of data returned by REST API.

Available Options

Option	Description
ByResponseAttribute	Response Attribute Mode - Read next page information from response
ByUrlParameter	Url Parameter Mode - Page number / offset passed as URL parameter (starts at 1 OR custom value in URL)
ByUrlPath	Url Path Mode - Page number / offset passed as URL path (starts at 0 OR custom value)
ByPostData	POST data Mode - Page number is passed inside POST data
ByUrlParameterMulti	Url Parameter Mode (Multi) - Pass Start and End Row Number in URL
ByResponseHeaderRfc5988	Response Header contains Next Link - RFC 5988 (Next URL Link found in Standard Header)
ByResponseHeaderCustom	Response Header contains Next Link - Custom (Next URL Link found in Custom Header)
ByResponseHeaderContinuationToken	Response Header contains Continuation Token

StopIndicatorAttributeOrExpr
(Setting of XmlConfigurationParams)

Stop Indicator AttributeName or Expression

Name of attribute or expression for attribute which can be used as stop indicator (e.g. hasmore --or-- $.pagination.hasmore). If this value is blank then 'Next Url attribute' is used

WaitTimeMs
(Setting of XmlConfigurationParams)

Request throttle time

This option indicates number of milliseconds to wait after each request so it is possible to adjust how many API calls can be made within certain timeframe. If used API Service has no API call limit then this option should be set to 0

Query Engine Temp Storage

TempStorageMode
(Setting of XmlConfigurationParams)

Intermediate results storage

Use [Disk] if number of resulting rows or row data size is large

Available Options

Option	Description
Memory	Memory
Disk	Disk

CertificatePassword
(Setting of ClientCertificateInfo)

CertificatePassword

CertificatePath
(Setting of ClientCertificateInfo)

CertificatePath

DisplayPath
(Setting of ClientCertificateInfo)

DisplayPath

EnableCertificate
(Setting of ClientCertificateInfo)

EnableCertificate

IgnoreValidationErrors
(Setting of ClientCertificateInfo)

IgnoreValidationErrors

IsServiceAccount
(Setting of ClientCertificateInfo)

IsServiceAccount

StorageType
(Setting of ClientCertificateInfo)

StorageType

Available Options

Option	Description
NotSet	<Not set>
LocalMachine	Stored in LocalMachine Storage Area
CurrentUser	Stored in User Storage Area
PfxFile	Disk File - PFX (PKCS12) format

StoreName
(Setting of ClientCertificateInfo)

StoreName

Available Options

Option	Description
NotSet	<Not set>
AddressBook	AddressBook
AuthRoot	AuthRoot
CertificateAuthority	CertificateAuthority
Disallowed	Disallowed
My	My
Root	Root
TrustedPeople	TrustedPeople
TrustedPublisher	TrustedPublisher

Thumbprint
(Setting of ClientCertificateInfo)

Thumbprint

LogLevel
(Setting of ILogger)

LogLevel

Available Options

Option	Description
Normal	Normal
Summary	Summary
Detail	Detail
Debugging	Debugging
Disabled	Disabled

PrefixTimestamp
(Setting of ILogger)

PrefixTimestamp

DoNotUseDefaultProxy
(Setting of ProxyInfo)

DoNotUseDefaultProxy

EnableProxy
(Setting of ProxyInfo)

EnableProxy

ProxyAuthMode
(Setting of ProxyInfo)

ProxyAuthMode

Available Options

Option	Description
Basic	Basic
Ntlm	Ntlm
Digest	Digest

ProxyDomain
(Setting of ProxyInfo)

ProxyDomain

ProxyHost
(Setting of ProxyInfo)

ProxyHost

ProxyPassword
(Setting of ProxyInfo)

ProxyPassword

ProxyPort
(Setting of ProxyInfo)

ProxyPort

ProxyType
(Setting of ProxyInfo)

ProxyType

Available Options

Option	Description
None	None
Socks4	Socks4
Socks4a	Socks4a
Socks5	Socks5
HttpConnect	HttpConnect

ProxyUrl
(Setting of ProxyInfo)

ProxyUrl

ProxyUseCreds
(Setting of ProxyInfo)

ProxyUseCreds

ProxyUser
(Setting of ProxyInfo)

ProxyUser

MaxRetryCount
(Setting of RetryInfo)

MaxRetryCount

MessageListToHandle
(Setting of RetryInfo)

MessageListToHandle

MultiplyWaitTimeForEachAttempt
(Setting of RetryInfo)

MultiplyWaitTimeForEachAttempt

RetryMode
(Setting of RetryInfo)

RetryMode

Available Options

Option	Description
None	Do not retry
RetryAny	Retry any web errors
RetryWhenStatusCodeMatch	Retry for matching response status code(s)
RetryWhenMessageMatch	Retry errors for matching error sub string(s)

StatusCodeListToHandle
(Setting of RetryInfo)

StatusCodeListToHandle

WaitTimeMs
(Setting of RetryInfo)

WaitTimeMs

AuthScheme
(Setting of HttpConnection)

AuthScheme

ConnectionString
(Setting of HttpConnection)

ConnectionString

ConnectionStringFile
(Setting of HttpConnection)

ConnectionStringFile

ConnectionStringFull
(Setting of HttpConnection)

ConnectionStringFull

ConnectionStringNonDefaultsOnly
(Setting of HttpConnection)

ConnectionStringNonDefaultsOnly

ConnectionStringNonDefaultsOnlyFull
(Setting of HttpConnection)

ConnectionStringNonDefaultsOnlyFull

CredentialType
(Setting of HttpConnection)

CredentialType

Available Options

Option	Description
Notset	Not set
Windows	Default Windows Credentials - Current User Credentials
Basic	Basic - UserID/Password
NTLM	NTLM - UserID/Password/Domain
Kerberos	Kerberos - UserID/Password/Domain
SoapWss	SOAP WSS - UserID/Password in SOAP Body
Token	Static Token / API Key
TokenDynamic	Dynamic Token - Two Step Auth (i.e. Login to get token)
TokenJwt	JWT Token (RFC 7519)
HashSignature	HMAC / Hash Signature (i.e. Request Hashing using Key / Password)
Digest	Digest - UserID/Password (WITHOUT PARAMETER in URL)
PlaceholderAuth	Credentials in Body (Replace [$password$] and [$userid$])
Hawk	Hawk Authentication

DisableCustomUrl
(Setting of HttpConnection)

DisableCustomUrl

DisableSockProxySupport
(Setting of HttpConnection)

DisableSockProxySupport

DisableTest
(Setting of HttpConnection)

DisableTest

DisableThirdPartWebRequest
(Setting of HttpConnection)

DisableThirdPartWebRequest

EnableRequestHashing
(Setting of HttpConnection)

EnableRequestHashing

ExtraHeaders
(Setting of HttpConnection)

ExtraHeaders

ExtraHeadersForLogin
(Setting of HttpConnection)

ExtraHeadersForLogin

HashAlgorithm
(Setting of HttpConnection)

HashAlgorithm

HashDoNotSign
(Setting of HttpConnection)

HashDoNotSign

HashFormatForBody
(Setting of HttpConnection)

HashFormatForBody

HashNounce
(Setting of HttpConnection)

HashNounce

HashSignatureFormat
(Setting of HttpConnection)

HashSignatureFormat

HashSignatureFormatForLogin
(Setting of HttpConnection)

HashSignatureFormatForLogin

HashSignWithApiKey
(Setting of HttpConnection)

HashSignWithApiKey

HashTimestamp
(Setting of HttpConnection)

HashTimestamp

HashTimestampFormat
(Setting of HttpConnection)

HashTimestampFormat

HashTreatSecretAsNonBase64
(Setting of HttpConnection)

HashTreatSecretAsNonBase64

JwtCustomClaims
(Setting of HttpConnection)

JwtCustomClaims

MetaBody
(Setting of HttpConnection)

MetaBody

MetaContentType
(Setting of HttpConnection)

MetaContentType

Available Options

Option	Description
None	None
Json	Json
Xml	Xml
Regex	Regex

MetaFields
(Setting of HttpConnection)

MetaFields

MetaFilters
(Setting of HttpConnection)

MetaFilters

MetaHeaders
(Setting of HttpConnection)

MetaHeaders

MetaMethod
(Setting of HttpConnection)

MetaMethod

MetaTemplate
(Setting of HttpConnection)

MetaTemplate

MetaUrl
(Setting of HttpConnection)

MetaUrl

Password
(Setting of HttpConnection)

Password

PreferProxyUrl
(Setting of HttpConnection)

PreferProxyUrl

RetainCookies
(Setting of HttpConnection)

RetainCookies

RetainSameConnection
(Setting of HttpConnection)

RetainSameConnection

RetryCountMax
(Setting of HttpConnection)

RetryCountMax

RetryMessageList
(Setting of HttpConnection)

RetryMessageList

RetryMode
(Setting of HttpConnection)

RetryMode

Available Options

Option	Description
None	Do not retry
RetryAny	Retry any web errors
RetryWhenStatusCodeMatch	Retry for matching response status code(s)
RetryWhenMessageMatch	Retry errors for matching error sub string(s)

RetryMultiplyWaitTime
(Setting of HttpConnection)

RetryMultiplyWaitTime

RetryStatusCodeList
(Setting of HttpConnection)

RetryStatusCodeList

RetryWaitTimeMs
(Setting of HttpConnection)

RetryWaitTimeMs

SoapWssPasswordType
(Setting of HttpConnection)

SoapWssPasswordType

Available Options

Option	Description
Notset	Not set
PasswordText	PasswordText (Plain Text)
PasswordDigest	PasswordDigest (SHA1 Hashed)

SslVersion
(Setting of HttpConnection)

SslVersion

Available Options

Option	Description
Default	System Default
Ssl3	SSL v3.0
Ssl3Plus	SSL v3.0 or higher
Tls	TLS v1.0
TlsPlus	TLS v1.0 or higher
Tls11	TLS v1.1
Tls11Plus	TLS v1.1 or higher
Tls12	TLS v1.2
Tls12Plus	TLS v1.2 or higher
Tls13	TLS v1.3
Any	Any Version

SupportDualProxyMode
(Setting of HttpConnection)

SupportDualProxyMode

Timeout
(Setting of HttpConnection)

Timeout

TokenAuthHeader
(Setting of HttpConnection)

TokenAuthHeader

TokenExpirationTimeInSeconds
(Setting of HttpConnection)

TokenExpirationTimeInSeconds

TokenFunction
(Setting of HttpConnection)

TokenFunction

TokenRequestContentType
(Setting of HttpConnection)

TokenRequestContentType

Available Options

Option	Description
Default	Default
TextPlain	Text (text/plain)
ApplicationJson	JSON (application/json)
ApplicationXml	XML (application/xml)
TextXml	XML (text/xml)
TextXmlUtf8	XML (text/xml;charset=UTF-8)
TextHtml	HTML (text/html)
ApplicationFormUrlencoded	Form (application/x-www-form-urlencoded)
ApplicationOctetStream	Binary (application/octet-stream)
Raw	Raw (No content-type)
MultiPartMixed	Multipart Mixed (multipart/mixed)
ApplicationGraphql	GraphQL (application/graphql)

TokenRequestData
(Setting of HttpConnection)

TokenRequestData

TokenRequestHeaders
(Setting of HttpConnection)

TokenRequestHeaders

TokenRequestIsMultiPart
(Setting of HttpConnection)

TokenRequestIsMultiPart

TokenRequestMethod
(Setting of HttpConnection)

TokenRequestMethod

TokenResponseContentFilter
(Setting of HttpConnection)

TokenResponseContentFilter

TokenResponseContentType
(Setting of HttpConnection)

TokenResponseContentType

Available Options

Option	Description
None	None
Json	Json
Xml	Xml
Regex	Regex

TokenResponseCookie
(Setting of HttpConnection)

TokenResponseCookie

TokenResponseHeader
(Setting of HttpConnection)

TokenResponseHeader

TokenResponseValueExtractMode
(Setting of HttpConnection)

TokenResponseValueExtractMode

Available Options

Option	Description
Body	Extract From Body
Header	Extract From Response Header
Cookie	Extract From Response Cookie

TokenUrl
(Setting of HttpConnection)

TokenUrl

Url
(Setting of HttpConnection)

Url

UserName
(Setting of HttpConnection)

UserName

UseThirdPartyWebRequest
(Setting of HttpConnection)

UseThirdPartyWebRequest

UseWebProxy
(Setting of HttpConnection)

UseWebProxy

CertificatePassword
(Setting of ClientCertificateInfo)

CertificatePassword

CertificatePath
(Setting of ClientCertificateInfo)

CertificatePath

DisplayPath
(Setting of ClientCertificateInfo)

DisplayPath

EnableCertificate
(Setting of ClientCertificateInfo)

EnableCertificate

IgnoreValidationErrors
(Setting of ClientCertificateInfo)

IgnoreValidationErrors

IsServiceAccount
(Setting of ClientCertificateInfo)

IsServiceAccount

StorageType
(Setting of ClientCertificateInfo)

StorageType

Available Options

Option	Description
NotSet	<Not set>
LocalMachine	Stored in LocalMachine Storage Area
CurrentUser	Stored in User Storage Area
PfxFile	Disk File - PFX (PKCS12) format

StoreName
(Setting of ClientCertificateInfo)

StoreName

Available Options

Option	Description
NotSet	<Not set>
AddressBook	AddressBook
AuthRoot	AuthRoot
CertificateAuthority	CertificateAuthority
Disallowed	Disallowed
My	My
Root	Root
TrustedPeople	TrustedPeople
TrustedPublisher	TrustedPublisher

Thumbprint
(Setting of ClientCertificateInfo)

Thumbprint

LogLevel
(Setting of ILogger)

LogLevel

Available Options

Option	Description
Normal	Normal
Summary	Summary
Detail	Detail
Debugging	Debugging
Disabled	Disabled

PrefixTimestamp
(Setting of ILogger)

PrefixTimestamp

DoNotUseDefaultProxy
(Setting of ProxyInfo)

DoNotUseDefaultProxy

EnableProxy
(Setting of ProxyInfo)

EnableProxy

ProxyAuthMode
(Setting of ProxyInfo)

ProxyAuthMode

Available Options

Option	Description
Basic	Basic
Ntlm	Ntlm
Digest	Digest

ProxyDomain
(Setting of ProxyInfo)

ProxyDomain

ProxyHost
(Setting of ProxyInfo)

ProxyHost

ProxyPassword
(Setting of ProxyInfo)

ProxyPassword

ProxyPort
(Setting of ProxyInfo)

ProxyPort

ProxyType
(Setting of ProxyInfo)

ProxyType

Available Options

Option	Description
None	None
Socks4	Socks4
Socks4a	Socks4a
Socks5	Socks5
HttpConnect	HttpConnect

ProxyUrl
(Setting of ProxyInfo)

ProxyUrl

ProxyUseCreds
(Setting of ProxyInfo)

ProxyUseCreds

ProxyUser
(Setting of ProxyInfo)

ProxyUser

MaxRetryCount
(Setting of RetryInfo)

MaxRetryCount

MessageListToHandle
(Setting of RetryInfo)

MessageListToHandle

MultiplyWaitTimeForEachAttempt
(Setting of RetryInfo)

MultiplyWaitTimeForEachAttempt

RetryMode
(Setting of RetryInfo)

RetryMode

Available Options

Option	Description
None	Do not retry
RetryAny	Retry any web errors
RetryWhenStatusCodeMatch	Retry for matching response status code(s)
RetryWhenMessageMatch	Retry errors for matching error sub string(s)

StatusCodeListToHandle
(Setting of RetryInfo)

StatusCodeListToHandle

WaitTimeMs
(Setting of RetryInfo)

WaitTimeMs

AccessToken
(Setting of OAuthConnection)

AccessToken

AccessTokenAttrName
(Setting of OAuthConnection)

AccessTokenAttrName

AccessTokenParamName
(Setting of OAuthConnection)

AccessTokenParamName

AccessTokenSecret
(Setting of OAuthConnection)

AccessTokenSecret

ApiCategory
(Setting of OAuthConnection)

ApiCategory

AppendAccessTokenToUrl
(Setting of OAuthConnection)

AppendAccessTokenToUrl

AppVer
(Setting of OAuthConnection)

AppVer

AuthorizeInFullBrowser
(Setting of OAuthConnection)

AuthorizeInFullBrowser

AuthScheme
(Setting of OAuthConnection)

AuthScheme

AuthUrl
(Setting of OAuthConnection)

AuthUrl

ClientId
(Setting of OAuthConnection)

ClientId

ClientSecret
(Setting of OAuthConnection)

ClientSecret

ConnectionString
(Setting of OAuthConnection)

ConnectionString

ConnectionStringFile
(Setting of OAuthConnection)

ConnectionStringFile

ConnectionStringFull
(Setting of OAuthConnection)

ConnectionStringFull

ConnectionStringNonDefaultsOnly
(Setting of OAuthConnection)

ConnectionStringNonDefaultsOnly

ConnectionStringNonDefaultsOnlyFull
(Setting of OAuthConnection)

ConnectionStringNonDefaultsOnlyFull

ContentType
(Setting of OAuthConnection)

ContentType

CustomAuthHeader
(Setting of OAuthConnection)

CustomAuthHeader

CustomTokenPrefix
(Setting of OAuthConnection)

CustomTokenPrefix

CustomWarningForFullMode
(Setting of OAuthConnection)

CustomWarningForFullMode

DefaultClientId
(Setting of OAuthConnection)

DefaultClientId

DefaultClientSecret
(Setting of OAuthConnection)

DefaultClientSecret

DisableCustomUrl
(Setting of OAuthConnection)

DisableCustomUrl

DisableSockProxySupport
(Setting of OAuthConnection)

DisableSockProxySupport

DisableTest
(Setting of OAuthConnection)

DisableTest

DisableThirdPartWebRequest
(Setting of OAuthConnection)

DisableThirdPartWebRequest

DoNotIncludeCredentialsInBody
(Setting of OAuthConnection)

DoNotIncludeCredentialsInBody

DoNotIncludeCredentialsInHeader
(Setting of OAuthConnection)

DoNotIncludeCredentialsInHeader

DoNotIncludeEmptyParamsInSignature
(Setting of OAuthConnection)

DoNotIncludeEmptyParamsInSignature

DoNotIncludeTokenInUrl
(Setting of OAuthConnection)

DoNotIncludeTokenInUrl

EnableCodeVerifier
(Setting of OAuthConnection)

EnableCodeVerifier

EnableOAuthOverUrl
(Setting of OAuthConnection)

EnableOAuthOverUrl

ExpiresAfterSec
(Setting of OAuthConnection)

ExpiresAfterSec

ExpiresInAttribute
(Setting of OAuthConnection)

ExpiresInAttribute

ExtraAttributesForAuthRequest
(Setting of OAuthConnection)

ExtraAttributesForAuthRequest

ExtraAttributesForTokenRequest
(Setting of OAuthConnection)

ExtraAttributesForTokenRequest

GrantType
(Setting of OAuthConnection)

GrantType

Available Options

Option	Description
Default	Default
AuthorizationCode	Authorization Code Grant (i.e. 3-Legged Auth)
Password	Password Grant
ClientCredentials	Client Credentials Grant

HasChangingRefreshTokenSupport
(Setting of OAuthConnection)

HasChangingRefreshTokenSupport

MetaBody
(Setting of OAuthConnection)

MetaBody

MetaContentType
(Setting of OAuthConnection)

MetaContentType

Available Options

Option	Description
None	None
Json	Json
Xml	Xml
Regex	Regex

MetaFields
(Setting of OAuthConnection)

MetaFields

MetaFilters
(Setting of OAuthConnection)

MetaFilters

MetaHeaders
(Setting of OAuthConnection)

MetaHeaders

MetaMethod
(Setting of OAuthConnection)

MetaMethod

MetaTemplate
(Setting of OAuthConnection)

MetaTemplate

MetaUrl
(Setting of OAuthConnection)

MetaUrl

NounceForTesting
(Setting of OAuthConnection)

NounceForTesting

OAuthVersion
(Setting of OAuthConnection)

OAuthVersion

Available Options

Option	Description
Default	Default
OAuth2	OAuth2
OAuth1	OAuth1

Password
(Setting of OAuthConnection)

Password

PreferProxyUrl
(Setting of OAuthConnection)

PreferProxyUrl

Prop1Name
(Setting of OAuthConnection)

Prop1Name

Prop1Value
(Setting of OAuthConnection)

Prop1Value

Prop2Name
(Setting of OAuthConnection)

Prop2Name

Prop2Value
(Setting of OAuthConnection)

Prop2Value

RefreshToken
(Setting of OAuthConnection)

RefreshToken

RefreshTokenFileContent
(Setting of OAuthConnection)

RefreshTokenFileContent

RefreshTokenFilePath
(Setting of OAuthConnection)

RefreshTokenFilePath

RenewBeforeSec
(Setting of OAuthConnection)

RenewBeforeSec

RequestTokenUrl
(Setting of OAuthConnection)

RequestTokenUrl

RetainSameConnection
(Setting of OAuthConnection)

RetainSameConnection

RetryCountMax
(Setting of OAuthConnection)

RetryCountMax

RetryMessageList
(Setting of OAuthConnection)

RetryMessageList

RetryMode
(Setting of OAuthConnection)

RetryMode

Available Options

Option	Description
None	Do not retry
RetryAny	Retry any web errors
RetryWhenStatusCodeMatch	Retry for matching response status code(s)
RetryWhenMessageMatch	Retry errors for matching error sub string(s)

RetryMultiplyWaitTime
(Setting of OAuthConnection)

RetryMultiplyWaitTime

RetryStatusCodeList
(Setting of OAuthConnection)

RetryStatusCodeList

RetryWaitTimeMs
(Setting of OAuthConnection)

RetryWaitTimeMs

ReturnUrl
(Setting of OAuthConnection)

ReturnUrl

Scope
(Setting of OAuthConnection)

Scope

ScopeSeparator
(Setting of OAuthConnection)

ScopeSeparator

ServiceProvider
(Setting of OAuthConnection)

ServiceProvider

Available Options

Option	Description
Custom	Custom
Google	Google API (Generic - Other than below)
GoogleAnalytics	Google Analytics
GoogleSheets	Google Sheets + Drive
GoogleBigQuery	Google BigQuery
GoogleAdWords	Google AdWords
GoogleDrive	Google Drive
Facebook	Facebook
Twitter	Twitter
LinkedIn	LinkedIn
Dropbox	Dropbox
Yahoo	Yahoo
Amazon	Amazon
AmazonMWS	Amazon Marketplace Web Service (MWS)
AmazonAWS	Amazon AWS API v4 (Amazon Web Services)
EbaySandbox	eBay - Sandbox API
EbayProduction	eBay - Production API
Tumblr	Tumblr
MicrosoftLive	MicrosoftLive
Assembla	Assembla
CodeProject	CodeProject
Foursquare	Foursquare
GitHub	GitHub
Instagram	Instagram
MailRu	MailRu
SoundCloud	SoundCloud
SourceForge	SourceForge
Vkontakte	Vkontakte
Yandex	Yandex
MailChimp	MailChimp
HubSpot	HubSpot
XeroPrivateApp	Xero (Private App)
Vsts	VSTS (Visual Studio Team Services - TFS Online

SignatureMethod
(Setting of OAuthConnection)

SignatureMethod

SslVersion
(Setting of OAuthConnection)

SslVersion

Available Options

Option	Description
Default	System Default
Ssl3	SSL v3.0
Ssl3Plus	SSL v3.0 or higher
Tls	TLS v1.0
TlsPlus	TLS v1.0 or higher
Tls11	TLS v1.1
Tls11Plus	TLS v1.1 or higher
Tls12	TLS v1.2
Tls12Plus	TLS v1.2 or higher
Tls13	TLS v1.3
Any	Any Version

SupportDualProxyMode
(Setting of OAuthConnection)

SupportDualProxyMode

Timeout
(Setting of OAuthConnection)

Timeout

TimestampForTesting
(Setting of OAuthConnection)

TimestampForTesting

TimestampOffset
(Setting of OAuthConnection)

TimestampOffset

TokenRefreshMode
(Setting of OAuthConnection)

TokenRefreshMode

Available Options

Option	Description
Default	Default
AutoRefresh	AutoRefresh
NoRefresh	NoRefresh

TokenUIMode
(Setting of OAuthConnection)

TokenUIMode

Available Options

Option	Description
Default	Default
None	None
OnlyRefreshToken	OnlyRefreshToken

TokenUrl
(Setting of OAuthConnection)

TokenUrl

UseCustomApp
(Setting of OAuthConnection)

UseCustomApp

UseLoopbackUrlForDefault
(Setting of OAuthConnection)

UseLoopbackUrlForDefault

UserName
(Setting of OAuthConnection)

UserName

UseThirdPartyWebRequest
(Setting of OAuthConnection)

UseThirdPartyWebRequest

UseWebProxy
(Setting of OAuthConnection)

UseWebProxy

Request Settings

DataConnectionType
(Setting of XmlConfigurationParams)

Authentication type

Specifies the type of authentication to use to access data.

Available Options

Option	Description
Default	Default
HTTP	HTTP
OAuth	OAuth

DataFormat
(Setting of XmlConfigurationParams)

Data format

Data format coming from HTTP Response. This is useful for example when you have OData service and you want to automatically consume all pages of data using odata.nextUrl. Setting DataFormat=Odata will automatically do it for you.

Available Options

Option	Description
Notset	Default
Original	Original
Odata	OData

DataPath
(Setting of XmlConfigurationParams)

Data Source (URL or File Path)

Data source URL or File Path (e.g. http://abc.com/api/get --or-- c:\data\cust01.json --or-- c:\data\cust*.json ). If data source is file then wildcard pattern can be also used to read multiple files (e.g. c:\data\cust*.json will read all files that match wildcard)

Filter
(Setting of XmlConfigurationParams)

Filter

Specifies expression to filter data. Usually this is Array path from which you like to get all records. Example: $.Customers[*] will get all customers from Customer Array from your document and $.Customers[*].Orders[*] will get all orders for all customers.

Status Check Settings (Polling)

EnableStatusCheck
(Setting of XmlConfigurationParams)

EnableStatusCheck

Enable status check loop. When this option is enabled web requests are tried every N seconds to check desired value in response. Once desired value is found response is returned. Error is returned if failure indicator found or timeout occurs (i.e. Max iteration reached and still no success value found in the response).

StatusCheckForFailedValue
(Setting of XmlConfigurationParams)

StatusCheckForFailedValue

Enable check to look for failure indicator. By default only SuccessValue is searched in response unless you set this option to true. Set StatusFailedValue to indicate failure regex / string pattern.

StatusCheckIterationWaitSeconds
(Setting of XmlConfigurationParams)

StatusCheckIterationWaitSeconds

Wait time between each iteration for status check

StatusCheckMaxWaitSeconds
(Setting of XmlConfigurationParams)

StatusCheckMaxWaitSeconds

Maximum wait time in seconds until we need to keep checking for success value or failure value indicator.

StatusFailedValue
(Setting of XmlConfigurationParams)

StatusFailedValue

Regex pattern or string value you like to search for Failure indicator (e.g. Cancelled|Aborted|Failed ). Set StatusCheckForFailedValue=true to use this value.

StatusFieldFilterExpr
(Setting of XmlConfigurationParams)

StatusFieldFilterExpr

StatusFieldFilterType
(Setting of XmlConfigurationParams)

StatusFieldFilterType

Available Options

Option	Description
None	None
Json	Json
Xml	Xml
Regex	Regex

StatusSuccessValue
(Setting of XmlConfigurationParams)

StatusSuccessValue

Regex pattern or string value you like to search for Success indicator (e.g. Done|Success|Ok )