Autotask API Data Model
Autotask SQL Driver Attributes |
The SQL driver for Autotask has many attributes that can be finetuned to improve handling in scenarios with unreliable network connections to the API server of Autotask or high volumes of data. Also, many drivers have driver-specific attributes to finetune actual behaviour or handle data not matching specifications.
The Autotask driver attributes are assigned a default value which seldom requires change. However, changes can be applied when needed on four levels, which are reflected in the table below by separate checkmarks:
•Connection string: the connection string from the settings*.xml file and applied during log on.
•Set SQL statement: a set SQL-statement to be executed once connection has been established.
•Log on: value to be specified interactively by user during log on in a user interface.
The connection string for Autotask can be found in the settings*.xml file used for the database. The reference manuals contain instructions how to relocate the settings*.xml files. Settings*.xml files are typically located in the %USERPROFILE%\invantive folder in most deployment scenarios. Each data container of a database in the connection string can have a connectionString element specifying the name and values of attributes. Both name and value must be properly escaped according to XML-semantics. Actual application of the value is solely done during log on. A new connection must be established to change the value of a driver attribute using a connection string.
The set SQL statement can be executed after log on. The syntax is: set NAME VALUE, or for a distributed database: set NAME@ALIAS VALUE. In some scenarios you may need to enclose the driver attribute name in square brackets to escape it from parsing, for instance when a reserved SQL keyword is part of the name. The new value takes effect straight after execution of the set-statement. The set-statement can be executed as often as needed during a session.
Driver attributes that can be interactively set to a value are typically presented in the log on window. Depending on the platform and design decisions of the user interface designer, some or all of the available driver attributes can have been made available.
The Autotask driver can be configured using the following attributes:
Code |
Description |
Origin |
Default Value |
Set from Connection String |
Set from Set SQL-Statement |
Set from Drivers File |
Set from Log On |
|---|---|---|---|---|---|---|---|
add-odata-mandatory-filters |
Whether to automatically add OData filters deemed necessary by the platform. |
OData |
False |
✓ |
✓ |
✓ |
|
analysis-enforce-row-uniqueness |
Enforce rows to be unique for software analysis. A fingerprint is calculated from the whole row of data when the primary key column is unknown. |
Shared |
False |
✓ |
✓ |
✓ |
|
api-access-token |
Access Token is a security token for multiple OAuth2 Flows. With an Access Token you can access protected resources. An Access Token must be stored securely since once compromised allows access to your protected resources. |
OData |
|
✓ |
✓ |
✓ |
✓ |
api-client-id |
The client ID is a unique identifier of your application. It is generated by registering an application. |
OData |
|
✓ |
|
✓ |
✓ |
api-client-secret |
The client secret is to be kept confidential. Such as a password for a logon code, the client secret is the confidential part of an app identified by a client ID. It is needed during the OAuth2 Code Grant Flow together with the refresh token to get access. |
OData |
|
✓ |
|
✓ |
✓ |
api-integration-code |
The integration code uniquely identifies the Autotask application and vendor. |
Autotask |
|
✓ |
|
✓ |
✓ |
api-pre-expiry-refresh-sec |
The number of seconds before the token expires to acquire a new token. |
OData |
|
✓ |
✓ |
✓ |
|
api-redirect-url |
The redirect URI is the website a browser session is redirected to after the OAuth2 authentication process has been completed. |
OData |
|
✓ |
|
✓ |
✓ |
api-refresh-token |
Refresh Token is a security token for the OAuth2 Code Grant Flow. With a Refresh Token and client secret you can retrieve a renewed access token to access protected resources. A Refresh Token and client secret must be stored securely since once compromised allows access to your protected resources. |
OData |
|
✓ |
|
✓ |
✓ |
api-scope |
The authorization scope(s) to request an OAuth token for. |
OData |
|
✓ |
|
✓ |
|
api-token-url |
The token URI is the OAuth2 endpoint to exchange tokens with. |
OData |
|
✓ |
|
✓ |
|
api-url |
URL of web service. |
OData |
|
✓ |
|
✓ |
|
bulk-delete-page-size-rows |
Number of rows to delete per batch when bulk deleting. |
Shared |
10000 |
✓ |
✓ |
✓ |
|
bulk-insert-page-size-bytes |
Approximate maximum size in bytes of batch when bulk inserting. |
Shared |
10000000 |
✓ |
✓ |
✓ |
|
bulk-insert-page-size-rows |
Number of rows to insert per batch when bulk inserting. |
Shared |
250 |
✓ |
✓ |
✓ |
|
download-error-400-bad-request-max-tries |
Maximum number of tries when HTTP server reports bad format during retrieval of data. |
|
3 |
✓ |
✓ |
✓ |
|
download-error-400-bad-request-sleep-initial-ms |
Initial sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data. |
|
500 |
✓ |
✓ |
✓ |
|
download-error-400-bad-request-sleep-max-ms |
Maximum sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data. |
|
5000 |
✓ |
✓ |
✓ |
|
download-error-400-bad-request-sleep-multiplicator |
Multiplication factor for sleep between retries HTTP server reports that the API server is unavailable during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-408-request-timeout-max-tries |
Maximum number of tries when the website reports a HTTP status 408. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-408-request-timeout-sleep-initial-ms |
Initial sleep in milliseconds between retries when the website reports a HTTP status 408. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-408-request-timeout-sleep-max-ms |
Maximum sleep in milliseconds between retries when the website reports a HTTP status 408. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-408-request-timeout-sleep-multiplicator |
Multiplication factor for sleep between retries when the website reports a HTTP status 408. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-422-bad-request-max-tries |
Maximum number of tries when HTTP server reports unprocessable entity during retrieval of data. |
|
30 |
✓ |
✓ |
✓ |
|
download-error-422-bad-request-sleep-initial-ms |
Initial sleep in milliseconds between retries when HTTP server reports unprocessable entity during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-422-bad-request-sleep-max-ms |
Maximum sleep in milliseconds between retries when HTTP server reports unprocessable entity during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-422-bad-request-sleep-multiplicator |
Multiplication factor for sleep between retries HTTP server reports unprocessable entity during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-429-too-many-requests-max-tries |
Maximum number of tries when the website reports that too many requests have been made during a timeslot of one minute or one day. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-429-too-many-requests-sleep-initial-ms |
Initial sleep in milliseconds between retries when the website reports that too many requests have been made during a timeslot of one minute or one day. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-429-too-many-requests-sleep-max-ms |
Maximum sleep in milliseconds between retries when the website reports that too many requests have been made during a timeslot of one minute or one day. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-429-too-many-requests-sleep-multiplicator |
Multiplication factor for sleep between retries when the website reports that too many requests have been made during a timeslot of one minute or one day. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-500-internal-server-error-max-tries |
itgen_pae_download_error_500_internal_server_error_max_tries |
|
10 |
✓ |
✓ |
✓ |
|
download-error-500-internal-server-error-sleep-initial-ms |
itgen_pae_download_error_500_internal_server_error_sleep_initial_ms |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-500-internal-server-error-sleep-max-ms |
itgen_pae_download_error_500_internal_server_error_sleep_max_ms |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-500-internal-server-error-sleep-multiplicator |
itgen_pae_download_error_500_internal_server_error_sleep_multiplicator |
|
2 |
✓ |
✓ |
✓ |
|
download-error-502-server-unavailable-max-tries |
Maximum number of tries when HTTP server reports a bad gateway during retrieval of data. |
|
30 |
✓ |
✓ |
✓ |
|
download-error-502-server-unavailable-sleep-initial-ms |
Initial sleep in milliseconds between retries when HTTP server reports a bad gateway during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-502-server-unavailable-sleep-max-ms |
Maximum sleep in milliseconds between retries when HTTP server reports that a bad gateway during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-502-server-unavailable-sleep-multiplicator |
Multiplication factor for sleep between retries HTTP server reports a bad gateway during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-503-server-unavailable-max-tries |
Maximum number of tries when HTTP server reports that the API server is unavailable during retrieval of data. |
|
30 |
✓ |
✓ |
✓ |
|
download-error-503-server-unavailable-sleep-initial-ms |
Initial sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-503-server-unavailable-sleep-max-ms |
Maximum sleep in milliseconds between retries when HTTP server reports that the API server is unavailable during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-503-server-unavailable-sleep-multiplicator |
Multiplication factor for sleep between retries HTTP server reports that the API server is unavailable during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-504-gateway-timeout-max-tries |
Maximum number of tries when the website reports a gateway timeout. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-504-gateway-timeout-sleep-initial-ms |
Initial sleep in milliseconds between retries when the website reports a gateway timeout. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-504-gateway-timeout-sleep-max-ms |
Maximum sleep in milliseconds between retries when the website reports a gateway timeout. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-504-gateway-timeout-sleep-multiplicator |
Multiplication factor for sleep between retries when the website reports a gateway timeout. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-590-network-connect-timeout-max-tries |
Maximum number of tries when the website reports a HTTP status 590. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-590-network-connect-timeout-sleep-initial-ms |
Initial sleep in milliseconds between retries when the website reports a HTTP status 590. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-590-network-connect-timeout-sleep-max-ms |
Maximum sleep in milliseconds between retries when the website reports a HTTP status 590. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-590-network-connect-timeout-sleep-multiplicator |
Multiplication factor for sleep between retries when the website reports a HTTP status 590. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-599-network-connect-timeout-max-tries |
Maximum number of tries when the website reports a HTTP status 599. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-599-network-connect-timeout-sleep-initial-ms |
Initial sleep in milliseconds between retries when the website reports a HTTP status 599. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-599-network-connect-timeout-sleep-max-ms |
Maximum sleep in milliseconds between retries when the website reports a HTTP status 599. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-599-network-connect-timeout-sleep-multiplicator |
Multiplication factor for sleep between retries when the website reports a HTTP status 599. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-argument-exception-max-tries |
Maximum number of tries when an argument exception is returned when downloading a blob. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-argument-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when an argument exception is returned when downloading a blob. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-argument-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when an argument exception is returned when downloading a blob. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-argument-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when an argument exception is returned when downloading a blob. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-internet-down-max-tries |
Maximum number of tries when the Internet connection seems down during retrieval of data. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-internet-down-sleep-initial-ms |
Initial sleep in milliseconds between retries when the Internet connection seems down during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-internet-down-sleep-max-ms |
Maximum sleep in milliseconds between retries when the Internet connection seems down during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-internet-down-sleep-multiplicator |
Multiplication factor for sleep between retries when the Internet connection seems down during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-io-exception-max-tries |
Maximum number of tries when a network I/O connection failure occurs during retrieval of data. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-io-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when a network I/O connection failure occurs during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-io-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when a network I/O connection failure occurs during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-io-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when a network I/O connection failure occurs during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-json-exception-max-tries |
Maximum number of tries when an invalid JSON body is returned. |
|
3 |
✓ |
✓ |
✓ |
|
download-error-json-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when an invalid JSON body is returned. |
|
1000 |
✓ |
✓ |
✓ |
|
download-error-json-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when an invalid JSON body is returned. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-json-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when an invalid JSON body is returned. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-name-resolution-failure-max-tries |
Maximum number of tries when the host name could not be resolved during retrieval of data. |
|
5 |
✓ |
✓ |
✓ |
|
download-error-name-resolution-failure-sleep-initial-ms |
Initial sleep in milliseconds between retries when the host name could not be resolved during retrieval of data. |
|
5000 |
✓ |
✓ |
✓ |
|
download-error-name-resolution-failure-sleep-max-ms |
Maximum sleep in milliseconds between retries when the host name could not be resolved during retrieval of data. |
|
5000 |
✓ |
✓ |
✓ |
|
download-error-name-resolution-failure-sleep-multiplicator |
itgen_pae_download_error_iname_resolution_failure_sleep_multiplicator |
|
1 |
✓ |
✓ |
✓ |
|
download-error-other-exception-max-tries |
Maximum number of tries when an unqualified error occurs during retrieval of data. |
|
3 |
✓ |
✓ |
✓ |
|
download-error-other-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-other-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-other-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when an unqualified error ocurrs during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-socket-exception-max-tries |
Maximum number of tries when the network connection is forcible dropped during retrieval of data. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-socket-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when the network connection is forcible dropped during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-socket-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when the network connection is forcible dropped during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-socket-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when the network connection is forcible dropped during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-web-exception-max-tries |
Maximum number of tries when a web connection failure occurs during retrieval of data. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-web-exception-sleep-initial-ms |
Initial sleep in milliseconds between retries when a web connection failure occurs during retrieval of data. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-web-exception-sleep-max-ms |
Maximum sleep in milliseconds between retries when a web connection failure occurs during retrieval of data. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-web-exception-sleep-multiplicator |
Multiplication factor for sleep between retries when a web connection failure occurs during retrieval of data. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-web-not-found-max-tries |
itgen_pae_download_error_web_not_found_max_tries |
|
1 |
✓ |
✓ |
✓ |
|
download-error-web-not-found-sleep-initial-ms |
itgen_pae_download_error_web_not_found_sleep_initial_ms |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-web-not-found-sleep-max-ms |
itgen_pae_download_error_web_not_found_sleep_max_ms |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-web-not-found-sleep-multiplicator |
itgen_pae_download_error_web_not_found_sleep_multiplicator |
|
2 |
✓ |
✓ |
✓ |
|
download-error-web-not-implemented-max-tries |
Maximum number of tries when the connection reports not implemented. |
|
1 |
✓ |
✓ |
✓ |
|
download-error-web-not-implemented-sleep-initial-ms |
Initial sleep in milliseconds between retries when the connection reports not implemented. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-web-not-implemented-sleep-max-ms |
Maximum sleep in milliseconds between retries when the connection reports not implemented. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-web-not-implemented-sleep-multiplicator |
Multiplication factor for sleep between retries when the connection reports not implemented. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-web-timeout-max-tries |
Maximum number of tries when the connection reports a timeout. |
|
10 |
✓ |
✓ |
✓ |
|
download-error-web-timeout-sleep-initial-ms |
Initial sleep in milliseconds between retries when the connection reports a timeout. |
|
1000 |
✓ |
✓ |
✓ |
|
download-error-web-timeout-sleep-max-ms |
Maximum sleep in milliseconds between retries when the connection reports a timeout. |
|
30000 |
✓ |
✓ |
✓ |
|
download-error-web-timeout-sleep-multiplicator |
Multiplication factor for sleep between retries when the connection reports a timeout. |
|
2 |
✓ |
✓ |
✓ |
|
download-error-web-unauthorized-max-tries |
Maximum number of tries when the connection reports an unauthorized error. |
|
1 |
✓ |
✓ |
✓ |
|
download-error-web-unauthorized-sleep-initial-ms |
Initial sleep in milliseconds between retries when the connection reports an unauthorized error. |
|
10000 |
✓ |
✓ |
✓ |
|
download-error-web-unauthorized-sleep-max-ms |
Maximum sleep in milliseconds between retries when the connection reports an unauthorized error. |
|
300000 |
✓ |
✓ |
✓ |
|
download-error-web-unauthorized-sleep-multiplicator |
Multiplication factor for sleep between retries when the connection reports an unauthorized error. |
|
2 |
✓ |
✓ |
✓ |
|
duplicate-row-mode |
Configure behaviour when multiple rows are discovered during a limited search based upon a fingerprint generated from the primary key value, or all column values when no primary key is known.. The following values can be used: "error" to raise error on duplicate fingerprint values in an API-page of rows, "keep" to ignore duplicate fingerprint values silently, "skip" like "keep" but with logging to trace of duplicate values or "null" for default behaviour (typically "error").. |
|
|
✓ |
✓ |
✓ |
✓ |
force-case-sensitive-identifiers |
Consider identifiers as case-sensitive independent of the platform capabilities. |
Shared |
False |
✓ |
✓ |
✓ |
|
forced-casing-identifiers |
Forced casing of identifiers. Choose from: Unset, Lower, Upper and Mixed. |
Shared |
|
✓ |
✓ |
✓ |
|
http-disk-cache-compression-level |
Compression level for the HTTP disk cache, ranging from 1 (little) to 9 (intense). Default is 5. |
Shared |
5 |
✓ |
✓ |
✓ |
|
http-disk-cache-directory |
Directory where HTTP cache is stored. |
Shared |
C:\Users\guido\Invantive\Cache\http\guido\shared |
✓ |
✓ |
✓ |
|
http-disk-cache-ignore-write-errors |
Whether to ignore write errors to disk cache. |
Shared |
False |
✓ |
✓ |
✓ |
|
http-disk-cache-max-age-sec |
Maximum acceptable age in seconds for use of data in the HTTP disk cache. |
Shared |
2592000 |
✓ |
✓ |
✓ |
|
http-get-timeout-max-ms |
HTTP GET maximum timeout on retry (ms). |
|
24000 |
✓ |
✓ |
✓ |
|
http-get-timeout-ms |
HTTP GET timeout (ms). |
|
298000 |
✓ |
✓ |
✓ |
|
http-memory-cache-compression-level |
Compression level for the HTTP memory cache, ranging from 1 (little) to 9 (intense). Default is 5. |
OData |
5 |
✓ |
✓ |
✓ |
|
http-memory-cache-max-age-sec |
Maximum acceptable age in seconds for use of data in the HTTP memory cache. |
OData |
14400 |
✓ |
✓ |
✓ |
|
http-post-timeout-max-ms |
HTTP POST maximum timeout on retry (ms). |
|
58000 |
✓ |
✓ |
✓ |
|
http-post-timeout-ms |
HTTP POST timeout (ms). |
|
57000 |
✓ |
✓ |
✓ |
|
ignore-http-400-errors |
Ignore HTTP 400 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-401-errors |
Ignore HTTP 401 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-402-errors |
Ignore HTTP 402 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-403-errors |
Ignore HTTP 403 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-404-errors |
Ignore HTTP 404 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-422-errors |
Ignore HTTP 422 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-429-errors |
Ignore HTTP 429 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-500-errors |
Ignore HTTP 500 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-502-errors |
Ignore HTTP 502 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-http-503-errors |
Ignore HTTP 503 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
ignore-unknown-path-type |
Whether to ignore path types not yet supported. An error will be generated when an unsupported type occurs. |
|
True |
✓ |
✓ |
✓ |
✓ |
ignore-values-unknown-path |
Whether to ignore values outside of processed paths. An error will be generated when a value occurs outside a path otherwise. |
|
True |
✓ |
✓ |
✓ |
✓ |
invalid-json-on-get-max-tries |
Maximum number of tries when the JSON received on GET is invalid. |
|
1 |
✓ |
✓ |
✓ |
|
invalid-json-on-get-sleep-initial-ms |
Initial sleep in milliseconds between retries when the JSON received on GET is invalid. |
|
1000 |
✓ |
✓ |
✓ |
|
invalid-json-on-get-sleep-max-ms |
Maximum sleep in milliseconds between retries when the JSON received on GET is invalid. |
|
10000 |
✓ |
✓ |
✓ |
|
invalid-json-on-get-sleep-multiplicator |
Multiplication factor for sleep between retries when the JSON received on GET is invalid. |
|
2 |
✓ |
✓ |
✓ |
|
invalid-json-on-post-max-tries |
Maximum number of tries when the JSON received on POST is invalid. |
|
1 |
✓ |
✓ |
✓ |
|
invalid-json-on-post-sleep-initial-ms |
Initial sleep in milliseconds between retries when the JSON received on POST is invalid. |
|
1000 |
✓ |
✓ |
✓ |
|
invalid-json-on-post-sleep-max-ms |
Maximum sleep in milliseconds between retries when the JSON received on POST is invalid. |
|
10000 |
✓ |
✓ |
✓ |
|
invalid-json-on-post-sleep-multiplicator |
Multiplication factor for sleep between retries when the JSON received on POST is invalid. |
|
2 |
✓ |
✓ |
✓ |
|
invantive-sql-compress-sparse-arrays |
Whether to compress sparse arrays in result sets during compression. |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
invantive-sql-correct-invalid-date |
Whether to correct dates considered invalid since they are before 01-01-1753. When nullable, they are removed. Otherwise they are replaced by 01-01-1753. |
SQL Engine V1 |
False |
✓ |
✓ |
✓ |
|
invantive-sql-execution-profile-disk-path |
itgen_pae_invantive_sql_execution_profile_disk_path |
SQL Engine V1 |
c:\temp\profiles |
✓ |
✓ |
✓ |
|
invantive-sql-execution-profile-to-disk |
itgen_pae_invantive_sql_execution_profile_to_disk |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
invantive-sql-forward-filters-to-data-containers |
Whether to forward filters to data containers. |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
invantive-sql-share-byte-arrays |
Whether to share the memory used by identical byte arrays in result sets during compression. |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
invantive-sql-share-strings |
Whether to share the memory used by identical strings in result sets during compression. |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
invantive-sql-shuffle-fetch-results-data-containers |
Whether to shuffle results fetched from data containers. |
SQL Engine V1 |
False |
✓ |
✓ |
✓ |
|
invantive-use-cache |
Whether to cache the results of a query. |
SQL Engine V1 |
True |
✓ |
✓ |
✓ |
|
join-set-points-per-request |
Maximum number of values in a request when executing a join set. |
OData |
60 |
✓ |
✓ |
✓ |
|
limit-partition-calls-left |
Minimum number of remaining API calls on a partition towards a hard limit. When below, an error is raised. |
OData |
500 |
✓ |
✓ |
✓ |
|
log-native-calls-to-disk-max-events |
Maximum number of call events to register from last activation. |
Shared |
|
✓ |
✓ |
✓ |
|
log-native-calls-to-disk-max-seconds |
Maximum number of seconds to register calls from last activation. |
Shared |
|
✓ |
✓ |
✓ |
|
log-native-calls-to-disk-on-error |
Registers native calls to data container backend as disk files when the call raised an error. |
Shared |
False |
✓ |
✓ |
✓ |
|
log-native-calls-to-disk-on-success |
Registers native calls to data container backend as disk files when the call raised no error. |
Shared |
False |
✓ |
✓ |
✓ |
|
log-native-calls-to-trace |
Log native calls to data container backend on the trace. |
Shared |
False |
✓ |
✓ |
✓ |
|
max-odata-filters |
Maximum number of OData filter elements. |
OData |
100 |
✓ |
✓ |
✓ |
|
max-url-length-accepted |
The maximum accepted URL length before raising an error. |
Shared |
8000 |
✓ |
✓ |
✓ |
|
max-url-length-desired |
The maximum desired URL length. |
Shared |
8000 |
✓ |
✓ |
✓ |
|
maximum-discovered-column-count |
Maximum number of discovered columns. An error will be generated when the column exceeds this value. |
|
250 |
✓ |
✓ |
✓ |
✓ |
maximum-length-identifiers |
Non-default maximum length in characters of identifier names. |
Shared |
|
✓ |
✓ |
✓ |
|
maximum-url-length |
Maximum URL Length |
|
|
✓ |
✓ |
✓ |
|
metadata-cache-max-age-sec |
Maximum acceptable age in seconds for re-use of metadata. |
OData |
|
✓ |
✓ |
✓ |
|
oauth-unauthorized-max-tries |
Maximum number of tries when an OAuth exception occurs. |
OData |
2 |
✓ |
✓ |
✓ |
|
oauth-unauthorized-sleep-initial-ms |
Initial sleep in milliseconds between OAuth reauthentication tries when the OAuth authentication fails. |
OData |
10000 |
✓ |
✓ |
✓ |
|
oauth-unauthorized-sleep-max-ms |
Maximum sleep in milliseconds between OAuth reauthentication tries when the OAuth authentication fails. |
OData |
1000 |
✓ |
✓ |
✓ |
|
oauth-unauthorized-sleep-multiplicator |
Multiplication factor for sleep between OAuth reauthentication tries when the OAuth authentication fails. |
OData |
2 |
✓ |
✓ |
✓ |
|
partition-slot-based-rate-limit-length-ms |
Total length in milliseconds across all slots of a partition-based rate limit. |
Shared |
60000 |
✓ |
|
✓ |
|
partition-slot-based-rate-limit-slots |
Number of slots per partition-based rate limit. Null means no slot-based rate limit. |
Shared |
|
✓ |
|
✓ |
|
pre-request-delay-ms |
Pre-request delay in milliseconds per request. |
Shared |
0 |
✓ |
✓ |
✓ |
|
requested-page-size |
Preferred number of rows to exchange per round trip; only effective on limited platforms such as AFAS Online. |
Shared |
|
✓ |
✓ |
✓ |
|
requests-parallel-max |
Maximum number of parallel data requests from individual partitions on the data container. |
Shared |
32 |
✓ |
✓ |
✓ |
|
simulate-http-400-errors-percentage |
Percentage of simulated HTTP 400 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-400-errors |
Simulate HTTP 400 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-401-errors-percentage |
Percentage of simulated HTTP 401 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-401-errors |
Simulate HTTP 401 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-403-errors-percentage |
Percentage of simulated HTTP 403 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-403-errors |
Simulate HTTP 403 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-408-errors-percentage |
Percentage of simulated HTTP 408 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-408-errors |
Simulate HTTP 408 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-429-errors-percentage |
Percentage of simulated HTTP 429 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-429-errors |
Simulate HTTP 429 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-500-errors-percentage |
Percentage of simulated HTTP 500 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-500-errors |
Simulate HTTP 500 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-502-errors-percentage |
Percentage of simulated HTTP 502 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-502-errors |
Simulate HTTP 502 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-503-errors-percentage |
Percentage of simulated HTTP 503 errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-503-errors |
Simulate HTTP 503 errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-504-errors-percentage |
itgen_pae_simulate_http_504_errors_percentage |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-504-errors |
itgen_pae_simulate_http_504_errors |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-522-errors-percentage |
itgen_pae_simulate_http_522_errors_percentage |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-522-errors |
itgen_pae_simulate_http_522_errors |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-524-errors-percentage |
itgen_pae_simulate_http_524_errors_percentage |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-524-errors |
itgen_pae_simulate_http_524_errors |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-protocol-errors-percentage |
Percentage of simulated HTTP protocol errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-protocol-errors |
Simulate HTTP protocol errors when exchanging results with the HTTP endpoint. |
|
False |
✓ |
✓ |
✓ |
|
simulate-http-timeout-errors-percentage |
Percentage of simulated HTTP timeout errors when exchanging results with the HTTP endpoint. |
|
0 |
✓ |
✓ |
✓ |
|
simulate-http-timeout-errors |
Simulate HTTP timeout errors when exchanging results with the HTTP endpoint.. |
|
False |
✓ |
✓ |
✓ |
|
slot-based-rate-limit-length-ms |
Total length in milliseconds across all slots of a slot-based rate limit. |
Shared |
3600000 |
✓ |
|
✓ |
|
slot-based-rate-limit-slots |
Number of slots of a slot-based rate limit. Null means no slot-based rate limit. |
Shared |
10000 |
✓ |
|
✓ |
|
standardize-identifiers-casing |
Rewrite all identifiers to the recommended standard platform-specific casing when changing a data model on a case-dependent platform. |
Shared |
True |
✓ |
✓ |
✓ |
|
standardize-identifiers |
Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers. |
Shared |
True |
✓ |
✓ |
✓ |
|
swagger-specification-download-tries |
Specification Download Tries |
|
5 |
✓ |
✓ |
✓ |
|
swagger-specification-file |
The Swagger file path, such as C:\temp\swagger.json. |
|
|
✓ |
✓ |
✓ |
✓ |
swagger-specification-http-disk-cache-max-age-sec |
Maximum acceptable age in seconds for use of Swagger specification data in the HTTP disk cache. |
|
86400 |
✓ |
✓ |
✓ |
|
swagger-specification-url |
The Swagger URL such as https://example.org/rest/swagger.json. |
|
|
✓ |
✓ |
✓ |
✓ |
use-batch-insert |
Whether to use batch insert. |
OData |
True |
✓ |
✓ |
✓ |
|
use-http-disk-cache-read |
Whether to use HTTP responses from previous queries stored on disk to answer the current query. |
Shared |
False |
✓ |
✓ |
✓ |
|
use-http-disk-cache-write |
Whether to memorize HTTP responses on disk. |
Shared |
False |
✓ |
✓ |
✓ |
|
use-http-memory-cache-read |
Whether to use HTTP responses from previous queries stored in memory that can answer the current query. |
OData |
True |
✓ |
✓ |
✓ |
|
use-http-memory-cache-write |
Whether to memorize HTTP responses from previous queries for use by future queries. |
OData |
True |
✓ |
✓ |
✓ |
|
10-06-2024 18:39 Version 24.1.3-BETA+4689
