Start of Content Area

Function documentation Services  Locate the document in its SAP Library structure

Use

This menu option contains the services of the Adapter Engine that contain configurable parameters. You configure these parameters using the same screen as for the adapters. This menu option is only available for users with the Adapter Engine Administrator role.

Note

Any changes made to the configuration of the services are only activated when the Adapter Engine is restarted. It is not sufficient to simply restart the services (unlike with configuration changes to adapters).

Prerequisites

You have installed the Adapter Engine and the adapter you require, started the Adapter Engine and called it using your web browser. On the configuration screen, you have chosen the menu option Services and the system now displays the menu with the same name.

Features

You have the following choice of services:

      GUIBrowserEngine

The GUI browser engine represents a separate HTTP server with a configurable port:

port=<portNo>

This is the HTTP port that the browser can log on to. The default value is 8200 and must not be changed unless it has already been reserved.

The following settings must not be changed under any circumstances:

       zones=root

       rootDirectory=Administration

HTTP.transmission=plain|SSL

Defines whether the browser and the Adapter Engine are to communicate using HTTP (plain) or HTTPS (SSL). The default is plain.

The following additional specifications are required for SSL:

       HTTP.SSLcertificate=<p12-certificate name>

       HTTP.SSLcertificatePassword=<p12-certificate password>

HTTP.SSLcertificatespecifies the complete file name of a password-protected certificate and HTTP.SSLcertificatePassword specifies the corresponding password (the password can be protected by using the token concept, described above).

Note

