TIBCO ActiveMatrix Adapter for SAP - TIBCO Product · PDF file · 2012-07-03TIBCO...

TIBCO ActiveMatrix® Adapter for SAP

InstallationSoftware Release 6.2 March 2012

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Designer, TIBCO Runtime Agent, TIBCO Hawk, TIBCO Enterprise Message Service, TIBCO Designer Add-in for TIBCO Business Studio, TIBCO ActiveMatrix Service Grid, TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix BusinessWorks Service Engine, and TIBCO Business Studio are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1999-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Third Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installation Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installation Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installer Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installer Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Disk Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4System Memory Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Supported Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5SAP System Application Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Pre-requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 2 Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

TIBCO ActiveMatrix Adapter for SAP Installation

iv |

Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Post Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Permission Requirements on UNIX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Prerequisites for Running the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Setting Environment Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installation FAQs and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Running Out of Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installation Errors on HP-UX 11.00 64 bit Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 3 Preparing the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Designtime Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Runtime Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Outbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Inbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Configurations in the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Creating a Logical System for an Adapter Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Creating a Logical System for the SAP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Establishing the Distribution Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Defining RFC Destinations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Defining Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Maintaining Partner Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Defining an Extended IDoc Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31


| 1

Preface

This document describes supported features, platforms, installation, configuration, and overall architecture of TIBCO ActiveMatrix Adapter for SAP.

Topics

• Related Documents, page 2

• Terminology and Acronyms, page 6

• Connecting with TIBCO Resources, page 8


2 | Preface

Related Documents

This section lists documentation resources.

TIBCO Product DocumentationThe following documents form the TIBCO ActiveMatrix Adapter for SAP Documentation set:

• TIBCO ActiveMatrix Adapter for SAP Concepts Read this manual before reading any other book in the documentation set. This book describes the adapter, adapter features, and the applications that the adapter interacts with.

• TIBCO ActiveMatrix Adapter for SAP Installation Read this manual to learn how to install TIBCO ActiveMatrix Adapter for SAP.

• TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment This manual explains how to create and configure standalone adapter projects. Information on deploying adapter projects is also included.

• TIBCO ActiveMatrix Adapter for SAP Examples This manual provides instructions to run the examples that demonstrate use of the adapter.

• TIBCO ActiveMatrix Adapter for SAP Release Notes Read this document for information about new features, deprecated features, and open and closed issues.

Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products..

• TIBCO Designer™

• TIBCO Administrator™

• TIBCO ActiveMatrix BusinessWorks™

• TIBCO Rendezvous®

• TIBCO Enterprise Message Service™

• TIBCO Hawk®

• TIBCO Adapter™ SDK

• TIBCO Runtime Agent™


Related Documents | 3

Third Party Documentation• SAP R/3: Implementation Guide by Bradley D. Hiquet, available from

Kelly-Lacey & Associates Inc. This is “A Manager’s Guide to Understanding SAP” that emphasizes the user’s point of view. Printed in 1998 by Macmillan Technological Publishing.

• SAP R/3 Business Blueprint by Thomas Curran and Gerhard Keller. Printed in 1998 by Prentice Hall PTR.

• SAP R/3 System, A Client/Server Technology by Rudiger Buck-Emden. This is a general technical overview that is easy to read. Printed in 1996 by Addison-Wesley.


4 | Preface

Typographical Conventions

The following typographical conventions are used in this manual

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

ENV_HOME

Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.

Other TIBCO products are installed into an installation environment. Incompatible products and multiple instances of the same product are installed into different installation environments. The directory into which such products are installed is referenced in documentation as ENV_HOME. The value of ENV_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code

font Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are of particular interest.

• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname


Typographical Conventions | 5

Key combinations

Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use


6 | Preface

Terminology and Acronyms

Term Definition

ABAP Advanced Business Application Programming is a language in SAP used to write SAP specific code.

ALE/IDoc Application Link Enabling/Intermediate Documents.

API Application Program Interface.

Application Server The server on which the SAP processes run.

BAPI Business API (Functionally equivalent to RFC).

CIF Certified Intermediate Format.

Component A self-contained replaceable functional unit of the adapter that provides a set of interfaces. TIBCO ActiveMatrix Adapter for SAP has two kinds of components; r3Outbound and r3Inbound. r3Outbound encapsulates functionality for outbound communication with the SAP system while r3Inbound encapsulates the functionality for inbound communication with the SAP system.

EDI Electronic Data Interchange.

EMS Enterprise Message Service

Gateway Server A server used to exchange data with the SAP system.

Inbound Instance An adapter configuration listening for messages inbound to SAP. Inbound instances transfer messages from the TIBCO environment to SAP.

Interface A functional sub-unit of the adapter that exposes one or more adapter services. For example, the RFCServer interface exposes RFC/BAPI Request-Response Invocation services.

JMS JAVA Messaging Service

MBCS Multi-byte character string.

One Way Invocation protocol

One way invocation protocol allows you to invoke the BAPI/RFC in the SAP system without waiting for a reply from the system.

Outbound Instance An adapter configuration listening for messages outbound from SAP. Outbound instances transfer messages from SAP to the TIBCO environment.


Terminology and Acronyms | 7

RV TIBCO Rendezvous™ protocol; also in certain contexts refers to reliable message quality of service, as opposed to certified message.

RFC The SAP Remote Function Call Interface.

RFC Client A SAP term for any program that can post RFCs/BAPIs/IDocs from an external system into the SAP system.

RVCM TIBCO Rendezvous certified message quality of service.

RFC Server A SAP term for any external program that can accept and process RFCs/BAPIs/IDocs from the SAP system.

RVDQ TIBCO Rendezvous distributed queue.

SAP Native data All SAP data that the adapter interacts with. It consists of RFC data types. This includes IDocs received as RFC tables in an RFC function call.

SSL Secure Sockets Layer.

TID Transaction ID. A globally unique identifier used by transactional RFCs to ensure exactly-once execution of a transaction.

