Please enable JavaScript to view this site.

Visma.net Financials API Data Model

Navigation: » No topics above this level «

Visma.net Financials SQL Driver Attributes

Contents Previous Home Next More

The SQL driver for Visma.net Financials has many attributes that can be finetuned to improve handling in scenarios with unreliable network connections to the API server of Visma.net Financials or high-volumes of data. Also, many drivers have driver-specific attributes to finetune actual behaviour or handle data not matching specifications.

The Visma.net Financials 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.

Drivers file: the providers.xml file (obsolete starting release 17.32).

Log on: value to be specified interactively by user during log on in a user interface.

The connection string for Visma.net Financials can be found in the settings*.xml file used for the database. Settings*.xml files are typically located in the %USERPROFILE%\invantive folder in most deployment scenarios. The reference manuals contain instructions how to relocate the settings*.xml files. 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 Visma.net Financials 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

analysis-enforce-row-uniqueness

Use for analysis only! Enforce rows to be unique.

Shared

False

 

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-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 scope to request an OAuth token for.

OData

 

 

 

api-token-url

The token URI is the OAuth2 endpoint to exchange tokens.

OData

 

 

 

api-url

URL to access the API.

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 OData server reports bad format during retrieval of data.

OData

30

 

download-error-400-bad-request-sleep-initial-ms

Initial sleep in milliseconds between retries when OData server reports that the API server is unavailable during retrieval of data.

OData

10000

 

download-error-400-bad-request-sleep-max-ms

Maximum sleep in milliseconds between retries when OData server reports that the API server is unavailable during retrieval of data.

OData

300000

 

download-error-400-bad-request-sleep-multiplicator

Multiplication factor for sleep between retries OData server reports that the API server is unavailable during retrieval of data.

OData

2

 

download-error-422-bad-request-max-tries

Maximum number of tries when OData server reports unprocessable entity during retrieval of data.

OData

30

 

download-error-422-bad-request-sleep-initial-ms

Initial sleep in milliseconds between retries when OData server reports unprocessable entity during retrieval of data.

OData

10000

 

download-error-422-bad-request-sleep-max-ms

Maximum sleep in milliseconds between retries when OData server reports unprocessable entity during retrieval of data.

OData

300000

 

download-error-422-bad-request-sleep-multiplicator

Multiplication factor for sleep between retries OData server reports unprocessable entity during retrieval of data.

OData

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.

OData

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.

OData

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.

OData

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.

OData

2

 

download-error-502-server-unavailable-max-tries

Maximum number of tries when OData server reports a bad gateway during retrieval of data.

OData

30

 

download-error-502-server-unavailable-sleep-initial-ms

Initial sleep in milliseconds between retries when OData server reports a bad gateway during retrieval of data.

OData

10000

 

download-error-502-server-unavailable-sleep-max-ms

Maximum sleep in milliseconds between retries when OData server reports that a bad gateway during retrieval of data.

OData

300000

 

download-error-502-server-unavailable-sleep-multiplicator

Multiplication factor for sleep between retries OData server reports a bad gateway during retrieval of data.

OData

2

 

download-error-503-server-unavailable-max-tries

Maximum number of tries when OData server reports that the API server is unavailable during retrieval of data.

OData

30

 

download-error-503-server-unavailable-sleep-initial-ms

Initial sleep in milliseconds between retries when OData server reports that the API server is unavailable during retrieval of data.

OData

10000

 

download-error-503-server-unavailable-sleep-max-ms

Maximum sleep in milliseconds between retries when OData server reports that the API server is unavailable during retrieval of data.

OData

300000

 

download-error-503-server-unavailable-sleep-multiplicator

Multiplication factor for sleep between retries OData server reports that the API server is unavailable during retrieval of data.

OData

2

 

download-error-504-gateway-timeout-max-tries

Maximum number of tries when the website reports a gateway timeout.

OData

10

 

download-error-504-gateway-timeout-sleep-initial-ms

Initial sleep in milliseconds between retries when the website reports a gateway timeout.

OData

10000

 

download-error-504-gateway-timeout-sleep-max-ms

Maximum sleep in milliseconds between retries when the website reports a gateway timeout.

OData

300000

 

download-error-504-gateway-timeout-sleep-multiplicator

Multiplication factor for sleep between retries when the website reports a gateway timeout.

OData

2

 

download-error-argument-exception-max-tries

