102.4. Destination Configuration
Overview
The configurations for destinations are maintained in the
destinationDataStore
property of the SAP component. Each entry in this map configures a distinct outbound connection to an SAP instance. The key for each entry is the name of the outbound connection and is used in the destinationName
component of a destination endpoint URI as described in the URI format section.
The value for each entry is a destination data configuration object -
org.fusesource.camel.component.sap.model.rfc.impl.DestinationDataImpl
- that specifies the configuration of an outbound SAP connection. The following tables list the configuration properties that may be set on this object.
Logon and authentication options
Name | Default Value | Description |
---|---|---|
client
|
SAP client, mandatory logon parameter | |
user
|
Logon user, logon parameter for password based authentication | |
aliasUser
|
Logon user alias, can be used instead of logon user | |
userId
|
User identity which is used for logon to the ABAP AS. Used by the JCo runtime, if the destination configuration uses SSO/assertion ticket, certificate, current user ,or SNC environment for authentication. The user ID is mandatory, if neither user nor user alias is set. This ID will never be sent to the SAP backend, it will be used by the JCo runtime locally. | |
passwd
|
Logon password, logon parameter for password-based authentication | |
lang
|
Logon language, if not defined, the default user language is used | |
mysapsso2
|
Use the specified SAP Cookie Version 2 as logon ticket for SSO based authentication | |
x509cert
|
Use the specified X509 certificate for certificate based authentication | |
lcheck
|
Postpone the authentication until the first call - 1 (enable). Used in special cases only . | |
useSapGui
|
Use a visible, hidden, or do not use SAP GUI | |
codePage
|
Additional logon parameter to define the codepage that will used to convert the logon parameters. Used in special cases only | |
getsso2
|
Order a SSO ticket after logon, the obtained ticket is available in the destination attributes | |
denyInitialPassword
|
If set to 1 , using initial passwords will lead to an exception (default is 0 ).
|
Connection options
Name | Default Value | Description |
---|---|---|
saprouter
|
SAP Router string for connection to systems behind a SAP Router. SAP Router string contains the chain of SAP Routers and its port numbers and has the form: (/H/<host>[/S/<port>])+
|
|
sysnr
|
System number of the SAP ABAP application server, mandatory for a direct connection | |
ashost
|
SAP ABAP application server, mandatory for a direct connection | |
mshost
|
SAP message server, mandatory property for a load balancing connection | |
msserv
|
SAP message server port, optional property for a load balancing connection. In order to resolve the service names sapmsXXX a lookup in etc/services is performed by the network layer of the operating system. If using port numbers instead of symbolic service names, no look-ups are performed and no additional entries are needed.
|
|
gwhost
|
Allows specifying a concrete gateway, which should be used for establishing the connection to an application server. If not specified the gateway on the application server is used | |
gwserv
|
Should be set, when using gwhost. Allows specifying the port used on that gateway. If not specified the port of the gateway on the application server is used. In order to resolve the service names sapgwXXX a lookup in etc/services is performed by the network layer of the operating system. If using port numbers instead of symbolic service names, no lookups are performed and no additional entries are needed. | |
r3name
|
System ID of the SAP system, mandatory property for a load balancing connection. | |
group
|
Group of SAP application servers, mandatory property for a load balancing connection |
Connection pool options
Name | Default Value | Description |
---|---|---|
peakLimit
|
0
|
Maximum number of active outbound connections that can be created for a destination simultaneously. A value of 0 allows an unlimited number of active connections, otherwise if the value is less than the value of jpoolCapacity , it will be automatically increased to this value. Default setting is the value of poolCapacity , or in case of poolCapacity not being specified as well, the default is 0 (unlimited).
|
poolCapacity
|
1
|
Maximum number of idle outbound connections kept open by the destination. A value of 0 has the effect that there is no connection pooling (default is 1 ).
|
expirationTime
|
Time in milliseconds after which a free connection held internally by the destination can be closed | |
expirationPeriod
|
Period in milliseconds after which the destination checks the released connections for expiration. | |
maxGetTime
|
Maximum time in milliseconds to wait for a connection, if the maximum allowed number of connections has already been allocated by the application. |
Secure network connection options
Name | Default Value | Description |
---|---|---|
sncMode
|
Secure network connection (SNC) mode, 0 (off) or 1 (on)
|
|
sncPartnername
|
SNC partner, for example: p:CN=R3, O=XYZ-INC, C=EN
|
|
sncQop
|
SNC level of security: 1 to 9
|
|
sncMyname
|
Own SNC name. Overrides environment settings | |
sncLibrary
|
Path to library that provides SNC service |
Repository options
Name | Default Value | Description |
---|---|---|
repositoryDest
|
Specifies which destination should be used as repository. | |
repositoryUser
|
If a repository destination is not set, and this property is set, it will be used as user for repository calls. This enables you to use a different user for repository look-ups. | |
repositoryPasswd
|
The password for a repository user. Mandatory, if a repository user should be used. | |
repositorySnc
|
(Optional) If SNC is used for this destination, it is possible to turn it off for repository connections, if this property is set to 0 . Default setting is the value of jco.client.snc _mode. For special cases only.
|
|
repositoryRoundtripOptimization
|
Enable the
RFC_METADATA_GET API, which provides repository data in one single round trip.
If the property is not set, the destination initially does a remote call to check whether
RFC_METADATA_GET is available. If it is available, the destination will use it.
Note: If the repository is already initialized (for example because it is used by some other destination) this property does not have any effect. Generally, this property is related to the ABAP System, and should have the same value on all destinations pointing to the same ABAP System. See note 1456826 for backend prerequisites.
|
Trace configuration options
Name | Default Value | Description |
---|---|---|
trace
|
Enable/disable RFC trace (0 or 1 )
|
|
cpicTrace
|
Enable/disable CPIC trace [0..3]
|
Destination data example
<bean id="nplDestinationData" class="org.fusesource.camel.component.sap.model.rfc.impl.DestinationDataImpl"> <property name="ashost" value="nplhost" /> <property name="sysnr" value="42" /> <property name="client" value="001" /> <property name="user" value="developer" /> <property name="passwd" value="ch4ngeme" /> <property name="lang" value="en" /> </bean>