Configuration Options

• jco.client.ashost

  SAP application server host

  Type:	string
  Default:	""
  Valid Values:	IP or Hostname
  Importance:	high

• jco.client.sysnr

  SAP system number

  Type:	int
  Default:	0
  Valid Values:	[0,...,99]
  Importance:	high

• jco.client.mshost

  SAP message server host

  Type:	string
  Default:	""
  Valid Values:	IP or Hostname
  Importance:	medium

• jco.client.msserv

  SAP message server service or port number (optional)

  Type:	string
  Default:	""
  Valid Values:	^([0-9]{1,5})|(sapms[A-Z][a-zA-Z0-9]{2})$
  Importance:	medium

• jco.client.r3name

  System ID of the SAP system, the so-called SID in format [A-Z][a-zA-Z0-9]{2}

  Type:	string
  Default:	""
  Valid Values:	^([A-Z][a-zA-Z0-9]{2})$
  Importance:	low

• jco.client.client

  SAP client

  Type:	int
  Default:
  Valid Values:	length() = 3
  Importance:	high

• jco.client.user

  SAP logon user ID

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

• jco.client.passwd

  SAP logon password

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

• sap.odp.subscriber-name

  Unique ODP subscriber name (should never be changed). This identifier will be used to calculate delta request

  Type:	string
  Default:	OhJaODPKafkaConnector
  Valid Values:	length() <= 32
  Importance:	high

• sap.odp.serialization

  Serialization format used for the data transfer between ODP and the connector.

  Type:	string
  Default:	GZipped BAS_XML
  Valid Values:	[BAS_XML, Column, ABAP_XML, GZipped BAS_XML, GZipped Json, Automatic, Json, String] Use Automatic for the same data serialization format as applied in the ODQ. Use GZipped BAS_XML for g-zipped binary ABAP serialization XML. Use GZipped Json for g-zipped json. Use BAS_XML for binary ABAP serialization XML. Use ABAP_XML for canonical ABAP serialization XML. Use Json for json. Use Column for column based key/value string representation. Use String for stringified rows.
  Importance:	medium

• sap.odp.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.odp.max.retries

  Maximum amount of retries in case of system connection issues

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

• sap.odp.min.retry.backoff.ms

  Minimum time in milliseconds applied in the backoff strategy to wait before retrying to connect to the SAP system.

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

• sap.odp.max.retry.backoff.ms

  Maximum time in milliseconds applied in the backoff strategy to wait before retrying to connect to the SAP system.

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

• sap.odp.retry.exception.groups

  Comma separated list of JCoException groups for which the retry backoff strategy will be applied. See com.sap.conn.jco.JCoException for a list of valid group IDs.

  Type:	list
  Default:	JCO-109,JCO-174,JCO-102,JCO-132,JCO-170,JCO-180,JCO-173,JCO-120,JCO-136,JCO-134,JCO-108,JCO-133,JCO-190,JCO-182,JCO-200,JCO-121,JCO-171,JCO-107,JCO-112,JCO-106,JCO-172,JCO-153,JCO-110,JCO-104,JCO-135,RODPS_REPL-520
  Valid Values:	Comma separated list of BAPI return errors in the form of {MESSAGE_CLASS}-{NUMBER}. For native JCo exception groups use JCO-{NUMBER} with a message number in the range [101..200] e.g., 'JCO-102'.
  Importance:	low

• sap.odp.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.odp.numeric.mapping

  Map numeric character types to strings (none or string).

  Type:	string
  Default:	none
  Valid Values:	[none, string] Use none if all numeric character types (N,D,T) should be converted to appropriate data types. Use string if if all numeric character types (N,D,T) should be converted to strings.
  Importance:	low

• sap.odp.currency.conversion

  Convert CURRENCY values to SAP's internal or external format (internal or external).

  Type:	string
  Default:	internal
  Valid Values:	[internal, external] Use internal if all CURRENCY amounts are to be represented by SAP's internal representation. Use external if all CURRENCY amounts should be cast to SAP's external format.
  Importance:	low

• sap.odp.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.odp.schema.compat.version

  Schema compatibility version

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

• ohja.rfc.mapping

  A comma-separated list of mapping rules for Remote Function Calls (RFCs). Each rule should be in the format 'pattern->replacement'.

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

• sap.odp#00.context

  ODP source context, e.g. SAPI. Context and name build up the primary key for each ODP

  Type:	string
  Default:	""
  Valid Values:	length() <= 20
  Importance:	high

