Installing Software AG PI Adapter for EntireX

This document describes how to copy the SAP PI integration components of the PI Adapter from the CD to the machine where SAP PI is running.

The HTML page install.htm in the CD root directory gives a brief summary of how to carry out the installation procedure. Depending on your machine configuration, this page may be displayed automatically in your default web browser when you mount the CD, otherwise you can view it by loading it manually into your web browser.

Scope

The distribution kit for the PI Adapter for EntireX consists of a CD that contains components that integrate into the SAP PI infrastructure. The CD contains among others the following files that are required for the installation:

CD Path/File Name Contents
ADAPTER/com.softwareag.xiadapter.ra.entirex.rar The RAR file containing the adapter.
ADAPTER/xie.xml The adapter metadata file.

Installation Steps

The installation consists of the following steps:

Deploying the Adapter

The PI Adapter must be deployed into the SAP AS Java System of the SAP NetWeaver installation:

Start of instruction setTo deploy the adapter into the SAP AS Java System

  1. Start the SAP NetWeaver Developer Studio and open the Deploy perspective.

  2. Add a PI instance to Preferences (host and instance number 0).

  3. Select the Deploy View tab, click on External Deployable Archives and add the adapter RAR file from the CD.

  4. Click the Deploy icon to deploy the adapter.

After the RAR file has been successfully deployed, the adapter is shown in the Repository View tab as com.softwareag.xiadapter.ra.entirex(softwareag.com).

Note:
If you have already installed a previous version of the adapter, the deployment will update the adapter to the new version.

Loading the Adapter Metadata

The adapter metadata file has to be uploaded into the Enterprise Services Builder of SAP. The adapter metadata is part of a Software Component Version, this can be either a Software Component Version imported from the System Landscape Directory (SLD), or it can be a Local Software Component Version. In the following we assume that such a Software Component Version has been created with the name "SAG-ADAPTER" (the actual name can be different).

Start of instruction setTo update existing adapter metadata in the Enterprise Services Builder from a previous installation

  1. Activate the Enterprise Services Builder tool and open the "SAG-ADAPTER" software components.

  2. Open the Adapter Metadata object EntireX under the namespace http://softwareag.com/xiadapter.

  3. Switch to Edit Mode.

  4. Choose Upload XML description from file.

  5. Choose the metadata XML file ADAPTER/xie.xml from the CD.

  6. Save the metadata schema and activate it using Change Lists/Standard change list/Activate.

Start of instruction setTo load the adapter metadata into the Enterprise Services Builder for the first time

  1. Open the software component "SAG-ADAPTER" and create a new namespace http://softwareag.com/xiadapter.

  2. Under this namespace, open the context menu under New > Adapter Objects/Adapter Metadata.

  3. Enter the name EntireX. It is absolutely essential that the name be written exactly as it appears here. Any variation of spelling or case will result in an error.

  4. Choose Create.

  5. Choose Adapter Metadata > Properties. Make sure that the entry for Original Language is set to "English" to avoid problems with language-specific settings.

  6. Choose Adapter Metadata > Import XML Description ....

  7. Choose the metadata XML file ADAPTER/xie.xml from the CD.

  8. Save the metadata schema and activate it using Change Lists/Standard change list/Activate.

Now the adapter should be visible in the selection list for the configuration of the communication channel.