To make the installation HTTPS-enabled you must install additional Java libraries that are available from the SAP Service Marketplace (http://service.sap.com). These IAIK libraries must be located in the Java CLASSPATH.

      HttpServer

The HTTP server is used by the receiver adapters. You have the option of making the following settings during the configuration of the HTTP server:

       HTTP.authentication=none|basic

Define whether user-authentication is performed. In the basic setting, the HTTP client of the Integration Server must log on to the Adapter Engine with a valid user that has been assigned the role HTTP Server User. Using the none setting, authentication can either take place with a certificate or without authentication at all.

The default is none.

       HTTP.transmission=plain|SSL

Defines whether the Integration Server and the HTTP server of the Adapter Engine are to communicate using HTTP (plain) or HTTPS (SSL). The default is plain.

The following additional specifications are required for SSL:

       HTTP.SSLcertificate=<p12-certificate name>

       HTTP.SSLcertificatePassword=<p12-certificate password>

SSLcertificatespecifies the complete file name of a password-protected certificate and SSLcertificatePassword specifies the corresponding password (the password can be protected by using the token concept, described above).

Note

To make the installation HTTPS-enabled you must install additional Java libraries that are available from the SAP Service Marketplace (http://service.sap.com). These IAIK libraries must be located in the Java CLASSPATH.

       To activate the validation of a client certificate, enter HTTP.SSLauthenticate=true.

      InfoLogger

The InfoLogger provides the service functions for writing and displaying the specific logs for an adapter instance. You use the following parameters to configure the display and save logic of the log files for all adapter instances:

       maxViewSize=<sizeKBytes>

This parameter (default: 100) controls the amount of data transferred to the browser when the display of the adapter-specific log is called on the configuration and monitoring screen of the adapter. If the amount of log information saved is greater than 100, the system displays the message <VIEW LENGTH RESTRICTION: SKIP nnn BYTES>… in the browser display, where nnn is the number of skipped bytes in the log file.

The parameter refers to the representation of the log file. Since this usually contains keys, which are not replaced with text until the log is called, the amount of data actually transferred is generally significantly larger than defined here (by a factor of between 3 and 5).

       maxFileSize=<sizeKBytes>

This parameter (default: 0) controls the maximum size (in KB) of the log file for each adapter instance. If the specified size is reached, the file is deleted or archived, depending on the setting for the parameter archiveFiles. If the parameter is set to 0, the file is deleted each time the Adapter Engine is restarted and written during the Adapter Engine runtime without limit. This corresponds to the standard procedure.

       archiveFiles=<anyValue>

If this parameter contains a value, the respective log file (<adaptername>.log) is not deleted when the upper limit specified for maxFileSize is reached, but is archived with a time stamp under the name <adaptername>_<yyyMMdd-HHmmss>.log in the directory LogFiles. If maxFileSize is set to 0. the parameter archiveFiles has no function.

      PWtokens

This is the service for replacing the password tokens in the adapter configurations. If required, you can change the beginning and end characters of the tokens centrally here.

       PWD.beginSeparator=<beginSign>

       PWD.endSeparator=<endSign>

beginSign and endSign can be any character string. Existing replacements of tokens in the adapter configurations must then be adjusted correspondingly.

      SLDaccessor

This service enables you to log on to the SAP System Landscape Directory and supports the following functions:

       Write access: When the Adapter Engine is started, its current configuration is transferred to the System Landscape Directory. This information is then accessed by the Runtime Workbench for example, to establish a connection to the monitoring and configuration functions of the Adapter Engine, or it is accessed by the Integration Directory to determine default values when creating end points for business systems if these are associated with an adapter.

       Read access: Configuration data can be accessed centrally for each adapter instance at runtime. This service can be activated by the sender adapters to determine the parameter XI.TargetURL (which describes the address of the Integration Server) dynamically using the parameter XI.SenderService.

To do so, the corresponding association must be maintained in the System Landscape Directory and the latter must be accessible. You configure the HTTP connection required to access the System Landscape Directory by using the following parameters:

       SLD.host=<SLDhostname>

Name of the server on which the System Landscape Directory is running.

       SLD.port=

Port number under which the System Landscape Directory can be reached.

       SLD.user=

       SLD.password=

Valid logon data for the System Landscape Directory installation (the password can be protected by using tokens, as described above).

The user must have the authorizations of group SAP_XI_APPL_SERV_USER on the Integration Server.

Read access to the System Landscape Directory can be activated in the sender adapters by adding the following entry to the configuration:

XI.SLDConfiguration=SLDaccessor

In this case the URL of the corresponding Integration Server for the system specified with XI.SenderService is read from the SLD and used instead of the value specified under XI.TargetURL. Therefore, specify the following:

XI.TargetURL=<fromSLD>

Note

If the System Landscape Directory logon data is not maintained correctly, corresponding error messages can occur in the Adapter Engine console output when the service is initialized (for example, when the Adapter Engine is started). These error messages do not affect the other functions and can be ignored if access to the System Landscape Directory is not required.

      RemoteConfiguration

Use this service to add and start remote adapter instances to the Adapter Engine and also to change adapter instances that already exist.

RemoteConfiguration awaits an XI message with a payload that contains a valid adapter configuration file. This configuration file is saved in the directory /configuration.

Aside from the configuration paramters fort he adapter instance, you must also provide the following additional paramters in the file. These parameter values are not evaluated for the adapter instance but by RemoteConfiguration:

       channelName=<name>

Enter the name of the adapter instance.

Use the following configuration parameters to configure RemoteConfiguration:

       XI.httpPort=8211

Defines the TCP port that the service uses (required entry).

       File.targetDir=Configuration

Do not change this value.

The sender of the confoguration file sends the message to: http://<Host der Adapter Engine (SE)>:8211/configure. The user involved must have administrator rights to be able to register with the Adapter Engine.

RemoteConfiguration contains a commented-out dispatcher class as an example which you can use to conevert a payload in XML structure in to a configuration file (CSV file).

Remove the comment characters to be able to use the dispatcher class. A payload with the following structure is converted using the dispatcher class:

<root>

<row>

    <name>name1</name>

    <valuet>value1</value>

</row>

<row>

    <name>name2</name>

    <value>value2</value>

</row>

<row>

    <name>name3</name>

    <value>value3</value>

</row>

</root>

Enter = as a divider.

The following file is produced by the conversion.

name1=value1

name2=value2

name3=value3

 

 

End of Content Area