TIDManager Transaction Identifier Manager.

Term Definition


8 | Preface

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO DocumentationAfter you join TIBCOmmunity, you can access the documentation for all supported product versions here:

http://docs.tibco.com/TibcoDoc

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows.

• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you can request one.


http://www.tibcommunity.com

http://docs.tibco.com/TibcoDoc

http://www.tibco.com/services/support

https://support.tibco.com

| 1

Chapter 1 Introduction

This chapter explains installation modes, requirements, and other options you should be aware of before starting the installation.

Topics

• Installation Overview, page 2

• Installation Requirements, page 4


2 | Introduction

Installation Overview

This section gives an overview of the installer.

Installation ModesThree installation modes are available: GUI, console, and silent.

GUI Mode

In the GUI mode, the installer presents panels that allow you to make choices about product selection, product location, and so on. To invoke the installer in GUI mode, double-click the executable.

Console Mode

Console mode allows you to run the installer from the command prompt or terminal window. This is useful if your machine does not have a GUI environment.

Silent Mode

Silent mode installs the product using either default or custom settings that are saved in a response file. Silent mode installs the product without prompting you for information.

Installation TypesTwo installation types are available: Profile or Custom.

• The Profile installation type installs all the software for a specific profile.

• The Custom installation type allows you to select components.

Installer Account

Microsoft Windows

You must have administrator privileges for the machine on which this product is installed. If you do not have administrator privileges, the installer exits. You must then log out of the system and log in as a user with the required privileges, or request your system administrator to assign the privileges to your account.


Installation Overview | 3

If you intend to install the product on a network drive, ensure that the account used for installation has permission to access the network drive.

UNIX

Any user can install this product.

• Regular (non-root) user

• Super-user (root).

While installing this product on UNIX platforms, ensure that the same installer account is used to install all TIBCO products.

A graphic environment, such as CDE or X Windows, is required to run the installer in GUI mode.

Installer Log FileThe installer log file, tibco_universal_installer.username_install.log, is written to the .TIBCO/install_timestamp folder of the user’s home directory. To change the location of the installer log file, specify the option -V logFile="myLogFile" when you run the installer.

The installer log file captures the following information:

• Installation environment details, such as the user that invoked the installer, host name, Java home in the environment, operating system details, and so on.

• List of assemblies installed.

• Information related to the Ant scripts that are executed by the installer.


4 | Introduction

Installation Requirements

This section describes the disk space requirements, system memory requirements, software requirements, and supported platforms for this product.

Disk Space RequirementsBefore installing this product, extract the contents of the installation archive to a temporary directory. The installer files consume up to 300MB of disk space.

Temporary Disk Space Required by the Installer

The installer requires at least 50 MB of free space in the temporary directory. On Microsoft Windows, the temporary directory typically is:

%SystemDrive%:\Documents and Settings\user_name\Local Settings\Temp.

If your system does not have sufficient disk space in the default temporary area, you can run the installer with a different temporary directory by using the following option when starting the installer:-is:tempdir /new_temp

where /new_temp has sufficient free disk space.

The installer calculates the disk space required in the product home location for the selected components. The calculation is done before the actual installation (copying of files to the system) begins. The installer will proceed only if sufficient free disk space is available in the product home location.

However, if disk space is consumed by another process while the installer is copying the files, and if the required disk space is thereby reduced, the installer may fail and a failure message will appear.

While performing installation, avoid running other processes that consume disk space in the product home location.

Disk Space After Installation

This product consumes 500 MB of free space under TIBCO_HOME.

System Memory RequirementsA minimum of 2 GB of physical memory is required.


Installation Requirements | 5

Supported PlatformsRefer to the TIBCO ActiveMatrix Adapter for SAP readme.txt file for the supported platforms and versions, and required patches.

Software RequirementsTable 2 lists the required and optional software products. Refer to the readme file for the supported versions.

Table 2 Software Requirements

Software Description

TIBCO Rendezvous Required.

TIBCO Runtime Agent

Required. TIBCO Runtime Agent supplies a number of TIBCO and third-party libraries used by the adapter and other TIBCO products both at designtime and runtime. This includes, for example, TIBCO Rendezvous software.

You must install TIBCO Runtime Agent on each machine that hosts an adapter. TIBCO Runtime Agent must be installed before you install the adapter.


6 | Introduction

SAP System Application Requirements• Determine which SAP application versions are supported.

See TIBCO ActiveMatrix Adapter for SAP readme.txt for supported SAP versions.

TIBCO Administrator

Required for deployment. TIBCO Administrator includes the following modules:

• User Management

Management of authentication, roles, and users, that is, connecting roles (groups) and users to access control lists (ACLs). This includes security for server-based projects at designtime, and for deployed applications at runtime.

• Resource Management

Monitoring of machines and all running applications in a TIBCO administration domain. Alerts can be created, for example, to notify an administrator if the number of processes or disk usage exceed a certain number.

• Application Management

Uploading of Enterprise Archive (EAR) files, creation, configuration, deployment, and monitoring of applications. This console is also used to start and stop applications.

TIBCO Administrator is available as a separate installation and can be installed after installing the adapter.

TIBCO Enterprise Message Service

Required for using Java Messaging Services (JMS) as the message transport for your adapter.

TIBCO Enterprise Message Service is available as a separate installation and can be installed after the adapter is installed.

TIBCO ActiveMatrix BusinessWorks

Optional. TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy-to-use integration platform that allows you to develop integration projects. TIBCO Adapters are typically part of integration projects created using TIBCO ActiveMatrix BusinessWorks.

TIBCO ActiveMatrix BusinessWorks is available as a separate installation, and can be installed after installing the adapter.

Table 2 Software Requirements

Software Description


Installation Requirements | 7

• It is recommended that the SAP GUI be installed on the machine for troubleshooting and testing purposes.