• sap.odp#00.name

  ODP source name. Context and name build up the primary key for each ODP

  Type:	string
  Default:	""
  Valid Values:	length() <= 30
  Importance:	high

• sap.odp#00.topic

  Kafka topic name

  Type:	string
  Default:	SAPODP0
  Valid Values:	^[a-zA-Z0-9._\-]{1,255}$
  Importance:	high

• sap.odp#00.init-simulation

  0=delta initialization with data transfer, 1=delta initialization without data transfer, 2=delta with full initialization, 3=full extraction

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

• sap.odp#00.projection

  Comma separated list of field names to extract

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

• sap.odp#00.exec-period

  Execution interval in seconds for scheduled extraction

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

• sap.odp#00.identifiers.enable

  Add ODQ row identifiers from the ODQ_S_DELTA_APPEND structure to the value section of the kafka messages.

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

• sap.odp#00.errors.tolerance

  Error tolerance behavior in case of dataset related conversion errors.

  Type:	string
  Default:	none
  Valid Values:	[none, skiprow, initializefield, deadletterqueue] Use none if all conversion errors should lead to a termination. Use skiprow if records with conversion errors are to be filtered out. Use initializefield if fields with erroneous values are to be initialized. Use deadletterqueue if records with conversion errors should be put into a dead letter queue.
  Importance:	medium

• sap.odp#00.errors.tolerance.row-regexp

  Regular expression for selecting datasets to which the error strategy (!= none) is to be applied

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

• sap.odp#00.errors.tolerance.fields

  Fields to which the error strategy (!= none) is to be applied (empty means all)

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

• sap.odp#00.null-messages

  Create null messages and persist logical connect offsets for empty requests in the source system.

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

• sap.odp#00.errors.tolerance.dlq.topic

  DLQ topic name for the error strategy.

  Type:	string
  Default:	SAPODP0_DLQ
  Valid Values:	^[a-zA-Z0-9._\-]{1,255}$
  Importance:	medium

• sap.odp#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.odp#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.odp#00.package-size

  ODP package size in bytes. A delta request will be split up in multiple packages having this configured size.

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

• sap.odp#00.realtime.enable

  Open requests in real-time mode, if supported by ODP source (0=disabled, 1=enabled)

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

• sap.odp#00.realtime.packages

  Maximum number of data packets after which a realtime request is closed

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

• sap.odp#00.realtime.timelimit

  Maximum number of seconds after which a realtime request is marked to be closed

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

• sap.odp#00.delta.select#00.fieldname

  sap.odp#00.delta selection range field name

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

• sap.odp#00.delta.select#00.sign

  sap.odp#00.delta selection range include (I) / exclude (E)

  Type:	string
  Default:	I
  Valid Values:	[I, E]
  Importance:	medium

• sap.odp#00.delta.select#00.option

  sap.odp#00.delta election range comparison operation: EQ (equal), NE (unequal), GT (greater than), GE (greater equal), LT (lower than), LE (lower equal), BT (between), NB (not between), CP (contains pattern), NP (not contains pattern)

  Type:	string
  Default:	EQ
  Valid Values:	[EQ, NE, GT, GE, LT, LE, BT, NB, CP, NP]
  Importance:	medium

• sap.odp#00.delta.select#00.low

  sap.odp#00.delta selection range value-from 'LOW'

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

• sap.odp#00.delta.select#00.high

  sap.odp#00.delta selection range value-to 'HIGH'

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

• sap.odp#00.select#00.fieldname

  sap.odp#00 selection range field name

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

• sap.odp#00.select#00.sign

  sap.odp#00 selection range include (I) / exclude (E)

  Type:	string
  Default:	I
  Valid Values:	[I, E]
  Importance:	medium

• sap.odp#00.select#00.option

  sap.odp#00 election range comparison operation: EQ (equal), NE (unequal), GT (greater than), GE (greater equal), LT (lower than), LE (lower equal), BT (between), NB (not between), CP (contains pattern), NP (not contains pattern)

  Type:	string
  Default:	EQ
  Valid Values:	[EQ, NE, GT, GE, LT, LE, BT, NB, CP, NP]
  Importance:	medium

• sap.odp#00.select#00.low

  sap.odp#00 selection range value-from 'LOW'

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