Maximum number of tries when an argument exception is returned when downloading a blob.

OData

10

 

download-error-argument-exception-sleep-initial-ms

Initial sleep in milliseconds between retries when an argument exception is returned when downloading a blob.

OData

10000

 

download-error-argument-exception-sleep-max-ms

Maximum sleep in milliseconds between retries when an argument exception is returned when downloading a blob.

OData

300000

 

download-error-argument-exception-sleep-multiplicator

Multiplication factor for sleep between retries when an argument exception is returned when downloading a blob.

OData

2

 

download-error-internet-down-max-tries

Maximum number of tries when the Internet connection seems down during retrieval of data.

OData

10

 

download-error-internet-down-sleep-initial-ms

Initial sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.

OData

10000

 

download-error-internet-down-sleep-max-ms

Maximum sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.

OData

300000

 

download-error-internet-down-sleep-multiplicator

Multiplication factor for sleep between retries when the Internet connection seems down during retrieval of data.

OData

2

 

download-error-io-exception-max-tries

Maximum number of tries when a network I/O connection failure occurs during retrieval of data.

OData

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.

OData

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.

OData

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.

OData

2

 

download-error-json-exception-max-tries

Maximum number of tries when an invalid JSON body is returned.

OData

3

 

download-error-json-exception-sleep-initial-ms

Initial sleep in milliseconds between retries when an invalid JSON body is returned.

OData

1000

 

download-error-json-exception-sleep-max-ms

Maximum sleep in milliseconds between retries when an invalid JSON body is returned.

OData

10000

 

download-error-json-exception-sleep-multiplicator

Multiplication factor for sleep between retries when an invalid JSON body is returned.

OData

2

 

download-error-other-exception-max-tries

Maximum number of tries when an unqualified error occurs during retrieval of data.

OData

3

 

download-error-other-exception-sleep-initial-ms

Initial sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data.

OData

10000

 

download-error-other-exception-sleep-max-ms

Maximum sleep in milliseconds between retries when an unqualified error ocurrs during retrieval of data.

OData

300000

 

download-error-other-exception-sleep-multiplicator

Multiplication factor for sleep between retries when an unqualified error ocurrs during retrieval of data.

OData

2

 

download-error-socket-exception-max-tries

Maximum number of tries when the network connection is forcible dropped during retrieval of data.

OData

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.

OData

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.

OData

300000

 

download-error-socket-exception-sleep-multiplicator

Multiplication factor for sleep between retries when the network connection is forcible dropped during retrieval of data.

OData

2

 

download-error-web-exception-max-tries

Maximum number of tries when a web connection failure occurs during retrieval of data.

OData

10

 

download-error-web-exception-sleep-initial-ms

Initial sleep in milliseconds between retries when a web connection failure occurs during retrieval of data.

OData

10000

 

download-error-web-exception-sleep-max-ms

Maximum sleep in milliseconds between retries when a web connection failure occurs during retrieval of data.

OData

300000

 

download-error-web-exception-sleep-multiplicator

Multiplication factor for sleep between retries when a web connection failure occurs during retrieval of data.

OData

2

 

download-error-web-not-implemented-max-tries

Maximum number of tries when the connection reports not implemented.

OData

1

 

download-error-web-not-implemented-sleep-initial-ms

Initial sleep in milliseconds between retries when the connection reports not implemented.

OData

10000

 

download-error-web-not-implemented-sleep-max-ms

Maximum sleep in milliseconds between retries when the connection reports not implemented.

OData

300000

 

download-error-web-not-implemented-sleep-multiplicator

Multiplication factor for sleep between retries when the connection reports not implemented.

OData

2

 

download-error-web-timeout-max-tries

Maximum number of tries when the connection reports a timeout.

OData

10

 

download-error-web-timeout-sleep-initial-ms

Initial sleep in milliseconds between retries when the connection reports a timeout.

OData

10000

 

download-error-web-timeout-sleep-max-ms

Maximum sleep in milliseconds between retries when the connection reports a timeout.

OData

300000

 

download-error-web-timeout-sleep-multiplicator

Multiplication factor for sleep between retries when the connection reports a timeout.

OData

2

 

download-error-web-unauthorized-max-tries

Maximum number of tries when the connection reports an unauthorized error.

OData

1

 

download-error-web-unauthorized-sleep-initial-ms