• Download and install the following SAP Software libraries on the machine where the adapter is being installed.

a. Design-time adapter components require the SAP Java Connector.

Download the SAP Java Connector from the following URL: http://service.sap.com/connector

b. Run-time adapter components require the RFC library.

Download the SAP RFCSDK Unicode version of the libraries from the following URL:

http://service.sap.com/connector

• A valid SAP Service ID is required. For more information, contact your SAP BASIS administrator.

Pre-requisites• When using unicode SAP 7.01 or later versions you have to install the missing

libraries as follows:

a. Download and unpack the zip archive R3DLLINST.ZIP.

b. Execute R3DLLINS.EXE.

c. Download and install the executable vcredist_x86.exe from http://www.microsoft.com/technet/security/bulletin/MS09-035.mspx.

• When using Microsoft Windows 2008 and Microsoft Windows 7, download and install RFC Library version 7.10 (non-unicode) instead of the bundled version 6.40.

The RFC Library 7.10 requires the Microsoft C/C++ runtime libraries version 8.0 to be installed on the system. See SAP note 684106 for more information.


8 | Introduction


| 9

Chapter 2 Installation Steps

This chapter explains how to install and uninstall this product.

Topics

• Installation, page 10

• Uninstallation, page 19


10 | Installation Steps

Installation

The following sections describe the installation process in the available installation modes:

• GUI Mode, page 10

• Console Mode, page 11

• Silent Mode, page 12

GUI ModeTo install this product in GUI mode,

1. Open the physical media or download the package.

2. Extract the contents of the package to a temporary directory.

3. Navigate to the temporary directory.

4. Run TIBCOUniversalInstaller.

You can do so in one of the following ways:

— Double-click the installer icon.

— On the command prompt, provide the absolute path of the installer file on without specifying any options. The installer defaults to the GUI mode.

5. Click the Next button on the Welcome dialog.

6. Read through the license text when the License Agreement dialog appears, select the I Accept The Terms of The License Agreement radio button, and click the Next button.

7. Select the Typical installation profile from the list on the left to install the following features:

— Runtime Includes the runtime tools for TIBCO ActiveMatrix Adapter for SAP.

— Design Includes the palette and samples for TIBCO ActiveMatrix Adapter for SAP.

— Documentation Includes the TIBCO ActiveMatrix Adapter for SAP documentation. The documentation is installed in the TIBCO_HOME/adapter/adr3/version_number/doc directory.

To customize the profile feature settings, check the Customize Installation checkbox and use the feature tree on the right.


Installation | 11

8. Click the Next button. The TIBCO Installation Home dialog appears.

An installation environment isolates product installations. A product installed into an installation environment does not access components in other installation environments. An installation environment consists of a name and path.

— Create A New TIBCO_HOME To install the product into a new installation environment, specify the following properties:

Directory The directory into which the product is installed. Type a path or click the Browse button to specify the path or accept the default location.

The path cannot contain special characters, such as "*", "#", "?", ">", "<", "%", "&", "$", "`", or "|". The path cannot be the same as the path of an existing environment.

Name Identifies the installation environment. The name cannot contain special characters, such as "*", "?", ">", "<", ":", "|", "/", "\", or quotation marks (").

The name is appended to the name of the Windows services created by the installer and is a component of the path to the product in the Windows Start > All Programs menu.

— Use An Existing TIBCO_HOME To install the product into an existing installation environment, select the environment from the drop-down list.

In this case, select the Use An Existing TIBCO_HOME radio button to install this product into the TIBCO_HOME directory where TIBCO Rendezvous and TIBCO Runtime Agent are installed.

9. Click the Next button.

10. Specify the location of the SAP JCo and RFCSDK runtime libraries.

11. Verify the list of products selected for installation in the Pre-Install Summary dialog.

12. Click the Install button to start the installation process.

13. Review the information listed in the Post-Install Summary dialog.

14. Click the Finish button to complete the installation process and exit the universal installer.

Console ModeTo install this product in console mode:



3. Using a console window, navigate to the temporary directory.

4. Run TIBCOUniversalInstaller -console.

5. Complete the installation by responding to the console window prompts.

Silent ModeIn silent mode, the universal installer does not prompt for any inputs during installation. Instead, the inputs are read from a response file that can be provided as a command-line parameter. If no value is specified, the installer uses the default TIBCOUniversalInstaller_version_number.silent file.

The TIBCOUniversalInstaller_version_number.silent file is packaged in the directory that contains the universal installer. Edit the file with information for your environment before launching the silent installation. The file includes comments that describe the installation properties you can set. While you can use the TIBCOUniversalInstaller_version_number.silent file, it’s good practice to copy the file to a different name and use that file for the silent installation.

If errors occur during installation, they will be listed in the installation log file located in the User_Home/.TIBCO directory.



3. Using a console window, navigate to the temporary directory.

4. Make a copy of the TIBCOUniversalInstaller.silent file and rename it.

5. Using a text editor, open the copied file and update the install location, ENV_NAME, and features to install.

— Update the install location. TIBCO ActiveMatrix Adapter for SAP must be installed in the same directory where TIBCO Runtime Agent is installed. For example, update the directory as follows:

<entry key="installationRoot">C:\tibco</entry>

— Update ENV_NAME. TIBCO ActiveMatrix Adapter for SAP must use the same ENV_NAME that TIBCO Runtime Agent uses.

For example, update ENV_NAME as follows:

<entry key="environmentName">TIBCO_HOME</entry>

— Update features to install. Set the features that you want to install to true as follows:

Installation | 13

<entry key="feature_Adapter_adr3">true</entry><entry key="feature_TID Manager_adr3">true</entry><entry key="feature_Palette_adr3">true</entry><entry key="feature_Samples_adr3">true</entry><entry key="feature_SAP Documentation_adr3">true</entry>

