Configuring the tsap-rfc-server.properties file - 7.3

Setting up an RFC server

author
Talend Documentation Team
EnrichVersion
7.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Business applications > SAP components
Data Quality and Preparation > Third-party systems > Business applications > SAP components
Design and Development > Third-party systems > Business applications > SAP components
EnrichPlatform
Talend Studio

The configuration file tsap-rfc-server.properties for Talend SAP RFC Server is located under the $TSAPS_HOME/conf directory (where $TSAPS_HOME corresponds to the directory where the Talend SAP RFC Server has been installed - by default, this is <$INSTALLDIR>/sap-rfc-server). This file consists of seven sections. Before starting Talend SAP RFC Server, you can configure the file to enable some additional features of the server according to your needs.

Note:
  • Talend SAP RFC Server doesn't support the SAP cluster configuration.
  • Any change of the configuration file requires a restart of the Talend SAP RFC Server.

Feature section

The Feature section details the connection information to enable functionalities involving the Talend SAP RFC Server.

#feature.idoc.enabled: Enables the IDoc feature.

#feature.idoc.transactional: Enables the transactional management feature.

  • Reports the entire transaction as a failure to SAP when a message does not get delivered to the JMS broker.
  • Automatically reconnects to the remote JMS broker.

#feature.idoc.transactionAbortTimeOut: Refers to the timeout value in milliseconds.

#feature.bw_source_system.enabled: Enables the BW source system feature.

#feature.streaming.enabled: Enables the streaming mode features (requires a remote connection to a Kafka cluster)
Note: Install a Kafka server version 2.1 onwards prior to using the streaming mode feature. For more information, refer to http://kafka.apache.org/quickstart.

#feature.streaming.timeout: Refers to the timeout value for the streaming to start.

#feature.idoc.mock.enabled: Replaces the IDoc receiver with a mock producing an IDoc package every five seconds.

SAP JCO server section

The SAP JCO Server section details the SAP information the RFC server needs to connect through RFC calls to SAP.

# jco.server.gwhost: SAP gateway host on which the RFC server should be registered (mandatory).

# jco.server.gwserv: SAP gateway service, i.e. the port used for the registration (mandatory).

# jco.server.progid: Identifier for IDoc on the gateway and as the destination in the SAP system.

# jco.server.connection_count: Number of connections registered at the gateway.

# jco.server.worker_thread_count: Number of threads that can be used by the JCOServer instance.

# jco.server.worker_thread_min_count: Number of threads that are kept running by the JCOServer instance.

# jco.server.trace: Enables or disables the RFC trace, this is useful for debugging.

SAP JCO client section

The SAP JCO client section includes the connection information to the SAP ABAP server. You need all the options provided and you can use the credentials of the user with RFC call rights.

Set the password in clear text, which is then overwritten with the # number sign value when the Talend SAP RFC Server starts.

JMS broker section

The JMS Broker section sets up the interaction with the embedded or remote JMS broker.

To enable user authentication, you need to uncomment the following three parameters and set their values. If you don't enable user authentication, the tSAPIDocReceiver component or the tSAPDataSourceReceiver component can also connect to Talend SAP RFC Server without setting the value for their user and password fields.

#jms.login.config=conf/user-authentication/login.config: File system directory containing JAAS authentication configuration.

#jms.login.username: JAAS username used to authenticate a publisher or sender.

#jms.login.password: JAAS password used to authenticate a publisher or sender.

Note: The username and password values are used by the tSAPIDocReceiver or the tSAPDataSourceReceiver component to connect to the Talend SAP RFC Server. They must also exist in the $TSAPS_HOME/conf/user-authentication/users.properties file. In this file, each row represents a username and a password pair, where the username value is on the left side of the equals sign and the password value is on the right side of the equals sign.

To enable the SSL transport mechanism, copy the key store file for SSL to the $TSAPS_HOME/conf folder. Then uncomment the following two parameters (the path to the key store file and the password for the key store file) in the configuration file and set their values

#jms.login.configDomain=tsaps-domain: Domain of JAAS authentication configuration to use.

#jms.ssl.keystore.path: The path to a key store for SSL.

#jms.ssl.keystore.password: A password for a key store for SSL.

#jms.durable.queue.replicate: Whether JMS messages should be replicated in durable queues.

#jms.durable.queue.retentionPeriod: Retention period for JMS messages in durable queues in milliseconds (by default: 7 days).

Embedded broker section

The Embedded Broker section details the connection information of the used embedded JMS broker. If you use an external JMS broker, these values are commented out. The following lists the settings:

#jms.bindAddress: The host address and port (ex: tcp://localhost:61616) for the JMS broker to listen for incoming connections.

#jms.persistent: Whether JMS messages are persisted or not. This way, the Talend SAP RFC Server keeps a copy of all IDocs received in queues named after the IDoc. This is meant to serve the tSAPIDocsReceiver component in batch mode. When the receiver runs, it collects all IDocs stored in the durable queues since the last time it ran.

By default, messages are kept in the queues for up to seven days. You can change the retention period by uncommenting this parameter in the configuration file and updating its value to meet your own requirement.

#jms.dataDirectory: File system location used by the JMS broker to persist data.

#jms.useJmx: Sets whether or not the Broker's services should be exposed into JMX or not.

Remote broker section

The Remote Broker section details the connection information to a remote or external broker. If you use an embedded broker, this section is commented out. The following lists the settings:

#jms.broker.url: When active, connects to a remote broker instead of an embedded one.

#jms.reconnect.interval: Interval between reconnections attempts.

Kafka section

The Kafka section details the Kafka connection information needed to use the streaming mode feature.

kafka.bootstrap.servers=<kafka_setting>: List of host and port pairs that are the addresses of the Kafka brokers.