Skip to content

System Parameters and Environment Parameters

This page describes configurations of OData Provider.

To set up these parameters, you have to change OData values.yaml (deployment) file manually. This is only possible for customers using the Remote deployment model.

Contents

Following system parameters should be declared in ODP_JAVA_OPTS environment variable.

System Properties Default Value Description Usage Modification Allowed in Production Environment
odp.extension.xlsx.cache.ttl.mins 5 Maximum time allowed for Microsoft Excel file downloads.
  • Property value is in minutes, i.e. 5 is considered as 5 minutes.
 Caution: Increasing this value to a too high value can increase security risks. Yes
Not Recommended
odp.extension.imageresize.cache.files.deleteonstartup false Image cache should be deleted at server startup
  • If not set or false: image cache folder is not deleted at server startup.
  • If set to true: image cache folder is deleted at server startup
Yes
Not Recommended
ifs.show-stack-trace false Exception type and message is added in to inner error of the response body. Debug purpose No.
ifs.force-metadata-exceptions-to-trace false Determines whether information of metadata related exceptions should be included in the debug response, under server trace. Debug purpose
  • If not set or false: exceptions will not be logged.
  • If set to true: exceptions will be logged.
 No
ifs.log-bind-parameters false Determines whether data associated with the sql statement should be logged in case of an error, along with parsed sql statement. Debug purpose
  • If not set or false: data associated with the sql statement won't be logged.
  • If set to true: data and parsed sql statement will be logged.
 Yes
Not Recommended since data might be sensitive.
odp.projection.cache.limit 500 Determines the maximum number of projections that can be cached inside the server at a given time. Caution: Increasing this value might cause resource implications in the server. Yes
Not Recommended
odp.log.level warn Determines the level of descriptiveness in logs. (can also be set via ifsappodata.logLevel installation parameter) Debug purpose
  • If not set or "error" : only errors and fatal failures will be logged.
  • Allowed levels: off, fatal, error, warn, info, debug, trace, all
 No

Following environment parameters should be changed directly on OData values.yaml file manually.

Environment Properties Default Value Description Usage Modification Allowed in Production Environment
ODP_JAVA_OPTS Contains system properties that needs to be passed to server. Enable/Disable some features as specified in the system properties table. Yes
IFS_PROXY_URL   Proxy URL Used in server to determine the jwks URI when validating the jwt token. Must not be changed.
IFS_DOMAIN_NAME   Domain name Used in the jwt token validation to identify the principal that issued the
jwt.		 Must not be changed.
IFS_REALM_NAME   Realm name Used in jwt token validation. This is mapped to the "aud" (audience) claim that identifies the recipients that the jwt is intended for. Must not be changed.
IFS_USERNAME_ATTRIBUTE Username attribute This is used to choose a claim for the user principal from the jwt token. Must not be changed.
IFS_MIN_POOL_SIZE 1 Determines the minimum number of database connections that can be kept in the server connection pool at a given time. (can also be set via ifsappodata.minPoolSize installation parameter)
  • If not set or 1: minimum number of database connections kept in server connection pool is configured to 1.
  • If other: minimum number of database connections kept in server connection pool will be changed according to this value.
 Yes
Not Recommended
IFS_MAX_POOL_SIZE 25 Determines the maximum number of database connections that can be kept in the server connection pool at a given time.
Should be higher than IFS_MIN_POOL_SIZE (can also be set via ifsappodata.maxPoolSize installation parameter)
  • If not set or 25: maximum number of database connections kept in server connection pool is configured to 25.
  • If other: maximum number of database connections kept in server connection pool will be changed according to this value.
 Yes
Not Recommended
IFS_QUERY_TIMEOUT 5m Default timeout for data retrieving requests.
Supports 10h10m10s format. Should be less than or equal to IFS_MAX_QUERY_TIMEOUT.
Overrides the general timeout specified by IFS_STATEMENT_TIMEOUT for data retriving requests. (can also be set via ifsappodata.queryTimeout installation parameter)
  • If not set then 30 seconds. Default timeout value specified for a data retriening request is set as 5 minutes.
  • If other: default timeout for a data retrieving request will be changed according to this value.
 Yes
Not Recommended
IFS_MAX_QUERY_TIMEOUT 5m Max value for timeout of data retrieving requests.
Supports 10h10m10s format.
Should be less than or equal to IFS_STATEMENT_TIMEOUT. (can also be set via ifsappodata.maxQueryTimeout installation parameter)
  • If not set or 5m: max timeout for a data retriening request is set as 5 minutes.
  • If other: max timeout for a data retrieving request will be changed according to this value.
 Yes
Not Recommended
IFS_STATEMENT_TIMEOUT 15m General timeout for any given request including data persistance.
Should be configured to be a much higher value.
Supports 10h10m10s format. (can also be set via ifsappodata.statementTimeout installation parameter)
  • If not set or 15m: general timeout for a request is set as 15 minutes.
  • If other: general timeout for a request will be changed according to this value.
 Yes
Not Recommended
IFS_ALLOWED_EXTENSIONS_REFRESH_TIME 1h This specifies how often ODP should update the allowed file extension.
The value will be fetched from the Allowed File Extension, system parameter
Decreasing the value will impact on the time taken for upload/download request
  • The allowed file extension list will be updated after the time interval specified here.
 Yes