!--Product Specific Properties can be set below using the same 'entry key=' format as above--><entry key="sap.jcojar.dir"></entry><entry key="sap.jcolib.dir"></entry><entry key="sap.rfclib.dir"></entry></properties>

6. Run the following:

Windows TIBCOUniversalInstaller.cmd -silent -V

responseFile="myfilename.silent"

UNIX TIBCOUniversalInstaller-ostype.bin -silent -V responseFile="myfilename.silent"


Post Installation

Ensure that there is only one copy of the individual SAP JCo components on your machine. In particular, ensure that the librfc32.dll (or librfccm.so or librfccm.sl or librfccm.o) library that comes with SAP JCo is the only version of librfc on the machine. This library is also packaged with the SAPGUI. Hence, if you have SAPGUI installed on the machine and the librfc library packaged by SAPGUI precedes the SAP JCo librfc library, the adapter will use the wrong librfc version.

If there is a version mismatch, the following error is displayed.

For the Unicode version of the adapter on Microsoft Windows platform (adr3u.exe), ensure that you have the latest librfc32u.dll available at the SAP website.

If an older version of the librfc32u.dll is in use, the following error is displayed.

See TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment for information on how to enable design-time configuration with the SAP system.

To display the version of the installed adapter and the TIBCO Adapter SDK, execute the following command at the command prompt from the TIBCO_HOME/adapter/adr3/version_number/bin directory:

• for the Unicode adapter

> adru3 -version

• or the Non-Unicode adapter

> adr3 -version


Post Installation | 15

Permission Requirements on UNIX SystemsAll adapter users must have read, write, and execute permissions for the following directories:

$TIBCO_HOME/adapter/adr3/<version_number>/bin $TIBCO_HOME/adapter/adr3/<version_number>/logs$TIBCO_HOME/adapter/adr3/<version_number>/ledger$TIBCO_HOME/tra/<version_number>/logs$TIBCO_HOME/logs

For example, if the adapter has been installed in /opt/tibco, the user who installed the adapter can make these directories writable for all other users by executing the following commands:

% chmod a+w /opt/tibco/adapter/adr3/<version_number>/bin/% chmod a+w /opt/tibco/adapter/adr3/<version_number>/ledger% chmod a+w /opt/tibco/adapter/adr3/<version_number>/logs% chmod a+w /opt/tibco/tra/<version_number>/logs

Prerequisites for Running the AdapterPerform the following tasks for successful messaging between the application and the TIBCO environment.

• Prepare the SAP system to communicate with the adapter. See Preparing the SAP System on page 5 for details.

• Set the environment variables. See Setting Environment Variables on page 15.

• If using the Adapter with RFCSDK non-unicode libraries on 64-bit platforms make sure the msvcp71.dll library is located in the C:\windows\sysWOW64 folder.

Setting Environment VariablesThe adapter sets the environment variables differently depending on whether the adapter is installed on UNIX or Microsoft Windows.

Microsoft Windows

The adapter's default property file adr3.tra has a property named tibco.env.PATH. During installation, the installer updates the tibco.env.PATH in this file with the location of the TIBCO software required by the adapter.

For example, the installer writes the following for tibco.env.PATH in adr3.tra:



C:/TIBCO/adapter/adr3/<version_number>/hotfix/lib; C:/TIBCO/adapter/adr3/<version_number>/lib;C:/TIBCO/tra/<version_number>/hotfix/bin;C:/TIBCO/tra/<version_number>/bin;C:/TIBCO/tpcl/<version_number>/bin;C:/TIBCO/TIBRV/bin;C:/TIBCO/designer/<version_number>/bin

Note that the adr3.tra file is the default property file that is shipped with the adapter.

To launch your adapter configuration, make a copy of this file and update the repository and configuration url to the correct values in the copy.

When the adapter is started with this newly created custom property file, the system settings are automatically updated.

The following example illustrates the procedure to start the adapter from the command line:

1. Create an adapter configuration in TIBCO Designer and save it to a project.

2. Export the project to a .dat file using the File > Export Full Project and specify values for Project Name and Dir Name fields in the Local Repository tab.

3. Copy the default adr3.tra file to MyAdapter.tra

4. Update tibco.repourl and tibco.configurl parameters in MyAdapter.tra

5. Update application.args parameter to application.args adr3 -system:propFile <absolute path to MyAdapter.tra>

6. Start the adapter with the command adr3 --propFile MyAdapter.tra

It is assumed that MyAdapter.tra is in the adapter installation bin directory. If it is copied to any other location, provide the absolute path to this file in the command as explained in the previous step.

UNIX

A shell script adr3setenv.csh is provided with the installation. Running this file in the C-Shell updates the system path and library path settings.

The following environment variables are updated by the script:SHLIB_PATH (HP-UX)

LD_LIBRARY_PATH (Solaris and Linux)

LIBPATH (AIX)

PATH (ALL Platforms)


Post Installation | 17

The shell script updates the environment for the current shell session only. If you open a new shell session, run the script afresh to update.

The following example illustrates the procedure to start the adapter from the command line:

1. Create an adapter configuration in TIBCO Designer and save it to a project.

2. Export the project to a .dat file using the File > Export Full Project and specify values for Project Name and Dir Name fields in the Local Repository tab.

3. Copy the adr3.tra file to MyAdapter.tra

4. Update tibco.repourl and tibco.configurl parameters in MyAdapter.tra

5. Update application.args parameter to application.args adr3 -system:propFile <absolute path to MyAdapter.tra>

6. Open a c-shell by typing csh at the prompt.

7. Run the script adr3setenv.csh in <install-dir>/<version_number> with the following command:source adr3setenv.csh

If the settings are updated successfully, the following message is displayed:Environment variables successfully set

8. Start the adapter with the following command:

adr3 --propFile MyAdapter.tra

It is assumed that MyAdapter.tra is in the adapter installation bin directory. If it is copied to any other location, provide the absolute path to this file in the command as explained in the previous step.

