Entering content frameFunction documentation Adapters Locate the document in its SAP Library structure

Use

The Adapters menu of the Adapter Engine enables you to add new adapters, deactivate existing adapters, and reactivate or remove deactivated adapters. Furthermore, you can manage existing adapters in the detailed view.

Prerequisites

You have installed the Adapter Engine and the adapters you require, started the Adapter Engine and called it using your web browser.

Features

The Adapters menu is displayed on the right-hand side when you call the configuration screen. It displays a list of available (installed) adapters with their current status and provides you with the following options:

Choose this function to generate a new adapter configuration from an existing adapter. To do so, proceed as follows:
    1. Choose the function by clicking it.

      2. A selection list appears containing all the adapters that are currently activated.

    2. Select an adapter from the list.
    3. Enter a name for the new adapter.
    4. If you want the adapter to be started automatically when the Adapter Engine is started, check the checkbox Automatic Startup. If you do not check the checkbox, the adapter remains in the status INITIALIZED following a restart and must be started manually from the adapters menu.
    5. To create an adapter configuration under the new name that has the same settings as the adapter configuration that you used as a template, choose Create.

The configuration is now displayed under the new name in the selection list of the adapters menu and can be edited there to adjust the settings copied.

This graphic is explained in the accompanying text

You must not activate identical adapter configurations under different names. This is usually not technically possible and leads to an error message when you attempt to initialize the new adapter. In isolated cases however, it is possible and can lead to unexpected results with messages being duplicated or lost.

Choose this function to remove (deactivate) existing adapters from the adapters menu. However, the adapter configurations are not deleted and can, if required, be re-included (reactivated) in the adapters menu. Proceed as follows:
    1. Choose the function by clicking it.

      2. A selection list appears containing all the adapters that are currently activated.

    2. Select one or more adapters from the list.
    3. To remove the selected adapter(s) from the adapters menu, choose Deactivate.

Choose this function to re-included existing, but deactivated adapters in the adapters menu. Proceed as follows:
    1. Choose the function by clicking it.

      2. A selection list appears containing all the adapters that are currently deactivated.

    2. Select one or more adapters from the list.
    3. If you want all the adapters selected to be started automatically when the Adapter Engine is started, check the checkbox Automatic Startup. If you do not check the checkbox, the adapters remains in the status INITIALIZED following a restart and must be started manually from the adapters menu.
    4. To re-include the selected adapters in the adapters menu, choose Reactivate.

This graphic is explained in the accompanying text

Copying Adapter Configurations from Other Installations

Since the name of a deactivated adapter is no longer managed by the Adapter Engine, but a properties file with the same name exists in the configuration directory of the Adapter Engine, you can use this function to copy adapter configurations from other installations of the Adapter Engine.

To do so, copy the source file <AdapterName>.properties from the directory ../tech_adapter/Configuration to the same directory in the target installation. It is then automatically displayed in the list of deactivated adapters and can be reactivated correspondingly.

This graphic is explained in the accompanying text

Changing the Start Mode for an Adapter

If you have defined an adapter so that it starts automatically, you can change the start mode by choosing the function Deactivate Adapters.

To do so, first deactivate the adapter(s) in question and the reactivate it/them again with the start mode required.

Choose this function to delete existing deactivated adapters. Once you have deleted an adapter configuration it can no longer be reactivated. Proceed as follows:
    1. Choose the function by clicking it.

      2. A selection list appears containing all the adapters that are currently deactivated.

    2. Select one or more adapters from the list.
    3. To delete the selected adapter(s), choose Remove.

Activities

To display details about the displayed adapter, double-click it.

In the detailed view, the name, type, version, and status of the adapter are displayed. The Log area displays an adapter-specific log if one exists.

From the detailed view you can do the following:

Note

The status displays the respective current status of the adapter (INITIALIZED, STARTED, STOPPED, or TERMINATED). Due to the partly asynchronous processing of the corresponding actions described below, the status displayed might also just be an intermediate status. This is particularly true for Restart, which involves the statuses STOPPED, TERMINATED, INITIALIZED, and STARTED. In this case, you can update the display by choosing Reload.

To call the configuration that you require to configure an adapter, choose Configure. The system displays the configuration in a window in the Configuration area. You can switch between display and edit mode and in the latter you can save changed configuration data. The system displays the name of the configuration underneath the window.

To start an adapter, choose Start. To do so, you must have already created and configured the adapter.

To regenerate and initialize the adapter, choose Create. This is necessary if you have changed the configuration data or have deleted the current instance of the adapter using Terminate.

To restart the adapter, regardless of its status, choose Restart. This is necessary if you have changed its configuration, for example.

To stop a running adapter, choose Stop.

To end an adapter instance, for example, if you no longer require it, or if it is not functioning as you want it to, choose Terminate.

 

 

Leaving content frame