• sap.odp#00.select#00.high

  sap.odp#00 selection range value-to 'HIGH'

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

• jco.client.snc_mode

  Secure Network Communications (SNC) mode (1=on, 0=off)

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

• jco.client.snc_partnername

  SNC name of the communication partner server. For example: p:CN=SID, O=ACompany, C=EN

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

• jco.client.snc_qop

  SNC quality of protection Valid values: 1, 2, 3, 8, 9

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

• jco.client.snc_myname

  SNC name of the caller (optional). Overrides the default SNC name. For example: p:CN=MyUserID, O=ACompany, C=EN

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

• jco.client.snc_sso

  Turn on/off the SSO mechanism for SNC. (1=yes, 0=no)

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

• jco.client.x509cert

  Base64 encoded X.509 certificate as logon ticket

  Type:	string
  Default:	""
  Valid Values:	^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
  Importance:	high

• jco.destination.auth_type

  Authentication type - configured user or current user

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

• jco.client.alias_user

  SAP logon user ID

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

• jco.client.serialization_format

  Serialization format to be used for transferring function module data | columnBased: new column based serialization, sometimes also called 'fast serialization' rowBased: classic row based serialization

  Type:	string
  Default:	columnBased
  Valid Values:	[columnBased, rowBased]
  Importance:	low

• jco.client.group

  Logon group name of SAP application servers (optional)

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

• jco.client.sticky

  Enable/disable sticky behavior for logon load balanced destinations (0=disable, 1=enable)

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

• jco.client.saprouter

  SAP router string to use for networks being protected by a firewall in format (/H/host[/S/port])+

  Type:	string
  Default:	""
  Valid Values:	^(/H/(?:(?:(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])))(?:/S/\d{1,5})?)+$
  Importance:	low

• jco.client.lang

  SAP logon language

  Type:	string
  Default:	EN
  Valid Values:	length() = 2
  Importance:	low

• jco.destination.pool_capacity

  Maximum number of idle connections kept open by the destination. A value of 0 has the effect that there is no connection pooling, i.e. connections will be closed after each request.

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

• jco.destination.peak_limit

  Maximum number of active connections that can be created for a destination simultaneously

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

• jco.client.network

  Expected network type to be used by the destination (LAN=fast local area network, WAN =slow wide area network)

  Type:	string
  Default:	LAN
  Valid Values:	[LAN, WAN]
  Importance:	low

• jco.client.codepage

  Initial logon code page in SAP notation

  Type:	short
  Default:	1100
  Valid Values:	[1000,...,9999]
  Importance:	low

• jco.client.pcs

  Initial logon code page type (1=non-unicode,2=unicode)

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

• jco.client.mysapsso2

  SAP Cookie Version 2 as logon ticket

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

• jco.client.getsso2

  Get/don't get an SSO ticket after logon (1=request ticket, 0=don't request ticket)

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

• jco.client.lcheck

  Enable/disable logon check at connection opening time (1=enable, 0=disable and postpone)

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

• jco.client.use_basxml

  Enable/disable basXML serialization for transferring function module data (1=enable, 0=disable)

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

• jco.client.delta

  Enable/disable table parameter delta management (1=enable, 0=disable)

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

• jco.destination.expiration_time

  Time in ms after that the connections hold by the internal pool can be closed

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

• jco.destination.expiration_check_period

  Interval in ms with which the timeout checker thread checks the connections in the pool for expiration

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

• jco.destination.max_get_client_time

  Max time in ms to wait for a connection, if the max allowed number of connections is allocated by the application

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

• jco.destination.pool_check_connection

  When set to 1 the pool checks for corrupted connections before they are used by an application.

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

• jco.client.deny_initial_password

  Deny usage of initial passwords (0=do not deny, 1=deny initial passwords)

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

• jco.destination.repository_roundtrip_optimization

  A value of 1 forces the usage of remote function module RFC_METADATA_GET for meta data queries from ABAP systems, 0 deactivates it. If the property is set to -1, the destination will initially do a remote call to check whether RFC_METADATA_GET is available. And if it is available, it will use it.

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

• jco.client.trace

  Enable/disable RFC trace (0=no trace, 1=enable trace)

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

• jco.trace_level

  Choose the trace level from 0 to 10, where 10 is the highest and most detailed level of tracing.

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

• jrfc.client_connect_timeout

  The timeout in seconds for a logon try after having established the technical client connection to an ABAP server.

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