The following table lists useful environment variables that you can set in the .tra file that you are using.

For the HP-UX and AIX platforms, two .csh script files are available, one for the unicode adapter and one for the non-unicode adapter.

Choose the script file appropriate for your system.

Name Description Valid Values Default

RFC_TRACE Turns the RFC Trace on for all connections established by the adapter to the SAP system

0 - OFF

1 - ON

0



RFC_TRACE_DIR Defines location for RFC trace files A valid directory Working Directory

RFC_MAX_TRACE The maximum size (in megabytes) of trace files.

8 MB

RFC_INI Location of the saprfc.ini file A valid path to the .ini file.

Working Directory

Name Description Valid Values Default


Uninstallation | 19

Uninstallation

This section describes how to uninstall this product in the GUI mode and the Console mode.

GUI Mode

1. Shut down all running TIBCO applications.

2. Navigate to TIBCO_HOME/tools/universal_installer and run TIBCOUniversalInstaller to launch the InstallShield wizard.

3. Select the Uninstall Products From Selected TIBCO Home Location radio button.

4. Specify the TIBCO_HOME where TIBCO ActiveMatrix Adapter for SAP is installed and click the Next button.

5. The Welcome dialog appears. Click the Next button.

6. Choose the Custom Uninstall (Select The Products To Be Removed) radio button. The wizard provides two uninstallation options:

— Custom Uninstall You can select the products to be removed.

— Typical Uninstall The universal uninstaller removes all the products in this TIBCO_HOME.

7. Click the Next button. Select the TIBCO ActiveMatrix Adapter for SAP 6.2.0 checkbox, and click the Next button.

8. Review the Pre-Uninstall Summary and click the Uninstall button to start the uninstallation process.

9. Review the Post-Uninstall Summary and click the Finish button to exit the wizard.

Console Mode

1. Using a command window, navigate to the TIBCO_HOME\tools\universal_installer directory.

2. Type the following command at the command prompt:TIBCOUniversalInstaller.exe -console

3. Complete the installation by responding to the console window prompts.


Installation FAQs and Troubleshooting | 1

Installation FAQs and Troubleshooting

This section lists some of the frequently asked questions, common errors along with their causes and solutions.

Frequently Asked Questions

What should I do if the adapter searches for msvcr71.dll while starting up on Microsoft Windows XP?

Place the msvcr71.dll under Windows/System32 folder. The msvcr71.dll is required for versions of SAP JCO higher than 2.1.6.

Why and how should I set the DISPLAY variable on UNIX platforms for GUI mode?

The installer in GUI mode on UNIX, must open an additional window, generally for graphics. It uses the DISPLAY environment variable to let the user know on what computer the window is to be opened. If the environment variable is not set, the installer will either wait or abort after displaying:

InstallShield WizardInitializing InstallShield Wizard...Preparing Java(tm) Virtual Machine.................................................................................

The DISPLAY variable must be set to the IP address or name of the computer (on which the installer graphics windows are to be displayed), followed by a screen address, which can be :0.0 . For example:

# Bourne shellDISPLAY=<ip_address>:0.0; export DISPLAY

# Korn shellexport DISPLAY=<ip_address>:0.0

# C-shellsetenv DISPLAY <ip_address>:0.0

For example, consider a scenario where you need to install the adapter on a remote HP-UX machine (named itaska). Because you have a Solaris 5.7 machine (named alaska) that has a video card and monitor installed, you can run an X-window application on it. So you decide to telnet to itaska from alaska.


2 |

When you telnet to itaska, you will not get access to itaska's monitor and will be unable to display an X-window application. That is why you must set the DISPLAY variable, which instructs the X-server to redirect all windows to the computer set in the variable. Before doing so, the computer (specified in the DISPLAY variable) must give permissions to share its monitor.

alaska> xhost + # give permission for all to its share monitoralaska> telnet itaskaWelcome to HP-UX itaska 11.00User:Password:itaska> export DISPLAY=alaska:0.0 # set display on alaskaitaska> TIB_adr3-simple_<version_num>_h7_110_aCC.bin

Why do I sometimes see the following error message when installing on Unix platforms?

The size of the extracted files to be installed are corrupted. Please attempt to download the installer again. Make sure that the file is transfered in "binary" mode.

This error is generated when there is insufficient space in the /tmp folder. Clean this folder before re-starting the installation process.

Running Out of Disk SpaceThe installer calculates the disk space required in product home location, for the selected components. The calculation is done before the actual installation (copying of files to system) begins. The installer will proceed only if sufficient free disk space is available in product home location.

However, if disk space is consumed by another process while the installer is copying the files, and if the required disk space is thereby reduced, the installer may fail and will then give a failure message.

Solution

While performing installation, avoid running other processes that consume disk space in product home location.

Installation Errors on HP-UX 11.00 64 bit Platform

Error message

Installation on a HP-UX 11.00 64 bit system may crash with the following error message:


Installation FAQs and Troubleshooting | 3

Pid nnn killed due to trashed stack.Pid nnn was killed due to failure in writing the signal context.

This happens only on HP-UX 11.00 64 bit systems. It does not happen on HP-UX 11.00 32 bit system and HP-UX 11.11 (or 11.i) system.

To determine the OS version on your system, run:

uname -a

To determine the kernel bits on your system, run:

getconf KERNEL_BITS

Resolution

HP-UX kernel patch PHKL_27282, resolves the above crash.

To determine if your system has the kernel patch, run:

/usr/sbin/swlist -l product PHKL_27282

or

what /stand/vmunix | grep PHKL_27282

If your system is an HP-UX 11.00 64 bit system and it does not have the patch, first install HP-UX kernel patch PHKL_27282 and then proceed with the installation. Installation of patch PHKL_27282, will reboot your system.


4 |


Preparing the SAP System | 5