Initial sleep in milliseconds between retries when the connection reports an unauthorized error.

OData

10000

 

download-error-web-unauthorized-sleep-max-ms

Maximum sleep in milliseconds between retries when the connection reports an unauthorized error.

OData

300000

 

download-error-web-unauthorized-sleep-multiplicator

Multiplication factor for sleep between retries when the connection reports an unauthorized error.

OData

2

 

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\gle3.WS212\Invantive\Cache\http\gle3\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-ms

HTTP GET timeout (ms).

OData

300000

 

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-ms

HTTP POST timeout (ms).

OData

300000

 

ignore-http-400-errors

Ignore HTTP 400 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-401-errors

Ignore HTTP 401 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-402-errors

Ignore HTTP 402 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-403-errors

Ignore HTTP 403 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-404-errors

Ignore HTTP 404 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-422-errors

Ignore HTTP 422 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-429-errors

Ignore HTTP 429 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-500-errors

Ignore HTTP 500 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-502-errors

Ignore HTTP 502 errors when exchanging results with the OData endpoint.

OData

False

 

ignore-http-503-errors

Ignore HTTP 503 errors when exchanging results with the OData endpoint.

OData

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.

OData

10

 

invalid-json-on-get-sleep-initial-ms

Initial sleep in milliseconds between retries when the JSON received on GET is invalid.

OData

10000

 

invalid-json-on-get-sleep-max-ms

Maximum sleep in milliseconds between retries when the JSON received on GET is invalid.

OData

300000

 

invalid-json-on-get-sleep-multiplicator

Multiplication factor for sleep between retries when the JSON received on GET is invalid.

OData

2

 

invalid-json-on-post-max-tries

Maximum number of tries when the JSON received on POST is invalid.

OData

1

 

invalid-json-on-post-sleep-initial-ms

Initial sleep in milliseconds between retries when the JSON received on POST is invalid.

OData

10000

 

invalid-json-on-post-sleep-max-ms

Maximum sleep in milliseconds between retries when the JSON received on POST is invalid.

OData

300000

 

invalid-json-on-post-sleep-multiplicator

Multiplication factor for sleep between retries when the JSON received on POST is invalid.

OData

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-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

Registers native calls to data container backend as disk files.

Shared

False

 

log-native-calls-to-trace

Log native calls to data container backend on the trace.

Shared

False

 

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

 

 

max-odata-filters

The 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

 

metadata-cache-max-age-sec

Maximum acceptable age in seconds for re-use of metadata.

OData

 

 

page-size-rows

Maximum number of rows to retrieve per page.

Visma.net Financials

100

 

partition-slot-based-rate-limit-length-ms

Total length in ms 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

Simulate HTTP 400 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-400-errors-percentage

Percentage of simulated HTTP 400 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-401-errors

Simulate HTTP 401 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-401-errors-percentage

Percentage of simulated HTTP 401 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-403-errors

Simulate HTTP 403 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-403-errors-percentage

Percentage of simulated HTTP 403 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-429-errors

Simulate HTTP 429 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-429-errors-percentage

Percentage of simulated HTTP 429 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-500-errors

Simulate HTTP 500 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-500-errors-percentage

Percentage of simulated HTTP 500 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-502-errors

Simulate HTTP 502 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-502-errors-percentage

Percentage of simulated HTTP 502 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-503-errors

Simulate HTTP 503 errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-503-errors-percentage

Percentage of simulated HTTP 503 errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-protocol-errors

Simulate HTTP protocol errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-protocol-errors-percentage

Percentage of simulated HTTP protocol errors when exchanging results with the OData endpoint.

OData

0

 

simulate-http-timeout-errors

Simulate HTTP timeout errors when exchanging results with the OData endpoint.

OData

False

 

simulate-http-timeout-errors-percentage

Percentage of simulated HTTP timeout errors when exchanging results with the OData endpoint.

OData

0

 

slot-based-rate-limit-length-ms

Total length in ms across all slots of a slot-based rate limit.

Shared

60000

 

 

slot-based-rate-limit-slots

Number of slots of a slot-based rate limit. Null means no slot-based rate limit

Shared

 

 

 

standardize-identifiers

Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers.

Shared

True

 

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

 

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

True

 

use-http-disk-cache-write

Whether to memorize HTTP responses on disk.

Shared

True

 

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

 

 

06-04-2021 14:55 Version 20.1.393-BETA+3152