Source Configuration Options

  • sap.odata.host.protocol

    OData transfer protocol

    Type:string
    Default:https
    Valid Values:[https, http]
    Importance:high

  • sap.odata.host.address

    OData server address as either DNS or IP

    Type:string
    Default:
    Valid Values:
    Importance:high

  • sap.odata.host.port

    OData server port

    Type:int
    Default:443
    Valid Values:[1,...,65535]
    Importance:high

  • sap.odata.user.name

    Basic Authentication: user name

    Type:string
    Default:""
    Valid Values:
    Importance:high

  • sap.odata.user.pwd

    Basic Authentication: user password

    Type:password
    Default:[hidden]
    Valid Values:
    Importance:high

  • sap.odata.oauth.client.id

    OAuth client id

    Type:string
    Default:""
    Valid Values:
    Importance:medium

  • sap.odata.oauth.client.secret

    OAuth client secret

    Type:password
    Default:[hidden]
    Valid Values:
    Importance:medium

  • sap.odata.oauth.token.endpoint

    OAuth token endpoint URL

    Type:string
    Default:""
    Valid Values:URL according to RFC2396 'Uniform Resource Identifiers (URI): Generic Syntax'.
    Importance:medium

  • sap.odata.oauth.redirect

    OAuth redirect URL

    Type:string
    Default:""
    Valid Values:URL according to RFC2396 'Uniform Resource Identifiers (URI): Generic Syntax'.
    Importance:medium

  • sap.odata.oauth.scope

    OAuth scope

    Type:string
    Default:""
    Valid Values:
    Importance:medium

  • sap.odata.connection.connect.timeout.ms

    Timeout in milliseconds for establishing an http connection.

    Type:int
    Default:15000 (15 seconds)
    Valid Values:[0,...]
    Importance:low

  • sap.odata.connection.read.timeout.ms

    Timeout in milliseconds for reading data from an established http connection.

    Type:int
    Default:70000 (70 seconds)
    Valid Values:[0,...]
    Importance:low

  • sap.odata.query-params

    Optional list of service-URL query parameters in the form of 'param1=value1,param2=value2'

    Type:list
    Default:""
    Valid Values:Parameters are checked against regex ^[^=&?]+=[^=&?]*$.
    Example: sap-client=200
    Importance:medium

  • sap.odata.license.key

    License key which allows to use this software. This license key can be set directly or by config provider.

    Type:password
    Default:
    Valid Values:
    Importance:high

  • sap.odata.max.retries

    Maximum amount of retries in case of service connection/communication errors defined by sap.odata.retry.http.status.codes

    Type:short
    Default:30
    Valid Values:[0,...]
    Importance:low

  • sap.odata.retry.http.status.codes

    Failed requests whose response have an http status codes included in this list will be retried.

    Type:list
    Default:408,502,503,504
    Valid Values:Comma separated list of Http status codes.
    Each individual parameter is checked against regex [4-5]\d{2}.
    Example: '408,502,503,504'
    Importance:low

  • sap.odata.min.retry.backoff.ms

    Minimum time in milliseconds applied in the backoff strategy to wait before trying to reconnect to the service.The backoff strategy applied will select a random number of milliseconds to wait between min.retry.backoff.ms and max.retry.backoff.ms before starting the next retry.

    Type:long
    Default:20000 (20 seconds)
    Valid Values:[0,...]
    Importance:low

  • sap.odata.max.retry.backoff.ms

    Maximum time in milliseconds applied in the backoff strategy to wait before trying to reconnect to the service.The backoff strategy applied will select a random number of milliseconds to wait between min.retry.backoff.ms and max.retry.backoff.ms before starting the next retry.

    Type:long
    Default:180000 (3 minutes)
    Valid Values:[0,...]
    Importance:low

  • sap.odata.subscription.dest

    SAP systems provide an optional subscription model for push based notifications via OData. When using subscriptions the name of an RFC destination of type 'G' must be specified. This destination will be used to connect to the OData v2 Source Connector.

    Type:string
    Default:""
    Valid Values:
    Importance:low

  • sap.odata.subscription.ports

    SAP OData subscription ports for task notifications.

    Type:list
    Default:1111
    Valid Values:\d{1,5}
    Importance:low

  • sap.odata.keystore.location

    Absolute path to the custom KeyStore on the worker machine.

    Type:string
    Default:""
    Valid Values:Absolute path to a file on the connect worker machine.
    Importance:low

  • sap.odata.keystore.password

    Password for the custom KeyStore.

    Type:password
    Default:[hidden]
    Valid Values:
    Importance:low

  • sap.odata.keystore.type

    Type of the custom KeyStore.

    Type:string
    Default:jceks
    Valid Values:[jceks, jks, dks, pkcs11, pkcs12]
    Importance:low

  • sap.odata.truststore.location

    Absolute path to the custom TrustStore on the worker machine.

    Type:string
    Default:""
    Valid Values:Absolute path to a file on the connect worker machine.
    Importance:low

  • sap.odata.truststore.password

    Password for the custom TrustStore.

    Type:password
    Default:[hidden]
    Valid Values:
    Importance:low

  • sap.odata.truststore.type

    Type of the custom TrustStore

    Type:string
    Default:jceks
    Valid Values:[jceks, jks, dks, pkcs11, pkcs12]
    Importance:low

  • sap.odata.sslcontext.protocol

    The protocol that is applied for the encrypted communication between connector and server.

    Type:string
    Default:SSL
    Valid Values:[SSL, SSLv2, SSLv3, TLS, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3]
    Importance:low

  • sap.odata.decimal.mapping

    Map DECIMAL values to primitive type FLOAT64(double) and INT64(long).

    Type:string
    Default:none
    Valid Values:[none, primitive]
    Use none if all DECIMAL types are to be represented by Connect's DECIMAL logical type.
    Use primitive if all DECIMAL types should be cast to Connect's primitive INT64 and FLOAT64 type based upon the field's scale. In case of overflows the respective max and min values will be used.
    Importance:low

  • sap.odata.custom.http.headers

    Custom http headers, key:value pairs separated by commas: key1:val1,key2:val2

    Type:list
    Default:""
    Valid Values:Comma separated list of Http headers.
    Each individual parameter is checked against regex ^[^=@&:?,]+:[^=@&:?,]+$.
    Example: 'headerKey1:headerValue1, headerKey2:headerValue2'
    Importance:low

  • sap.odata.headers.enable

    Add metadata attributes to the header section of the kafka messages (0 = off, 1 = on).

    Type:short
    Default:0
    Valid Values:[0,...,1]
    Importance:low

  • sap.odata#00.service

    OData service path (root) being used to assemble the final service URL ({PROTOCOL}://{HOST}:{PORT}{SERVICE_PATH}). Usually starts with a '/'. Service and entityset build up the primary key for each OData configuration.

    Type:string
    Default:""
    Valid Values:
    Importance:high

  • sap.odata#00.entityset

    Name of the OData entity set. The entity set name can be queried from the /$metadata service URL

    Type:string
    Default:""
    Valid Values:
    Importance:high

  • sap.odata#00.topic

    Kafka topic (regular expression or topic name).

    Type:string
    Default:OData0
    Valid Values:valid regular expression pattern
    Importance:high

  • sap.odata#00.exec-period

    Time between two connector task poll()-method calls in seconds. Can be set to -1 for one-time polls e.g. in push based subscription scenarios.

    Type:int
    Default:900
    Valid Values:[-1,...]
    Importance:low

  • sap.odata#00.track-changes

    Use OData change tracking to enable delta request mode (0=off, 1=on). Needs to be supported by the corresponding service.

    Type:short
    Default:0
    Valid Values:[0,...,1]
    Importance:low

  • sap.odata#00.null-messages

    Mechanism to write delta link into offset topic when we consume empty messages (0 = off, 1 = write empty messages into the target topic and the delta link into the offset topic).

    Type:short
    Default:0
    Valid Values:[0,...,1]
    Importance:low

  • sap.odata#00.paging.mode

    Paging mode applied to reduce the amount of data returned in one single request.

    Type:string
    Default:server
    Valid Values:[server, client]
    Use server to use the header preference parameter odata.maxpagesize.
    Use client if server side paging is not supported, track-changes is disabled and query functions $skip and $top should be used instead.
    Client side paging may lead to data inconsistencies if data changed between fetching two consecutive pages.
    Importance:low

  • sap.odata#00.paging.size

    Page size as count of records in one single page request.

    Type:int
    Default:50000
    Valid Values:[1,...]
    Importance:low

  • sap.odata#00.projection

    Comma separated list of selected non-key fields to be extracted using the $select query option.

    Type:list
    Default:""
    Valid Values:
    Importance:low

  • sap.odata#00.expand.level

    Hierarchy level up to which recommendations for the expand.list configuration (query option $expand) will be shown in the Confluent Control Center.

    Type:int
    Default:1
    Valid Values:[0,...]
    Importance:low

  • sap.odata#00.expand.list

    List of expand query options to resolve associations of returned entity messages

    Type:list
    Default:""
    Valid Values:
    Importance:low

  • sap.odata#00.subscription.enable

    Use push notifications provided by the SAP OData subscription model (0 = off, 1 = on).

    Type:short
    Default:0
    Valid Values:[0,...,1]
    Importance:low

  • sap.odata#00.delta.link.recovery

    Recovery mechanism in the event of an invalidated delta link (0 = off, 1 = Recovering from latest available delta link using entity 'DeltaLinksOf...' e.g., for OData enabled ODP sources).

    Type:short
    Default:0
    Valid Values:[0,...,1]
    Importance:low

  • sap.odata#00.delta.link.regex

    Manual delta link override using a regular expression match e.g., deltatoken='(.*)'

    Type:string
    Default:""
    Valid Values:valid regular expression pattern
    Importance:low

  • sap.odata#00.delta.link.replacement

    Replacement string for committed delta link part that matches delta.link.regex e.g., deltatoken='D20211221095841_001568000'

    Type:string
    Default:""
    Valid Values:
    Importance:low

  • sap.odata#00.cron.expression

    Cron expression for scheduled executions as alternative to 'exec-period'. See org.quartz.CronExpression for more details.

    Type:string
    Default:""
    Valid Values:Sec Min Hours Day-of-month Month Day-of-Week (Year)
    Importance:low

  • sap.odata#00.cron.security.time.sec

    Maximum security interval in seconds for the cron scheduled executions. If the connector was unable to perform a scheduled extraction, e.g. due to downtime, it will still perform the extraction if it occurs within the safety interval after the scheduled extraction time.

    Type:int
    Default:900
    Valid Values:[0,...]
    Importance:low

  • sap.odata#00.select#00.fieldname

    Selection range field name

    Type:string
    Default:""
    Valid Values:
    Importance:medium

  • sap.odata#00.select#00.option

    Selection range comparison operation: eq (equal), ne (unequal), gt (greater than), ge (greater or equal), lt (lower than), le (lower or equal), bt (between), nb (not between), in (in comma-separated set of values)

    Type:string
    Default:eq
    Valid Values:[eq, ne, gt, ge, lt, le, bt, nb, in]
    Importance:medium

  • sap.odata#00.select#00.low

    Selection range value-from "LOW" will become visible if needed by the chosen range operation.

    Type:string
    Default:""
    Valid Values:
    Importance:medium

  • sap.odata#00.select#00.high

    Selection range value-to "HIGH" will become visible if needed by the chosen range operation.

    Type:string
    Default:""
    Valid Values:
    Importance:medium
1.3.6