Chapter 3 Preparing the SAP System

This chapter gives an overview of the minimum requirements and authorizations required to extract metadata from an SAP system during the configuration stage. The steps for customizing an SAP system for Inbound and Outbound messaging are also described.

You must enable the SAP system for messaging with the TIBCO environment by carrying out appropriate customization. No modifications or additional code is required in the SAP system itself.

Topics

• Designtime Requirements, page 6

• Runtime Requirements, page 8

• Configurations in the SAP System, page 11


6 | Preparing the SAP System

Designtime Requirements

The following are the design-time requirements:

• Obtain a valid SAP user ID and password that allows access to a dedicated SAP application server. This is necessary even if you plan to configure the adapter for Outbound messaging only. A valid user ID and password is required to extract metadata for BAPIs/RFCs/IDocs using TIBCO Designer.

• Obtain required authorization from your SAP system administrator to execute Remote Function Calls and access tables in SAP for the design-time user ID. You will not be able to successfully extract schema information in TIBCO Designer without the necessary permissions in SAP for your user-id.

Specifically, ensure that the following Remote Function Calls can be executed successfully from transaction SE37 in your SAP GUI with the test-data provided.

The SAP user ID must have permissions to execute RFCPING in the SAP system. RFCPING is used by the adapter to verify the state of connections. If you do not have execute permissions for it, a short dump is created in the SAP system.

Remote Function Call Test Input Data

RFC_GET_TABLE_ENTRIES systems TABLE_NAME = EDBAST (4.x and higher SAP systems)

TABLE_NAME = EDIDOT (for 3.x SAP systems)

RFC_GET_TABLE_ENTRIES TABLE_NAME = EDICM

RFC_GET_TABLE_ENTRIES TABLE_NAME = EDCIMT

EDI_IDOC_SYNTAX_GET PI_IDOCTYP = MATMAS01

PI_CIMTYP = <empty> or extended idoctype for MATMAS01, if any

RFC_GET_STRUCTURE_DEFINITION_P (for 4.x and higher systems) RFC_GET_STRUCTURE_DEFINITION_P

_3 (for 3.x SAP systems)

TABNAME = E1MARAM

RFC_FUNCTION_SEARCH FUNCNAME = * (or name of any RFC/BAPI)


Designtime Requirements | 7

• If you are configuring an Inbound adapter and the run-time connection parameters for the adapter are going to be different from the design-time, obtain the relevant connection information. For configuring a load-balanced inbound adapter, you will need parameters to connect to a messaging server for a specific logon group.

RFC_GET_FUNCTION_INTERFACE_P (4.x and higher SAP systems) RFC_GET_FUNCTION_INTERFACE (3.x SAP systems)

FUNCNAME = <name of any RFC/BAPI>

Remote Function Call Test Input Data

Ensure that your login parameters specify the correct language. IDocs/RFCs/BAPIs specific to a particular language will not be retrieved if you login to SAP from the SAP GUI or TIBCO Designer with a different language.



Runtime Requirements

Customization required for run-time interactions with the adapter are described here. The GUI screen shots describing the customization process in this chapter use SAP version 4.6C.

Additional steps might be required, depending on pre-existing maintenance and allocations in the client SAP system. Refer to the help section in the SAP IMG (Implementation Guide) and other appropriate SAP user documentation before customizing.

Outbound MessagingThe SAP system has to be customized to send out BAPI/RFC Invocations and Intermediate Documents to the TIBCO environment. This section describes the minimum configuration to be done in the system to achieve outbound messaging.

Configuration Needed for Invoking BAPIs/RFCs from the SAP System

1. Define an RFC destination in the SAP system.

An RFC Destination should be defined and mapped to a program-id. The Outbound adapter registers on the SAP gateway with this program-id (specified in the adapter configuration) and receives BAPIs/RFCs invoked on the corresponding RFC Destination. An RFC destination allows the SAP system to invoke BAPIs/RFCs in the Outbound adapter.

For configuration details, see Defining RFC Destinations on page 18.

2. Make sure that the required authorizations for executing BAPIs and RFCs exist for the SAP username intended to be used.

Configuration Needed for Publishing IDocs from the SAP System

All required ALE outbound customizing can be done using the SAP implementation management guide (IMG, transaction SALE).

The following minimum steps must be performed to enable the transfer of SAP system IDocs to the TIBCO environment.

1. Create a logical system for the adapter. See Creating a Logical System for an Adapter Instance on page 11 for details.

2. Associate the client logical system with an SAP Client. See Creating a Logical System for the SAP Client on page 15 for details.


Runtime Requirements | 9

3. Define the customer distribution model - this defines what IDocs can be transferred in the outbound direction. See Establishing the Distribution Model on page 16 for details.

4. Define RFC destination. See Defining RFC Destinations on page 18 for details.

5. Define the Partner Profile. See Defining Partner Profiles on page 21 for details.

6. Set up (maintain) the RFC Transactional Port. See Maintaining Partner Profile on page 24 for details.

Inbound MessagingThis section describes the minimum configuration to be done in the system to achieve inbound messaging.

Configuration Needed for Invoking BAPIs/RFCs from the TIBCO environment

Ensure that the SAP client performing invocations in SAP through the adapter (that is the Inbound adapter logged on to SAP with specific client connection parameters) has authorizations to invoke BAPIs/RFCs in the SAP system.

Authorization for each business activity needs to be given to the SAP client if that activity is performed via the adapter. For instance, if the Inbound adapter is configured to create sales orders in SAP, then the SAP client needs all the required permissions to create a sales order.

Verify the authorizations by test-executing the BAPI/RFC from transaction se37 in the SAP GUI without specifying a destination.

ALE Customization for transferring IDocs from the TIBCO environment

All required ALE inbound customizing can be done using the SAP implementation management guide (IMG, transaction SALE).

The following minimum steps must be performed to enable the transfer of messages from the TIBCO environment into the SAP system as IDocs.

1. Create a logical system for the adapter. See Creating a Logical System for an Adapter Instance on page 11 for details.

2. Associate the client logical system with an SAP Client. See Creating a Logical System for the SAP Client on page 15 for details.

3. Define the customer distribution model - this defines what IDocs can be transferred in the inbound direction.

4. Define the Partner Profile. See Defining Partner Profiles on page 21 for details.



Maintain the Partner profiles. In the inbound parameters of partner profile, associate a Process Code for each IDoc type defined for the partner profile.

5. Link this process code to a Function-module, which processes the inbound IDoc.


Configurations in the SAP System | 11

Configurations in the SAP System

The following section provides the steps required to customize the SAP ALE system, using the SAP GUI version 4.6C to operate with the adapter.

The steps are listed next.

1. Creating a Logical System for an Adapter Instance

2. Creating a Logical System for the SAP Client

3. Establishing the Distribution Model

4. Defining RFC Destinations

5. Defining Partner Profiles

6. Maintaining Partner Profile

7. Defining an Extended IDoc Type

Creating a Logical System for an Adapter InstanceThe first requirement is to create an ALE logical system to represent the adapter publication service.

To create a logical system for the adapter application, follow these steps:

1. Log on to the SAP Server.

2. Run the sale transaction:

An ALE window appears with a hierarchical choice of configuration and maintenance options.

3. Navigate to, Application Link Enabling (ALE)>Basic Settings>Logical Systems>Define Logical System and click



When you click to the left of the phrase Define logical system, the following warning window appears.

4. Click to continue.



A Change View window appears like the following:

5. Click the New Entries button to create a new logical system.

An empty New Entries: Overview of Created Entries list window appears.

6. Enter the name of the new application logical system — DOCVIEW is shown below for example — under the Log.System column.

Enter a suitable description under the Name column.

7. Save the new logical system.



The Prompt for Workbench request window appears.

Assign a change request to the change using an existing change request, or create a new change request. If you want to create a new change request, complete the following step.

8. Click on Create request in the bottom button bar.

The Create Request window appears.

9. Enter a short description and save the request.

The system returns you to the Change View window.



10. Scroll down the alphabetical list to verify the creation of the new logical system.

11. Click to return to the initial window.

Creating a Logical System for the SAP ClientThe logical system for the client represents the client itself as a business entity, so that the relationship between the client and other logical systems can be set up. To create a logical system for the adapter client, follow these steps:

1. Log on to the SAP Server.

2. Run the sale transaction.

3. Navigate to

Application Link Enabling (ALE)>Basic Settings>Logical Systems> Define Logical System

4. Click the New Entries button to request the interface used to create a new logical system.



An empty New Entries window appears.

5. Enter the name of the new logical system in the top window and enter the city.

6. Choose from the Logical System pop-up, the client for which you want to create the new logical system (often the logical system you are logged into).

7. Enter a suitable description under column Short Text and choose a role, such as Test.

8. Save the new logical system.

Establishing the Distribution ModelTo make ALE work properly, your SAP system needs to know the relationship between the logical systems. You can establish these relationships through the Maintain Distribution Model dialog.

To establish the distribution model, follow these steps:

1. Run the sale transaction.

2. Navigate to Modelling and Implementing Business Processes.



3. Click the icon next to Maintain Distribution Model and Distribute Views.

The following window is displayed:

4. Go to the edit mode

5. Click the Model View button to create a model view that contains the relationships between logical systems you want to establish.

The Create Model View window is displayed.

6. Type in the name and short description for the new model view, then click

to create the model view.

7. In the Maintain Distribution Model window, click Add Message type to establish the relationship between the logical systems you created.



8. Give the model view a name, then establish the relationship between the adapter and the client by choosing your client logical system (example - CLIENT830) as the Sender/client and your Adapter logical system (example - DOCVIEW) as the Receiver/server. Choose a message type (example - DOCMAS).

9. Repeat the process to include the type of the message you later want to send to the TIBCO environment. For example, include MATMAS if you want to send material IDocs.

10. Click and save.

Now you have established the relationship between the logical systems. You can view it by expanding the model on the original Distribution Model screen.

Defining RFC DestinationsAn RFC destination allows the SAP system to call service functions in the Outbound Adapter configured as an IDoc publisher. RFC uses TCP/IP to interface with the Outbound Adapter.

One or more RFC destinations for the Outbound Adapter processes have to be defined. Usually, only one RFC destination is used. Multiple Outbound Adapter processes can be load balanced by an SAP gateway via a single RFC destination. Multiple destinations can be useful when different destinations are to be used for different ports. The ports are in turn used for different message types.



1. Run the sale transaction and navigate to

Application Link Enabling (ALE)>Communication>Create RFC Connections

2. Click the Create button. The following window appears.

3. Specify the RFC destination. The RFC destination should have the same name as the adapter logical system you created. Choose T (TCP/IP connection) as

the connection type, and click .

4. Save the setting.



5. In the RFC Destination window, click Registration and specify the Program ID.

6. Click the Save icon. This completes definition of an RFC destination.

The Program ID must match the Program ID value in the adapter instance in the repository. It is a good idea to use a different name than that of the logical system itself. Also, it is recommended that you do not associate the name to the RFC destination or logical system.

Select the Unicode radio button to connect to the Unicode version of the adapter.

To use the adapter in the multi threaded mode, the value specified for the Max Connections parameter for the RFC destination should match the value for the Max Connections parameter set in the adapter configuration file (.dat file).

This configuration change can be done using the transaction code SMQS.



Defining Partner ProfilesThe partner profile consists of information about the partners participating in a logical system.

Given below are a couple of examples for information included in a partner profile,

• information on transferred documents

• information on whether the logical system receives or transmits data.

To set up the partner profiles, follow these steps:

1. Run the sale transaction and choose Application Link Enabling (ALE) >Modelling and Implementing Business Processes>Partner Profiles>Generate Partner Profiles.



2. In the window that appears, select the distribution model you defined earlier as the Model View and the logical system for the Adapter you defined earlier as the Partner system.

3. For all other fields, retain the default settings.

4. Choose the execute button.

5. If execution works without errors, save the partner profile by clicking the small open-folder icon. The partner profile will be created with the default port.

In case you want to change the port associated with the message type, following steps need to be carried out to create a port.



6. Enter transaction we21 or run transaction sale and navigate to Application Link Enabling (ALE) >Sending and Receiving Systems>Systems in Network>Asynchronous Processing>Maintain Ports>Define Port.

7. Click on Transactional RFC to highlight it and click the Change (Pencil) icon.



8. Click New entries on the next window.

9. Enter (or select) the name of the logical system and give a description for the new port. This completes definition of a partner profile.

If multiple logical message types are used in your environment, it is recommended that you define different ports for different message types or for groups of message types.

Maintaining Partner ProfileAn outbound partner profile must be defined for each logical message type that is to be sent to the TIBCO environment. The outbound partner profile defines the message syntax to be used for the logical message type, the transfer mode, the port to send to, and the workflow parameters (where error notifications are to be sent etc.). In the previous section (Defining Partner Profile), the partner profile is created for logical message type MATMAS. This section explains how you change the partner profile to add, delete or change the message types and associated parameters.

1. Run transaction sale and work through the hierarchy displayed to:Application Link Enabling (ALE) >Modelling and Implementing Business

The presence of the “Version” entry is important. It determines the version of IDocs transmitted, 30x or 40x. Version value of 2 causes EDI_DC (IDoc version 30X) metadata to be used for the IDoc publisher mode. Version value of 3 causes EDI_DC40 (IDoc version 40X) metadata to be used for the IDoc publisher mode.



Processes>Partner Profiles and Time of Processing>Maintain Partner Profile.

2. Choose the adapter logical system you defined earlier and LS as the partner type, then click the change (pencil) icon.

3. In the next window, enter ALE as the partner type and A (active) as the partner status.

4. Select Outbound Parameters.

5. Change the Outbound Parameters so each message type is included for your publisher.

6. Save the Partner Profile for the publisher.



Defining an Extended IDoc TypeSAP makes basic IDoc types available for use with SAP processes. You can create extensions to a basic IDoc type using the procedure described in this section.

1. To create an IDoc extension, initiate transaction WE30. The Develop IDoc Types screen is displayed. An example of this screen is shown below. Select the Extension radio button as shown below to indicate that you are going to create an extension to an existing IDoc type.

2. Enter the name of your IDoc extension in the ObjectName text box. Note that names used by SAP are case insensitive. See the following example.



3. Click the Create icon (folded paper) or enter the function F5 key to proceed with extension creation. The Create extension screen is displayed, as shown below.

4. Select the Create new radio button. This step associates the new extension with a basic IDoc type. This is done by entering the name of a basic IDoc type, such as DEBMAS03, in the Linked basic type text entry box.

5. Click the down arrow to the right of the text entry box and select the basic type from the list that is displayed. When you have entered the basic IDoc type, enter a description in the Description box. When your entries are

complete, click to proceed with the extension creation.

6. The following Create extension screen is displayed. This screen shows the initial default segments contained in the new IDoc extension, as defined by



the basic IDoc type (DEBMAS03 in the example). Add segments using this screen.

7. For example, you can add a second child segment to segment E1KNA1L by highlighting the current child segment and clicking on the Create icon (folded paper).

8. An information screen is displayed as shown in the following example. Click

to acknowledge the information.

9. The Attribute Maintenance screen is displayed as in the following example. Enter a valid existing segment type, such as ZLEON as shown in the example screen. Also enter values for the Minimum and Maximum Number



of segments that are allowed. Click .

10. The Create Extension screen is displayed again with the new child segment as shown in the example below. Save the new IDoc extension.


| 31

Index

A

add message type 17ALE

generating Partner Profiles 21in partner profile 25

API 6assign client to logical system 15

C

configuration filelogical system specification 13

Console Mode 2, 11, 19create Request window 14custom 2Custom Uninstall 19customer support 8

D

define Port 23distribution model 16documents related 2

E

ENV_HOME 4

G

Generate Partner Profiles 21GUI Mode 2, 10, 19

I

Installation ModesConsole Mode 2GUI Mode 2Silent Mode 2

Installation ProcedureConsole Mode 11GUI Mode 10Silent Mode 12

Installation RequirementsDisk Space Requirements 4Software Requirements 5Supported Platforms 5System Memory Requirements 4

Installation TypeCustom 2Profile 2

Installer Account 2Installer Log File 3

L

logical systemadapter application 18client (sending and receiving SAP system) 18correspondence to keyword in the publisher config-

uration file 13creating 13


32 |

for SAP client 15required 18saving new 16verifying creation 13, 16

M

maintaindistribution model 17logical systems 11Partner Profile 25

model viewadding message type 17

O

outbound partner profilemaintain 24set up 24

P

partner profileRFC port 23

profile 2Program ID 20, 20Prompt for Workbench request window 14

R

related documents 2RFC

define transactional ports 23RV 7, 7RVCM 7RVDQ 7

S

sale transaction 11, 15SAP server

logging on 11, 15Silent Mode 2, 12support, contacting 8

T

technical support 8TIBCO_HOME 4Typical 10Typical Uninstal 19

U

UninstallationConsole Mode 19GUI Mode 19

Uninstallation Procedure 19


TIBCO ActiveMatrix Adapter for SAP - TIBCO Product · PDF file · 2012-07-03TIBCO...

Documents

Transcript of TIBCO ActiveMatrix Adapter for SAP - TIBCO Product · PDF file · 2012-07-03TIBCO...