+ All Categories
Home > Documents > TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment...

TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment...

Date post: 24-May-2018
Category:
Upload: duongduong
View: 368 times
Download: 8 times
Share this document with a friend
432
TIBCO ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012
Transcript
Page 1: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

TIBCO ActiveMatrix® Adapterfor SAP

Configuration and DeploymentSoftware Release 6.2March 2012

Page 2: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND ANAGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws andtreaties. No part of this document may be reproduced in any form without the written authorization of TIBCOSoftware Inc.TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrixBusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Designer, TIBCO Runtime Agent, TIBCOHawk, TIBCO Enterprise Message Service, TIBCO Designer Add-in for TIBCO Business Studio, TIBCOActiveMatrix Service Grid, TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix BusinessWorks ServiceEngine, and TIBCO Business Studio are either registered trademarks or trademarks of TIBCO Software Inc. inthe United States and/or other countries.EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of SunMicrosystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALLOPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON ASPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, 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 BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDINGBUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1999-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

Page 3: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv

Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviTIBCO ActiveMatrix Adapter for SAP Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviThird Party Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xviii

Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiHow to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

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

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9TIBCO Administration Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9TIBCO Administration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10TIBCO Administrator GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Adapter Project Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 4: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

iv |

Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Creating a Project for the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Working with the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Sample Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20RFC Outbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20RFC Inbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21IDoc Outbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21IDoc Inbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Convert the multi-file project to dat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Testing the Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Starting the adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Starting the Unicode adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Outbound Connectivity Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Outbound Messaging Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Inbound Connectivity Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Inbound Messaging Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 3 Adapter Instance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Schema Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Adapter Instance Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Design-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Run-time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Run-time Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Adapter Services Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Setting Inbound/Outbound Instance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Configuration Task Sequence for a Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Configuration Task Sequence for a Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Configuration Task Sequence for Request-Response Invocation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuration Task Sequence for Request-Response Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Adding Adapter Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Adding Adapter Services Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77IDocs Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79RFCs/BAPIs Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 5: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| v

Publication Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Subscription Service Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104

Request-Response Invocation Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111

Request-Response Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

Configuring Schema for Adapter Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

Saving the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Chapter 4 Configuring the Adapter with Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . .125

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127

Configuring Valid Destinations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128

Adding Connections to an Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

Adding an Active Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132Setting up Active Connection Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132

Adding a Connection Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134Setting up Connection Reference Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135Assigning an Active Connection to an Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136

Adding a Client Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137Selecting Client Connection Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137

Dedicated Application Server Client Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139Configuring Dedicated Application Server Client Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139

Client Connection with Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141Configuring Client Connection with Load Balancing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142

Client Connection with saprfc.ini file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143Configuring Client Connection with saprfc.ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 6: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

vi |

Setting Client Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Setting up Client Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Setting Advanced Client Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Adding a Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Selecting Server Connection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Default Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Configuring Default Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

saprfc.ini Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Configuring Server Connection with saprfc.ini . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Setting Server Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Sample saprfc.ini Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Example: Registering an RFC Server Program Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Using Logon Groups to Connect an RFC Client to SAP Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Using a Dedicated Application Server to Connect an RFC Client Program to SAP . . . . . . . . . . . . . . . . . . 159

Configuring User Exits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Configuring User Exit for Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Configuring a User exit for a Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Saving an IDoc to a Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Configuring IDoc Logging Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Configuring Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Configuring Subscription Services for Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Configuring Request-Response Services for Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Publishing IDocs on Dynamic Subjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Replacing Control Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Configuring Multiple Connections for Inbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Configuring Multiple Connections for Outbound Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Load Balancing Using Distributed Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Configuring Inbound Load-Balanced Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Multiple Inbound Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Single Inbound Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Configuring Outbound Load-balanced Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

BDC Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186BDC Implementation through Standard RFC (ABAP4_CALL_TRANSACTION). . . . . . . . . . . . . . . . . . . . . 186BDC Implementation through Custom RFCs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Using Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Changing Global Variable Values at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 7: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| vii

Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192

Chapter 5 TIDManager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196Interactions between the Adapter and the TIDManager server configuration . . . . . . . . . . . . . . . . . . . . . . .196Recovering from network outages and TIDManager server downtimes. . . . . . . . . . . . . . . . . . . . . . . . . . . .197

Setting TIDManager Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199

Setting TIDManager Logging Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200

Setting TIDManager Startup Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201

Setting TIDManager Monitoring Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202

Setting TIDManager General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204Configuring a TIDManager server on JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204

Setting TIDManager for Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206

Chapter 6 Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207

Using the Adapter with a Revision Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208

Handling Large Internal Tables from SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211Enabling Data-Chunking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211

IDoc Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215

Inbound BAPI Transactional Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218Sample Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220Configuring Multiple Transactional RFC Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225

Invoking BAPIs/RFCs Using Transactional Semantics in SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227Support for qRFCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228Receiving IDocs through qRFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229

Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233

Multiple Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235Posting BAPIs/RFCs/IDocs from multiple gateways in the Outbound Adapter . . . . . . . . . . . . . . . . . . . . . .235Posting BAPIs/RFCs/IDocs from multiple RFC Destinations in the Outbound Adapter . . . . . . . . . . . . . . . .236Responding to Dynamic Changes in the Application Server environment . . . . . . . . . . . . . . . . . . . . . . . . . .237Configuring the Inbound Adapter for multiple application servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241

Event Driven Inbound Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242Connectionless Inbound Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242Performing explicit logon for RFCs/BAPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244

Connecting an Adapter Instance to Two SAP Systems with a Single Connection . . . . . . . . . . . . . . . . . . . . . . .247Sample Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247

Using JMS Destination Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251

Working with Non-Blocking RPC Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 8: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

viii |

Chapter 7 Program Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

SAP Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Getting Ready to Run Unicode on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

How the Adapter Handles Unicode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Support for Non-Unicode SAP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Support for Unicode SAP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Chapter 8 Deploying and Starting an Adapter Using TIBCO Administrator . . . . . . . . . . . . . . 263

Create an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Deploy the Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Deploying a 4.x TID Manager in TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Start or Stop the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Monitor the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Obfuscating or Encrypting a Password in the Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Chapter 9 Working with Secure Network Communications (SNC) . . . . . . . . . . . . . . . . . . . . . 277

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278SAP Cryptographic Library for SNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Procedure for SNC Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279Download the SAP Cryptographic Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Install the SAP Cryptographic Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Set the Trust Manager Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Create the Personal Security Environment (PSE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Setup SNC Profile Parameters for SAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Install the SAP Cryptographic Library on the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285Installing the PSE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286Setup the SNC Parameter Specific to an Inbound Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292Setup SNC Parameters Specific to Outbound Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297SNC INI File Example for the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Transaction Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Appendix A Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Trace Message Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Status Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Appendix B SAP Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 9: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| ix

The SAP Business Application System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .378

Exchanging Business Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .381

Appendix C Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .385

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .386

Appendix D Wireformat Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .393

Backward Compatible RV Message Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394Message Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394

Appendix E TIBCO Wrapper Generation for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .399

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .400

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .401

Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .407

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 10: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

x |

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 11: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| xi

Figures

Figure 1 TIBCO Designer main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Figure 2 TIBCO Administrator GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Figure 3 IDoc in native RFC table format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

Figure 4 Doc in uncompressed “exploded” format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91

Figure 5 R3 Connections Folder Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

Figure 6 Outbound Adapter Connecting to Multiple SAP Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236

Figure 7 Outbound Adapter Registering on Multiple Program IDs on One Gateway . . . . . . . . . . . . . . . . . .237

Figure 8 RFC Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247

Figure 9 Find RFC Destinations Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248

Figure 10 RFC Destination RFCTEST Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248

Figure 11 Test Connection Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250

Figure 12 Adapter Conversion with Unicode and Non-Unicode SAP Systems . . . . . . . . . . . . . . . . . . . . . . .261

Figure 13 Map the SNC Name to the User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295

Figure 14 Maintain ACL SM30 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296

Figure 15 Work Entry Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296

Figure 16 Details for the Access Control List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297

Figure 17 SAP Adapter ALE/IDoc interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .382

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 12: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xii |

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 13: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| xiii

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

Table 2 IDoc Control Record Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Table 3 Input Parameters used in the RFC to implement BDC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Table 4 Predefined Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Table 5 Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Table 6 Output Parameters returned by the adapter to the client for each chunking request. . . . . . . . . . 213

Table 7 Encoding/Locale Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Table 8 Predefined Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Table 9 Predefined Properties in TIBCO Administrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Table 10 Trust Manager Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Table 11 SNC Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Table 12 SNC Parameters for saprfc.ini . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Table 13 SNC Parameters for RFC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Table 14 Tracing Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Table 15 Error Messages with Changed Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 14: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xiv |

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 15: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| xv

Preface

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

Topics

• Related Documents, page xvi

• Terminology and Acronyms, page xx

• Connecting with TIBCO Resources, page xxii

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 16: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xvi | Preface

Related Documents

This section lists documentation resources.

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

• TIBCO ActiveMatrix Adapter for SAP Concepts Read this manual before readingany 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 howto install TIBCO ActiveMatrix Adapter for SAP.

• TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment This manualexplains how to create and configure standalone adapter projects. Informationon deploying adapter projects is also included.

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

• TIBCO ActiveMatrix Adapter for SAP Release Notes Read this document forinformation about new features, deprecated features, and open and closedissues.

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

• TIBCO Designer™

• TIBCO Administrator™

• TIBCO ActiveMatrix BusinessWorks™

• TIBCO Rendezvous®

• TIBCO Enterprise Message Service™

• TIBCO Hawk®

• TIBCO Adapter™ SDK

• TIBCO Runtime Agent™

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 17: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Related Documents | xvii

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 UnderstandingSAP” that emphasizes the user’s point of view. Printed in 1998 by MacmillanTechnological Publishing.

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

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

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 18: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xviii | 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. Thisdirectory is referenced in documentation as TIBCO_HOME. The value ofTIBCO_HOME depends on the operating system. For example, on Windowssystems, 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 installedinto different installation environments. The directory into which such productsare installed is referenced in documentation as ENV_HOME. The value ofENV_HOME depends on the operating system. For example, on Windowssystems the default value is C:\tibco.

code font Code font identifies commands, code examples, filenames, pathnames, andoutput 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 ofparticular interest.

• In command syntax, to indicate the default parameter for a command. Forexample, 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 ActiveMatrixBusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain severalportlets. 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

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 19: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Typographical Conventions | xix

Keycombinations

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

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

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

The tip icon indicates an idea that could be useful, for example, a way to applythe 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

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 20: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xx | Preface

Terminology and Acronyms

Term Definition

ABAP Advanced Business Application Programming is a language in SAP used towrite 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 setof interfaces. TIBCO ActiveMatrix Adapter for SAP has two kinds ofcomponents; r3Outbound and r3Inbound. r3Outbound encapsulatesfunctionality for outbound communication with the SAP system whiler3Inbound encapsulates the functionality for inbound communication withthe 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 the SAP system.Inbound instances transfer messages from the TIBCO environment to SAP.

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

JMS JAVA Messaging Service

MBCS Multi-byte character string.

One WayInvocation protocol

One way invocation protocol allows you to invoke the BAPI/RFC in the SAPsystem 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.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 21: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Terminology and Acronyms | xxi

RV TIBCO Rendezvous™ protocol; also in certain contexts refers to reliablemessage 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 anexternal 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 processRFCs/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.

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

Manager Transaction Identifier Manager.

Term Definition

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 22: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

xxii | Preface

Connecting with TIBCO Resources

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

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

http://docs.tibco.com/TibcoDoc

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

• For an overview of TIBCO Support, and information about getting startedwith 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 username, you can request one.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 23: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 1

Chapter 1 Introduction

This chapter provides an introduction to TIBCO ActiveMatrix Adapter for SAP.

Topics

• Overview, page 2

• Configuration, page 4

• Deployment, page 9

• Adapter Project Lifecycle, page 11

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 24: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

2 | Introduction

Overview

TIBCO ActiveMatrix Adapter for SAP (the adapter) enables SAP systems toseamlessly integrate with the rest of the enterprise in a TIBCO environment - asuite of products to integrate applications within the enterprise, to reach partnersbeyond the enterprise, and to connect with other enterprises.

FeaturesThe adapter supports the following SAP integration interfaces:

• BAPI (Business Application Programming) — BAPIs are the methodsexposed by SAP business objects. This interface is best used with the adapterfor performing real time queries and updates to and from the SAP system.BAPIs are SAP's recommended integration interface over RFCs (RemoteFunction Call).

• RFC (Remote Functions Call) — The RFC interface allows non-SAP and SAPapplications to execute SAP Advanced Business Application Programming(ABAP) functions that have been RFC-enabled. They are similar to BAPIs infunctionality but are not attached to SAP Business Objects.

• ALE/IDoc (Application Link Enabling/Intermediate Documents) — IDocsare document containers for business transactional data, such as sales orders(example: ORDERS01) and order invoices (example: INVOIC02). ALE helpsachieve cross-business functionality and facilitates the event driven,asynchronous exchange of information directly out of business transactions.

The adapter functions as an ALE/RFC/BAPI client and server interface to SAP. Itprovides the following services:

• Publication Service — This service is used to publish IDocs from the SAPsystem to the TIBCO environment.

• Subscription Service — This service is used to subscribe to messages from theTIBCO environment and post them into the SAP system.

• Request-Response Invocation Service — This service is used to receive RFCsand BAPIs from the SAP system and invokes them as requests in the TIBCOenvironment.

• Request-Response Service — This service is used to execute RFC and BAPIrequests in the SAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 25: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Overview | 3

TID Manager Service

The TID Manager service prevents duplicate processing of IDocs and tRFCs incase of communication errors that occur when an IDoc or tRFC is executed in theSAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 26: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

4 | Introduction

Configuration

TIBCO Designer, the design-time component, is an easy-to-use graphic userinterface. The TIBCO ActiveMatrix Adapter for SAP palette in TIBCO Designer isused to create adapter instances, configure adapter services, download schemasfrom your SAP system, and save the resulting configuration in a project.

Before using TIBCO Designer, make sure you read the TIBCO Designer productdocumentation.

The following figure shows the TIBCO Designer interface.

Figure 1 TIBCO Designer main window

Design

Configurationpanel

Menu bar

Projectpanel

panelPalette

panel

Tool bar

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 27: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration | 5

Project Panel

Each TIBCO Designer window contains one and only one project, which isrepresented as the root folder in the panel.

Projects are the key organizational principle for the configuration information youspecify. A project is a collection of all configured resources. Resources are thecomponents of a project. For example, an adapter publication service is aresource. Resources can be complex and contain other resources, much like afolder can contain other folders on your computer file system. Together, theseresources make up your integration project. The top-level (root) folder in theproject tree panel represents a project. The top-level folder is initially namedUntitled and is renamed to the name of the project when you save the project forthe first time.

Most adapter resources have context-sensitive help available for the configurationof that resource. Right-click on the resource and choose What Is This? from thepopup menu for more information on configuring the resource.

An adapter project contains the following folders:

• AESchemas Folder

The AESchemas folder is the default location for all TIBCO ActiveEnterpriseschema files. Each schema file contains a collection of classes, scalars,associations, unions, and sequences.

• Adapter Services Folder

The Adapter Services folder contains services available to the adapter. Mostadapters include publication, subscription, request-response, andrequest-response invocation services.

• Advanced Folder

The Advanced folder contains resources created by TIBCO Designer while theadapter is configured. For example, each time you add a service to an adapter,a session and endpoint are created and stored in the Advanced folder. Otherresources such as advanced logging resources are accessed directly from thefolder. Adapter developers typically do not access resources in this folder.Most of the adapter configuration is done by changing resources that areavailable from the Adapter Services folder.

Palette Panel

Palettes organize resources and allow you to add them into your project. Palettesare available from the palette panel in TIBCO Designer. Resources are visiblecomponents in a palette. You select resources in the palette panel anddrag-and-drop them into the design panel to add them to your project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 28: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

6 | Introduction

Each adapter you install adds one or more palettes during installation. Whichpalette is displayed depends on the resource selected in the project tree and onyour preferences. In the default view, the current selection in the project treedetermines which palettes are displayed in the palette panel.

Design Panel

The design panel displays the current resource selected in the project tree panel.For resources that contain other resources, the contents of the selected resourceare shown in the design panel. For example, if you select a folder, its contents aredisplayed.

Configuration Panel

The configuration panel allows you to specify configuration options for theselected resource. The type and the purpose of the resource determine thecontents of the configuration panel. There are usually one or more tabs in theconfiguration panel that allow you to access the various configuration options.The tabs provide an organization to the options for the resource.

You can click the question mark icon (?) in the top right corner of theconfiguration panel for online help on the current selection.

For each tab, you must click Apply and also save the project after you specifyconfiguration information before you can select another tab. If you decide you donot want to add the configuration information, click Reset before you apply anychanges to return to the previous values for each field in the tab.

ProjectsA project is a named collection of data, usually schema data, and configurationdata that is persistently stored. Each project is opened and saved in multi-fileformat, which allows the project to be used with a version control system. Itallows different developers to collaborate on a project and merge changes asneeded.

When a project is ready to be deployed, it can be created or exported in thefollowing formats:

• Enterprise Archive File

• Local Repository

• Server Repository

• ZIP Archive

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 29: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration | 7

Enterprise Archive File

An Enterprise Archive file contains information about the adapter instances andprocesses you wish to deploy. The format is used by TIBCO Administrator. TheEAR file is imported into Administrator where you can deploy, start, and managethe adapter instance on the machines of your choice.

Local Repository

A project exported to a local repository is saved in .dat format. Projects saved in.dat format should only be used for development and testing. The format can beused where data is not shared by more than one adapter. It is possible to have afew local adapters accessing a local project in read-only mode. It is, however, notpossible to have more than one local adapter accessing a local project in read andwrite mode.

Data are loaded at startup for local projects, so a local project has higher memoryrequirements.

Server Repository

A project exported to a server repository is managed by a TIBCO AdministrationServer running in a separate process, typically elsewhere on the network. One ormore adapters can communicate with a project managed by an AdministrationServer. Each can support multiple projects.

An Administration Server is identified by a name that must be unique among alladministration servers on a network. The server-based mode of operation isscalable and generally recommended for production situations. Serverrepositories allow multiple simultaneous write operations with locking,automatic updates of clients, and notification.

Data are loaded on demand for server-based projects.

ZIP Archive

A project exported to a ZIP archive is written to the location you specify as aread-only ZIP file. A project exported as a ZIP archive can be imported intoTIBCO Designer.

Version ControlTIBCO Designer allows multiple developers to work on the same project and touse file sharing (locking) or a version control system so that the same resource isnot changed by two developers at the same time. Different users can then addresources to the project and lock the parts of the project they are working on.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 30: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

8 | Introduction

TIBCO Designer creates a file that can be shared and locked for each top-levelresource, such as an adapter configuration. It does not create a file for eachresource. As a result, for example, you can lock an adapter configuration butcannot lock individual adapter services.

When an adapter service is configured, the adapter creates a corresponding set ofschema files. A warning is displayed when the files are created advising you toadd the files to your version control system. You must add the files to yourversion control system and ensure they are checked-in, otherwise your projectwill not be managed correctly by the version control system.

TIBCO Designer also creates folders for folders you create in your project. You canlock each folder as needed.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 31: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Deployment | 9

Deployment

After an integration project has been developed and tested, it is necessary todeploy the run-time components to the machines on which they will ultimatelyrun in a production environment. An adapter instance can be deployed, startedand managed using TIBCO Administrator from the Administrator web browser.

Using TIBCO Administrator, you can upload the EAR, deploy the adapter on themachine(s) of your choice, and set runtime options before deployment.Additionally you can start and stop the adapter using TIBCO Administrator.

TIBCO Administrator also provides built-in tools to monitor and manage theadapter.

TIBCO Administrator provides user, resource, and application managementmodules for adapters.

• User Management. This module allows you to set permissions for adapterusers. You define authentication, users and groups, and assign access controllists to users. This includes security for server-based projects at design-timeand for deployed applications at runtime.

• Resource Management. This module allows you to monitor machines and allrunning applications in a TIBCO administration domain. Alerts can becreated, for example, to notify an administrator if the number of processes ordisk usage exceed a certain number.

• Application Management. This module allows you to upload EnterpriseArchive (EAR) files, and create, configure, and deploy adapters. This consoleis also used to start and stop adapters.

TIBCO Administration DomainA TIBCO administration domain is installed only if you have also installed theUser Management module.

A TIBCO administration domain is a collection of users, machines, and componentsthat an administration server manages. There is only one Administration Serverfor each administration domain. Components within an administration domaincan communicate with systems outside of the domain, but the domain is theadministrative boundary of your enterprise integration project.

.See the TIBCO Administrator product documentation for more information.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 32: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

10 | Introduction

TIBCO Administration ServerThe TIBCO Administrator Server provides a central storage and distributionpoint for configuration data and schema data needed by an adapter. The server isincluded in both Administrator editions.

Each administration domain has one and only one TIBCO Administration Server.The TIBCO Administration Server is the machine process that handles the storedproject and requests to manage the TIBCO administration domain.

The TIBCO Administrator Server contains its own web server (Apache Tomcat)that can be accessed via the TIBCO Administrator GUI for configuration andmonitoring information.

TIBCO Administrator GUIYou can access the TIBCO Administration Server using the web-based TIBCOAdministrator GUI. The GUI allows you to create users and assign access toprojects managed by the Administration Server. You can invoke the GUI from anymachine in a TIBCO administration domain. The next diagram shows the GUI.

Figure 2 TIBCO Administrator GUI

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 33: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Project Lifecycle | 11

Adapter Project Lifecycle

This section describes the high-level steps required to configure and deploy anadapter. Each of these steps are described in details in subsequent chapters.Adapter projects are configured using TIBCO Designer.

Configuration

Task A Configure the Vendor Application to work with the Adapter

This task is completed as part of installing the adapter and before configuring anadapter instance for the first time.

Task B Define an Adapter Project

When starting TIBCO Designer, you create or select a project. A project containsadapter configuration information, such as the service and messaging transport touse, logging options, and other specific settings. A project is opened and saved inmuti-file format, which allows a version control system to manage the filesassociated with the project.

See Adapter Instance Options on page 37 for more information.

Task C Set Global Variables

By default each project you create in TIBCO Designer includes several globalvariables. Global variables provide an easy way to set defaults for use throughoutyour project. Default values are predefined for some of the variables. You candefine additional variables and, optionally, set their values when configuringyour adapter.

When the project is deployed and the configured adapters are run, all occurrencesof the global variable name are replaced with the global variable value.

A global variable value set in TIBCO Designer can be overridden at run-time byredefining the value in TIBCO Administrator.

See Using Global Variables on page 190 for more information.

Task D Configure an Adapter Service

The adapter supports the following services: publication, subscription,request-response, and request-response invocation.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 34: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

12 | Introduction

Task E Test the Adapter Configuration

The adapter tester can be used to verify an adapter service after it has beenconfigured. When invoked, all adapter services configured in the project aredisplayed. You select the adapter service to test, and start and stop the adapterfrom the tester. The tester window displays adapter output within the tool so youcan easily view results.

Deployment

During development, you save your design to a project. When you are ready todeploy your project to a machine, you generate an Enterprise archive file (EARfile) from TIBCO Designer. The EAR file contains information on what you wishto deploy

Task F Generate and Import an Enterprise Archive File

An Enterprise Archive file contains adapter instance configuration information,which is used by a run-time adapter. An Enterprise Archive file is generated usingTIBCO Designer and imported into TIBCO Administrator.

See Create an EAR File in TIBCO Designer on page 264for more information.

Task G Specify Deployment Information

After importing an Enterprise Archive file, the adapter can be deployed. Thisinvolves:

• Assigning adapter services to the machines in the administration domain.

• Specifying startup options for each process engine and adapter service.

See Deploy the Project on page 265 for more information.

Task H Specify Monitoring Options

Before starting the adapter you can optionally specify monitoring options,including:• Specifying alerts or TIBCO Hawk rulebases for each machine.

• Specifying alerts and TIBCO Hawk rulebases for an adapter service.

Setting log file properties for an adapter service instance.

Task I Start the Adapter

The adapter is started and stopped using the TIBCO Administrator GUI.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 35: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Project Lifecycle | 13

See Start or Stop the Adapter on page 267 for more information.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 36: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

14 | Introduction

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 37: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 15

Chapter 2 Getting Started

This chapter describes the basic steps that are required to configure and run theadapter. More details for each of the steps described here are provided later in themanual.

Topics

• Creating a Project for the Adapter, page 16

• Working with the Sample Project, page 18

• Sample Configurations, page 20

• Testing the Configurations, page 24

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 38: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

16 | Getting Started

Creating a Project for the Adapter

To begin the configuration process, you must first open a project for your adapterusing TIBCO Designer. The TIBCO Designer product documentation containsdetailed information on using TIBCO Designer, here are the general steps will getyou started.

1. Run TIBCO Designer either from the Start menu in Microsoft Windows or byexecuting the <install_dir>/bin/Designer command from the UNIX commandline.

The following screen displays.

2. Click New empty project to create a new project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 39: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Creating a Project for the Adapter | 17

3. Select UTF-8 in the TIBCO Messaging Encoding field for Unicode Adapter. Toconnect to the Unicode SAP System, you must use UTF-8 as the TIBCOMessaging Encoding.

4. Click Save.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 40: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

18 | Getting Started

Working with the Sample Project

The adapter installation provides you with a sample pre-configured projectgettingStarted, which is available in the following path,TIBCO_HOME\adapter\adr3\version_number\examples\gettingStarted\gettingStarted.dat

This section explores this sample project and presents an overview of the TIBCOActiveMatrix Adapter for SAP configuration palette.

The following Instructions show how to work with the adapter palette, save thechanges to the sample project and start up the sample adapter configurations.

1. Convert the dat file to a multi-file project.

a. Open TIBCO Designer. In the first screen that is displayed, clickAdministration. The screen is shown next.

b. Click the Convert DAT to Files icon. In the window that is displayed,browse and select gettingStarted.dat.

c. Click OK.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 41: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Working with the Sample Project | 19

2. Click the Open existing project icon from the first TIBCO Designer screen.Browse to the directory where the converted multi-file project is saved andclick OK.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 42: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

20 | Getting Started

Sample Configurations

A TIBCO ActiveMatrix Adapter for SAP Configuration is recognized by theconfiguration palette icon.

There are four sample configurations provided covering the most elementaryconfigurations:

• RFC Outbound Configuration

• RFC Inbound Configuration

• IDoc Outbound Configuration

• IDoc Inbound Configuration

RFC Outbound ConfigurationThis is a Request-Response Invocation service configuration for the RFCRFC_CUSTOMER_GET that can send out a request for customer details from theSAP system to the TIBCO environment on the message subjectRFC.CUSTOMER.GET.

1. Click on the configuration on the project panel. The top-level configurationdetails for this configuration resource are displayed.

2. To test the connectivity and messaging for Outbound RFCs, navigate to theOutbound Connection tab and specify a valid program-id, gateway host andgateway service parameters for the adapter.

3. Open the configuration in the project panel and navigate to the AdapterServices folder. This folder displays information about theRFC_CUSTOMER_GET service including the quality of service, the associatedRFC schema and the messaging subject in the Configuration, Schema andAdvanced tabs respectively.

4. Go to the Advanced tab and set the message subject toRFC.CUSTOMER.GET.

5. Save the project. This configuration is now ready to be tested.

Before you make changes, create a backup of this project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 43: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Sample Configurations | 21

For details on testing this configuration, see Outbound Connectivity Test onpage 25 and Outbound Messaging Test on page 28.

To run this example, run an additional instance of the adapter with the RFCInbound Configuration making sure the same subject name is used. This ensuresthat messages from the SAP system are acknowledged.

RFC Inbound ConfigurationThis is a Request-Response service configuration for the RFC RFC_CUSTOMER_GET

that can receive a request for customer details from the TIBCO environment onthe message subject RFC.CUSTOMER.GET. The service invokes the RFC in SAPand sends back the reply to the TIBCO environment.

1. Click on this configuration on the project panel. This displays the top-levelconfiguration details for this configuration in the configuration panel.

2. To test the connectivity and messaging for Inbound RFCs, navigate to theInbound Connection tab and specify the client connection parameters to makea dedicated connection to an SAP application server.

3. Open the configuration in the project panel and navigate to the AdapterServices folder. This folder displays information about theRFC_CUSTOMER_GET service including the quality of service, the associatedRFC schema and the messaging subject in the Configuration, Schema andAdvanced tabs respectively.

4. Go to the Advanced tab and set the message subject toRFC.CUSTOMER.GET

5. Save the project. This configuration is now ready to be tested.

For details on testing this configuration, see Inbound Connectivity Test onpage 34 and Inbound Messaging Test on page 34.

IDoc Outbound ConfigurationThis is an IDoc Publication service configuration for the basic IDoc-type MATMAS01that receives an IDoc from the SAP system and publishes it in the TIBCOenvironment on the message subject IDOC.MATMAS01.

1. Click on this configuration on the project panel. This displays the top-levelconfiguration details for this configuration in the configuration panel.

2. To test the connectivity and messaging for Outbound RFCs, navigate to theOutbound Connection tab and specify a valid program-id, gateway host andgateway service parameters for the adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 44: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

22 | Getting Started

3. Open the configuration in the project panel and navigate to the AdapterServices folder. This folder displays information about the MATMAS01 serviceincluding the quality of service, the associated IDoc schema and themessaging subject in the Configuration, Schema and Advanced tabsrespectively.

4. Go to the Advanced tab and set the message subject to IDOC.MATMAS01.

5. Save the project. This configuration is now ready to be tested.

For testing this configuration, see Outbound Connectivity Test on page 25 andOutbound Messaging Test on page 28.

IDoc Inbound ConfigurationThis is an IDoc Subscription service configuration for the basic IDoc-typeMATMAS01 that receives an IDoc from the TIBCO environment on the messagesubject IDOC.MATMAS01 and posts the IDoc into the SAP system.

1. Click on this configuration on the project panel. This displays the top-levelconfiguration details for this configuration in the configuration panel.

2. To test the connectivity and messaging for Inbound RFCs, navigate to theInbound Connection tab and specify the client connection parameters tomake a dedicated connection to an SAP application server.

3. Open the configuration in the project panel and navigate to the AdapterServices folder. This folder displays information about the MATMAS01 serviceincluding the quality of service, the associated IDoc schema and themessaging subject in the Configuration, Schema and Advanced tabsrespectively.

4. Go to the Advanced tab and set the message subject to IDOC.MATMAS01.

5. Save the project. This configuration is now ready to be tested.

For testing this configuration, see Inbound Connectivity Test on page 34 andInbound Messaging Test on page 34.

To run this example, run an additional instance of the adapter with the IdocOutbound Configuration making sure the same subject name is used. Thisensures that messages from the SAP system are acknowledged.

Convert the multi-file project to datTo test and deploy the project you have created, convert the project to dat format.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 45: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Sample Configurations | 23

To do this, once you have saved the project in the TIBCO Designer screen, exportthe multi-file project to a dat. Select Project>Export Full Project from the menu.Browse and select the location of the directory you wish to save the dat file to.Ensure that the directory is different from the multi-file project. Name the projectgettingstarted.dat and click OK.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 46: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

24 | Getting Started

Testing the Configurations

Steps to test the sample configurations are described in this section.

Starting the adapter1. Go to the <ADR3_HOME>\version_number\bin directory and open the default

launcher file provided with the installation, adr3.tra. The URL to therepository project points to the gettingStarted project already.

2. All configuration URLs are commented. Uncomment the relevantconfiguration URL and launch the adapter by providing just the executablename adr3 in the command line from the bin directory.

For example, to run the sample Outbound RFC Configuration, the configurl tobe uncommented in the launcher file is/tibco/private/adapter/RFCOutbound

3. To run the sample Inbound RFC Configuration after this, comment out theabove configurl and uncomment the configurl/tibco/private/adapter/RFCInbound

Ensure that the adapter traces are seen on the console, a message that lookslike the following,2010 Jan 22 11:23:34:298 GMT +5SAPAdapter.R3AdapterConfiguration Info [Adapter] AER3-000082Successful initialization of Adapter

Starting the Unicode adapter1. Go to the <ADR3_HOME>\version_number\bin directory and open the default

launcher file provided with the installation, adr3u.tra. The URL to therepository project points to the gettingStarted project already. If you wantto test any project, make sure to change the TIBCO Messaging Encoding toUTF-8

2. All configurationURLs are commented. Uncomment the relevantconfiguration URL and launch the adapter by providing just the executablename adr3u in the command line from the bin directory.

For example, to run the sample Outbound RFC Configuration uncomment theconfigurl in the launcher file

/tibco/private/adapter/RFCOutbound

3. To run the sample Inbound RFC Configuration after this, comment the aboveconfigurl and uncomment the following configurl

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 47: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 25

/tibco/private/adapter/RFCInbound

Ensure that the adapter traces out on the console, a message that looks like thefollowing,2010 Jan 22 11:23:34:298 GMT +5SAPAdapter.R3AdapterConfiguration Info [Adapter] AER3-000082Successful initialization of Adapter

Outbound Connectivity TestAfter the Outbound adapter is started, make sure that the SAP system canprincipally communicate with it through the RFC destination that you havedefined. The testing procedure is described next.

1. On SAP system run transaction SM59. Alternatively, you can run transactionSALE and then choose:

Application Link Enabling (ALE) >Sending and ReceivingSystems>Systems in Network>Define Target Systems for RFC Call

The following screen appears:

When starting the adapter with RFCs that contain the simple STRING datatype,differences may be observed in the log messages for the unicode and non-unicodeversions of the adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 48: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

26 | Getting Started

2. Double-click on the TCP/IP... line to expand its list of destinations. Scrolldown to find your RFC destination in the list, such as DOCTEST shown below:

3. Double-click on your RFC destination. The following screen appears.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 49: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 27

4. Change the program ID appropriately and select connection from the Testmenu. If using the unicode version of the adapter select the Unicode radiobutton available in the MDMB & Unicode tab.

5. Ensure that the program ID specified matches that specified in the adapterinstance. The program ID is case sensitive. The bottom line of the screenshould show: Connection: DOCTEST O.K.

6. The following connection performance screen is displayed and showscommunication between SAP and the adapter.

If error messages are shown, it usually means that the configurationparameters are wrong. Look into the configuration file to verify that theparameters match the environment. Then repeat the test.

If the following SAP error message appears:

Connection Error: Program Publisher not registered / Transaction

program not registered

either the adapter is not running or the Program ID names do not match.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 50: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

28 | Getting Started

Outbound Messaging Test

RFC Invocation Test

Log on to the SAP GUI and execute function SE37 as shown below,

or, select Tools>Development>Function Builder from the menu.

The Function Builder screen is displayed, as shown in the following example. Inthe Function module text entry box enter the name of the RFC function to be usedin the test.

1. Click Sngl. test to initiate execution of the RFC_CUSTOMER_GET function.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 51: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 29

The following Test Function Module screen is displayed. Specify the targetsystem and message data to be sent.

2. Enter the RFC target system identifier (which refers to the RFC destinationthat has the program ID on which the adapter is registered), customer number(KUNNR), and customer name (NAME1) into the window. The following showsan example of using DEV2 as the target system, and * wildcards (get data for allcustomer numbers and names).

3. Click the Execute Function button, to initiate transfer of the RFC messagedata.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 52: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

30 | Getting Started

You can verify that the messages were transferred and acknowledged by theadapter by observing the Result: value on the Test Function screen. To viewthe result, double-click on the icon to the right of Result:

Note that 5 RFC entries were transferred. The command window in which theadapter was executed prints the line Connection State: Available when themessages have been received.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 53: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 31

IDoc Publication Test

This section outlines an example of how to test the publication of an IDocmessage. You test the transmission of an IDoc configured to be sent on the TIBCOenvironment.

1. For example, if you have configured the logical message type MATMAS. SelectSAP menu>Tools>ALE>Master Data Distribution>CrossApplication>Material>Send.

2. Enter a value in the Material field and specify the logical system. The valueused in the example is 100-100.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 54: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

32 | Getting Started

The following two messages appear.

You can also do a publication test if you have configured SISCSO. Try to create asales order using transaction va01. For other logical message types run acorresponding transaction that creates the IDoc.

You can verify that an IDoc is actually received by the adapter and published onthe TIBCO environment by running the Rendezvous program tibrvlisten thatmonitors the subject under which the adapter publishes and displays messages asthey are published. The following is an example of the first few lines fromtibrvlisten:C:\WINDOWS\Profiles\bob\Desktop>tibrvlisten SAP.IDOC.*tibrvlisten: Listening to subject SAP.IDOC.*Received: subject=SAP.IDOC.SALoopbackIdoc-Instance1, reply=<none>,message=...

If the tibrvlisten program does not receive any IDocs, go to Monitoring menuin the transaction, bale. Check whether an IDoc was created during your testtransaction using IDoc overview or using transaction we05.

3. Set the time range for the check.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 55: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 33

4. Verify that the status is data passed to port OK.

5. Double-click on the IDoc number in the Outbound line of the IDoc list. Verifythat the IDocs requested to be sent were actually sent.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 56: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

34 | Getting Started

If not, there is still something wrong with your SAP ALE configuration. Correctthe error that is indicated by the status. If no, IDoc is created despite status “datapassed to port OK”, re-check the RFC destination.

Inbound Connectivity TestAfter the Inbound adapter is started

1. Make sure that the adapter is successfully connected to the SAP system asclient.

2. Verify the connection from SAP GUI from the SAP transaction smgw.

3. Run the transaction smgw on the SAP system.

The following screen appears:

This screen lists details of clients logged on to the SAP system.

4. Navigate to the Goto > Logged on clients menu option and make sure the TPname matches the adapter being used.

If using the unicode version of the adapter, the TP name should be adr3.

If using the non-unicode version of the adapter, the TP name should be adr3u.

5. Check for the entry adr3 in the column TP Name. If the status shows asCONNECTED, then the adapter is successfully connected to the system.

Inbound Messaging Test

RFC Invocation Test

1. Run TIBCO IntegrationManager.

2. Open the R3Examples_Instance.dat project available in the following area:TIBCO_HOME/adapter/adr3/version_number/examples

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 57: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Testing the Configurations | 35

3. Open the TIBCO IntegrationManager transform rfc_customer_get. Thefollowing screen is displayed.

4. The Customer Name (NAME1) and the Customer ID (KUNNR) are included in theMapper as input values. Invoke the request from the process.

5. See the output in the console window of the TIBCO IntegrationManagerengine.

6. The console window of the inbound instance also indicates that the requestfrom TIBCO IntegrationManager for RFC_CUSTOMER_GET was made.

7. Check for the trace message in the adapter console.

IDoc Subscription Test

Try to receive an IDoc of one of the logical message types that you haveconfigured to be sent from the adapter to the TIBCO environment. PublishMATMAS01 messages as described under IDoc Publication Test on page 31, andsubscribe to them using the Subscriber adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 58: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

36 | Getting Started

Go to IDoc overview or transaction we05 in the SAP GUI and check that the SAPsystem has received back the published IDoc.

To be certain that you received the same IDoc messages sent through the adapteronto the TIBCO environment, compare the IDoc message numbers sent with theone received. Double-click on the Total Direction Inbound text under Statusdescription. The IDoc message number received must be the number sent plusone. So, if message number 349068 was sent, you should see message number349069 on the inbound side.

If the IDoc was published but not received by the Inbound adapter, check thesubject name specified for the subscriber/consumer in the Inbound adapter’sconfiguration file.

Stopping the AdapterYou can stop the adapter using any one of the following options:

• From a command window, stop the adapter by sending the following messageon the terminate subject or terminate topic. Ensure that this is the messagespecified in the General tab. See General Tab on page 54 for details on themessage subject. The convention of the subject is%%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit with messagecontent as "now".

Example — To stop an adapter instance called IDocOutbound, available in theGettingStarted.dat, type the following command on the DOS prompt:tibrvsend domain.GettingStarted.adr3.IDocOutbound.exit "now"

Once the adapter receives the ’now’ message on the stop subject, it willcomplete any pending transactions, cleanup resources, and then terminate.

• Start TIBCO Hawk. Invoke the stopApplicationInstance() method for theadapter configuration. Check for the trace message in the adapter console.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 59: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 37

Chapter 3 Adapter Instance Options

This chapter describes the procedure to create an adapter instance and assign itservices by configuring standard settings. All configuration tasks are performedin TIBCO Designer and the information is stored in a project that is later used bythe run-time adapter. The adapter services are used to communicate with the SAPsystem.

Topics

• Overview, page 38

• Schema Support, page 39

• Adapter Instance Fields, page 41

• Configuration Task Sequence for a Publication Service, page 68

• Configuration Task Sequence for a Subscription Service, page 70

• Configuration Task Sequence for Request-Response Invocation Service onpage 72

• Configuration Task Sequence for Request-Response Service, page 74

• Adding Adapter Services, page 76

• Adding Adapter Services Automatically, page 77

• Publication Service Options, page 84

• Subscription Service Options, page 98

• Request-Response Service Options, page 113

• Configuring Schema for Adapter Services, page 119

• Saving the Project, page 124

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 60: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

38 | Adapter Instance Options

Overview

Each adapter instance must have its corresponding configuration defined. Theconfiguration is accessed whenever an adapter application is started.

Configuration is done with TIBCO Designer. Ensure that TIBCO Designer hasbeen installed before continuing (see the TIBCO Designer User’s Guide). All theadapter configuration information is saved as a project in a repository.

Configuration TasksUse the following sequence to create and configure an adapter service.

1. Start TIBCO Designer and open a multi-file project. See the TIBCO Designerdocumentation for details.

2. Drag the R3AdapterConfiguration icon from the palette panel to the designpanel. This creates an adapter named, by default, R3AdapterConfiguration.

3. Define the adapter instance by assigning a new name and select theconnection type in the Configuration tab.

4. Optionally change logging options. See Logging Tab on page 58 for details.

5. Define design-time connection options using the Design-time Connection tab.See Design-Time Connection Tab on page 45 for details.

6. Define inbound connection options if you are configuring an inboundinstance. See Run-time Inbound Tab on page 47 for details.

7. Define outbound connection options if you are configuring an outboundinstance. See Run-time Outbound Tab on page 49 for details.

8. Define both inbound and outbound connection settings if the connection type,both is selected in the Configuration tab.

9. Add a service to the adapter instance by dragging the service icon from thepalette panel and dropping it in the design panel. See Adding AdapterServices on page 76 and Adding Adapter Services Automatically on page 77for details.

10. Use the tabs of the service to set the combination of options required for theservice.

11. Save the project as a server repository project and exit TIBCO Designer.

After configuring the adapter, you must create the run-time adapter property fileand add the project name and adapter instance name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 61: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Schema Support | 39

Schema Support

The adapter uses schema to describe data received from or sent to the TIBCOenvironment.

Schemas are useful in a variety of situations, for example:

• Where several developers collaborate on an adapter application, aspecification document normally defines the data model for several relatedadapter applications. Inside the TIBCO framework, you can define a schemato serve as the data model and update it as needed.

• When the data model of the adapter changes, developers do not have toredesign the business process.

• Using Schemas in conjunction with the various mapping tools available in theTIBCO environment, you can transfer data across applications withincompatible data formats.

Using the R/3 Adapter Configuration palette in TIBCO Designer, you can connectto and extract schema definitions (any standard or custom RFC/BAPI or IDoc)directly from the SAP system. Schemas are then stored into Designer projects forrun-time use.

SAP schemas, once saved into a Designer project can be used across projects byexporting/importing the schemas from/to a project in XML format.

Unicode Adapter Configuration Palette

At design-time, a separate adapter configuration palette in TIBCO Designer existsto configure schemas from a Unicode SAP System. But, by default, the SAPadapter configuration palette in TIBCO Designer uses the palette to connect andextract schemas from the Non-Unicode SAP system.

To connect and extract schema definitions from a Unicode SAP System, performthe following steps:

1. Backup the TIBCO Designer .tra file located in the<tibco_home>\designer\version_number\bin directory.

2. Edit the folowing properties to point to the Unicode Palette folder of yourSAP installation. Make sure that you remove the default entry that points tothe Non-Unicode palette:

— tibco.env.CUSTOM_CP_EXT

— tibco.env.CUSTOM_PALETTE_PATH

— tibco.env.CUSTOM_LIB_PATH

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 62: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

40 | Adapter Instance Options

For example, if you have installed the adapter in the C: drive of your machine,edit the properties as follows:tibco.env.CUSTOM_CP_EXTC:/tibco/adapter/adr3/version_number/lib/palettesu

tibco.env.CUSTOM_PALETTE_PATHC:/tibco/adapter/adr3/version_number/lib/palettesu

tibco.env.CUSTOM_LIB_PATHC:/tibco/adapter/adr3/version_number/lib/palettesu

Also, you must ensure that these entries precede all entries.

3. Launch TIBCO Designer and you are ready to connect and extract schemadefinitions from the Unicode SAP System.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 63: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 41

Adapter Instance Fields

An R3 Adapter Configuration Resource represents an adapter instance. You canconfigure an Inbound Instance, Outbound Instance, or both.

Use the following steps to configure an adapter instance:

1. Drag and drop an R3 Adapter Configuration resource from the palette panelto the design panel.

2. If an adapter instance is being created for the first time in the project, amessage box may be displayed with the following message:

Loading R/3 Product Classes...

3. Use the following tabs to configure the adapter instance:

— Configuration Tab on page 41

— Design-Time Connection Tab on page 45

— Run-time Inbound Tab on page 47

— Run-time Outbound Tab on page 49

— Adapter Services Tab on page 51

— General Tab on page 54

— Logging Tab on page 58

— Monitoring Tab on page 63

Configuration TabThe Configuration tab can be used to configure an adapter instance.

Instance Name

Use the default name or replace it with a name of your choice.

• An instance name must use alphanumeric characters. An underscore (_)character can be used. The entire instance name must be less than 80characters. The space character cannot be used in an instance name.

• An instance name cannot use global variables.

• An instance name must be unique with respect to other adapter instances forthe same adapter in the project. The same instance name can be used to namean adapter instance for a different adapter in the same project. For example,

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 64: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

42 | Adapter Instance Options

an SAP adapter instance named TEST and a Siebel adapter instance namedTEST can coexist in the same project.

• Each instance name must be unique per adapter within a project even if eachinstance is defined in a different folder. That is, configuring same-namedadapter instances in different folders will not make their names unique.

When you create an adapter instance, the palette automatically creates severalresources for it. The names of these resources derive from the name of the instancethey belong to. Changing the adapter instance name results in an automaticregeneration of the resources names. If you manually modify any resource name,that particular name will not be automatically regenerated next time you renamethe adapter instance. The following resources in the adapter are automaticallynamed when you name the adapter instance.

• Subject name

• CM name

• CMQ name

• Ledger file

• Default Client Connections

• Default Server Connections

• Active Connection

Description

Provide information about the adapter instance that you want stored in theproject. The field is optional.

Version

The version string indicates the ActiveEnterprise (AE) format in which theadapter instance is saved. An adapter instance can be saved in AE 4.0 or AE 5.0format.

When a new adapter instance is created in TIBCO Designer 5.x, the version stringis set to AE Version 5.0. When a 4.x adapter instance is opened in Designer 5.x,the Version field is set to AE Version 4.0.

• If a 4.x adapter instance is to be run against a 4.x run-time adapter, theinstance must be saved with the Version field set to AE Version 4.0.

If you are using TIBCO Designer 5.x to modify 4.x adapter instances, changeonly features supported by the 4.x. run-time adapter and use the validationutility to verify the instance before deploying the project. The validationutility scans the project and returns warnings if any 5.0 features are defined

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 65: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 43

for 4.x adapter instances. Invoke the utility from the Project>ValidateProject for Deployment menu command in Designer.

• If a 4.x adapter instance is to be run against a 5.x run-time adapter, theVersion field should be set to AE Version 5.0.

To change versions, click the Change Version button.

Message Filter

Specify a message filter, if you have configured a message filter resource for usewith the adapter. The filter allows you to manipulate incoming and outgoing databefore sending it on the network or handing it to the target application. Filters canbe written using the TIBCO Adapter SDK. See the TIBCO Adapter SDKProgrammer’s Guide for information about writing a message filter.

Show All Tabs

Check this box to display additional tabs for configuring advanced options. If anyof the following configurations are required, this check box has to be selected:

• Configuring an adapter instance to a specific Active Connection Resource

• Configuring TID Management as remote

• Configuring a ReadIDocFromFilePlugin

• Setting Adapter Encoding (for running the adapter on Unix platforms) or theLocale (for running the adapter on Windows platform)

For instructions on setting advanced configuration parameters, see Configuringthe Adapter with Advanced Options on page 125.

R/3 Connection Type

Select the type of instance. The possible values are Inbound, Outbound, or Both.Default is Both. If you select Inbound, proceed to enter the Inbound configurationparameters in the Run-time Inbound tab. If you select Outbound, enter theOutbound configuration parameters in the Run-time Outbound tab. If you selectboth, enter configuration details in both the Run-time Inbound and Run-time

Outbound tabs.

The adapter instance type Both is a test adapter instance. It is recommended notto shift between Both to Inbound or Both to Outbound. There is no automaticmechanism to change the adapter services to reflect the change. You need tomanually delete the Publication service if the change was made from Both toInbound and vice versa.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 66: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

44 | Adapter Instance Options

An Inbound or an Outbound instance can be changed to a Both type of instance. Itis recommended that no services be configured before you change the instancetype from Both to either Inbound or Outbound.

Regardless of the R/3 Connection Type you have chosen in the ConfigurationPanel, a client connection reference and a server connection reference are createdwhenever you drag a configuration resource into the Design Panel.

For example when Outbound is selected as the R/3 Connection Type uponcreation of adapter configuration, a client connection reference is also created inthe R/3 Connections.

Conversely, when Inbound is selected, a server connection reference is created inaddition to the client connection reference.

Sample Configuration Tab Screens

The following example shows the basic configuration tabs, along with the defaultvalues. The R/3 Connection Type can be Both, Inbound or Outbound.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 67: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 45

Design-Time Connection TabUse the following steps to set up Design-Time connection options. Many of thefollowing fields make use of global variables. Click the Global Variables tab inthe project panel to enter a value for a global variable.

Application Server

The host name of the SAP system instance.

Example: sapsvr

System Number

The integer specifying the SAP Database instance.

Example:00

Client

The integer specifying the SAP client.

Example: 853

Username

Specify a valid name for logging onto the SAP system

Password

Specify a valid password corresponding to the user name.

Remember Password

If this field is not checked, the password must be entered each time the project isopened. If it is checked, the password will be stored in the project repository.

R/3 Logon Language

Select the language to be used when logging onto the SAP system. The selectedlanguage is only used at design time.

If the SAP system is behind a firewall, then the SAP router string should bementioned along with the application server name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 68: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

46 | Adapter Instance Options

Use Design-time Connection for Run-time

Select this check box to copy Design-Time parameters to the Run-Time tabs(Run-time Inbound and Run-time Outbound tabs).

Test Connection

Click Apply and click Test Connection to verify the connection parametersspecified.

• If connectivity is available, the following message box is displayed.

• If connectivity is not available, an error message with details of the error isdisplayed.

If this check box is selected, the default run-time inbound connection would not beallowed to be modified. All fields in the Run-time Inbound tab will be disabled.To add custom values in the default Run-time Inbound connection, you need toclear the Use Design-time Connection for Run-time check box.

Test the connection before proceeding with other configuration.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 69: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 47

Sample Design-time Connection Tab Screen

The following example shows the Design-time Connection tab.

Run-time Inbound TabYou can configure an Inbound Adapter Instance using the Run-time Inbound

tab. On creating an adapter instance one inbound connection is created by TIBCODesigner, and the inbound connection is of the Dedicated Application Servertype.

The inbound connection information is used as the default client connection forthe instance. By default, the default client connection is used as the clientconnection reference when creating a Subscription service or a Request-Responseservice. The Run-time Inbound tab is displayed if you have selected the R/3Connection type as Both or Inbound in the Configuration tab.

You can use the default client connection, which is a Dedicated ApplicationServer connection or specify if it is a load balancing or a saprfc.ini clientconnection.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 70: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

48 | Adapter Instance Options

The options available vary depending on the type of client connection used. Fordetails on changing default client connection to Load Balancing or saprfc.iniclient connection, refer to the following sections:

— Client Connection with Load Balancing on page 141

— Client Connection with saprfc.ini file on page 143

Application Server

The network name of the SAP application server host machine.

System Number

SAP database instance number.

Client

SAP client number.

User Name

Valid user name to log into the specified SAP client.

Password

Valid password corresponding to the user name.

R/3 Logon Language

Language to be used when logging into the SAP system. The selected language isonly used at design time.

Test Connection

Click Apply and then Test Connection to verify that valid options have beenspecified.

Inbound Connection Reference

Click Go to reference resource.. against this field to configure advance settingsfor the default connection reference.

Test the connection before you proceed with further configuration.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 71: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 49

An Inbound adapter instance can be configured with multiple client connections.For details see Adding a Client Connection on page 137.

Sample Run-time Inbound Tab Screen

In this example, an inbound connection is being configured in dedicatedapplication server mode, which is the default mode..

Run-time Outbound TabYou can configure an Outbound adapter instance using the Run-time Outboundtab. This tab is displayed only if you select Outbound as the R/3 Connection Typein the Configuration tab.

An adapter instance with multiple inbound connections can have only oneconnection, set as the default. In case of multiple inbound connections, only theconfiguration of the default inbound instance is displayed. During creation ofadapter services, the default inbound connection is used to configure connectionsrequiring inbound connectivity to the SAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 72: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

50 | Adapter Instance Options

The default type or the saprfc.ini file type can be used as the default serverconnection. See Default Server Connection on page 152 and saprfc.ini ServerConnection on page 154 for details.

The options available on the Run-time Outbound tab vary depending on the typeof server connection used. Options for the default type are detailed in this section.

Program ID

Specify a valid existing program ID that identifies the RFC Server program for theSAP system.

Gateway Service

Specify the SAP gateway service. The default value is sapgw00.

Gateway Host

Specify the gatewayHost name or IP address or router string. If there is nospecified machine acting as a gateway host, this is the same as the appserver.

RFC Trace

Specify whether the trace is on or off. Possible values are 0 or 1 only.0 denotes trace is OFF1 denotes trace is ONIf any other values are entered, an error is displayed. If you do not provide a validvalue, then it defaults to the original value. The default value is 0.

Click Apply.

Outbound Connection Reference

Click the Go to referenced resource.. button against this field to configureadvance settings for the default connection reference.

Before specifying a server connection reference ensure that the required serverconnection has been created. See Adding a Server Connection on page 151 fordetails. During creation of adapter services, the default outbound connection isused to configure connections requiring outbound connectivity to SAP.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 73: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 51

An outbound adapter instance can be configured with multiple serverconnections. For details see Adding a Server Connection on page 151.

Sample Run-time Outbound Tab Screen

In this example, an outbound connection is being configured in the default mode.

Adapter Services TabYou can change the Active Connection resource assigned to an adapter instanceand also configure TID Management for the instance using the AdapterServices tab.

An adapter instance with multiple outbound connections can have only oneconnection, set as the default. In case of multiple outbound connections, only theconfiguration of the default outbound instance is displayed.

When an Active Connection reference is modified, all connection configurationfor the adapter instance changes. See Assigning an Active Connection to anAdapter on page 136.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 74: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

52 | Adapter Instance Options

Valid Destinations

Enter valid destinations in this field. Example: tibrvd. See Configuring ValidDestinations on page 128 for details.

TID Management

All PublicationServices

By default, TID Management is set to local. If you select remote TIDManagement, the adapter requires a TIDManager instance. Specify theTIDManager Client.

All SubscriptionServices

By default, Inbound TIDManagement is turned off. To enable InboundTIDManagement, choose local or remote from the drop-down.

If you select local TIDManagement, you will need to specify the local TIDfilename.

If you select remote TIDManagement, the adapter requires a TIDManager serverto be configured. Specify the TIDManager RpcClient endpoint here which willcommunicate with the server.

TIDManager Client

The TID Management Client field is visible only if the TID Management field isset to remote. Ensure that the TIDManager client in all the adapter instancesmatches the TIDManager server in the TIDManager being used. Also ensure thatthe subject name of the TIDManager client is configured appropriately and thatthe client and the TIDManager server are on the same transport. The TIDManagerClient field displays only if the TID Management field is set to Remote.

TIDManager Client Retry Count

Specify the number of retries from the Adapter to the TIDManager server afterwhich the Adapter should conclude that the TIDServer is down.

Select local TID Management if there is only one adapter instance using theProgram IDs defined in any server connections defined in the instance. If there aremultiple instances sharing the same Program ID they must share the sameTIDManager. Else, it is not possible to ensure that data is being sent only oncefrom the SAP system.

You must select Remote TIDManagement under the following scenarios:

• if the adapter is multithreaded,

• if the adapter has multiple connections,

• if the adapter is load balanced.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 75: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 53

See Inbound TIDManagement on page 197 for details of usage of this parameter.

TIDManager Client Retry Interval

Specify the time interval in milliseconds between any two ping attempts to theTIDManager server. This will be used when the TIDManager server isunreachable.

TID filename

The TID file is used by the TIDManager to maintain state information on thetransaction IDs (TID) sent from SAP. By default, the name of the TID file istidFile.tid.The TID filename field displays only if the TID Management fieldis set to Local.

See Setting TIDManager General Options on page 203 for details on settingTIDManager Options.

Click Apply.

Sample Adapter Services Tab Screen

In this example, a valid destination is displayed along with remote TIDManagersettings.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 76: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

54 | Adapter Instance Options

General TabYou can set Termination Subject or Topic, Adapter Encoding Information, ActiveConnection Reference and Plugin details using the General tab.

Termination Subject or Topic

A message sent on the termination subject (if Rendezvous is the transport) ortopic (if JMS is the transport) stops the adapter. The default value of thetermination subject is given next.%%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit

The message should contain "now" in the body.

Example: tibrvsend domain.<project name>.adr3.<instance name>.exit

"now"

See TIBCO Rendezvous Concepts for information about specifying subject names.See the TIBCO Enterprise Message Service product documentation forinformation about publishing on a topic.

Adapter Encoding (for Unix)

Click the arrow to select the encoding to use. The following options are available.

• ASCII

• ISO8859-1, ISO8859-2, ISO8859-5, ISO8859-7, ISO8859-8, ISO8859-9

• UTF-8

• Shift_JIS (CP943)

• Shift_JIS (TIBCO)

• Shift_JIS (932)

• KSC-5601

• Big5

The adapter may support other encodings not in the pick list. See TIBCO AdapterConcepts for a list of additional encodings that can be input in this field. Note thatthe palette does not validate encoding values that are typed into the field. Thisvalue is only applicable if you want to run the adapter on any Unix platforms.The run-time adapter will throw an error if the encoding value you type is notsupported.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 77: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 55

Adapter Locale (for Windows)

Specify value in this field in case you want to run the adapter on Windowsplatform. If you do not enter any value, the system default locale of the machineon which you run the adapter will be picked up. Example: japanese_japan.932for running the adapter on a Japanese machine.

ActiveConnections Reference

Specify the name of the active connection to be assigned to the adapter. Changingthe reference of the active connection used by an adapter instance will change allclient and server connections used by the adapter. The facility to change the activereference allows you to use an existing active connection without having toreconfigure another adapter instance.

a. Click Browse Resources.. to locate the Active Connection instance.

b. Click Go to referenced resources.. to select a new client or serverconnection reference for the Active Connection. The Active Connectionfolder is displayed. Select the required connection reference resource fromthe project. The resource configuration tab displays. Browse to locate therequired server or client connection, click Apply and return to the adapterconfiguration tabs. See Setting up Connection Reference Options onpage 134 for details on setting connection references.

ReadIDocFromFile

The adapter supports plugins, which are essentially customized dynamic librariesthat are loaded by the adapter on startup. For detailed information on plugins,refer to the TIBCO Adapter SDK documentation.

The adapter packages the ReadIDocFromFile plugin. This plugin may be used tore-publish IDoc messages written to a file.

An IDoc message gets written to a file under the following circumstances:

• A Publication service or a Subscription service configuration with a list ofValid Destinations will write an IDoc message from SAP to a file if the IDocmessage's destination is not one of those configured.

• A Subscription service configuration will write an IDoc message to a file, if theSAP system gives a valid process exception. The exception could be due to

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 78: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

56 | Adapter Instance Options

invalid data etc., while posting the IDoc. In this case, the data may bemanually changed in the file and replayed later using the plugin.

You can use the ReadIDocFromFile plugin to re-publish IDocs that are in a fileformat on the file system. The plugin is available only when the adapterconfiguration type is chosen as Outbound since the plugin is always attached to aPublisher endpoint.

• IDocs received by a subscription service which do not conform to the IDocschema are written to files. The files are written in the format in which theyare transported in the TIBCO environment. Such invalid messages cannot bereplayed by the plugin and are written to a file only to avoid loss of valuabledata.

• The transport and the wire format should be set to RV and RVmsg when usingthe 10x publication mode, respectively when using the ReadIdocFromFileplugin.

• When using the ReadIdocFromFile plugin, the exploded batch mode is notavailable.

The ReadIDocFromFile plugin can be used in the following cases:

— Simulating the sending of IDocs from the SAP system.

The plugin when attached to a Publisher and invoked reads IDocs written tofiles and re-publishes them in the TIBCO environment.

— IDocs that have failed due to the correctness of the IDoc, network outagesand other problems.

IDocs meant to be posted into the SAP system from the TIBCO environmentare written to files by IDoc Subscriber instances under the conditions listedabove. The plugin can be invoked to read these files and re-publish them afterthe cause of the problem is identified and rectified. The IDoc Subscriberreceives these IDocs again and posts them into SAP. The IDoc message will bewritten to a file in the batched mode and the plugin can read and replay IDocfiles written in this mode only.

To run the adapter with the ReadIDocFromFile plugin, add -system:plugin

ReadIDocFromFile.<extension> to the application.args parameter in the.tra file.

For example,application.args -system:propFile %TIB_ADR3_HOME%/bin/adr3.tra-system:plugin ReadIDocFromFile.dll

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 79: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 57

Enabled

Select this check box to enable the plugin.

Endpoint Reference

Select the publisher endpoint to be referenced. Click the Browse resources buttonagainst this field to locate the required publisher endpoint in the Sessions folder.

If you need access to modify the configuration details of the publisher session,click the Go to referenced resources.. button.

Mode

Select the mode from the drop-down list. See Identifying the Publication Mode onpage 88 for details on the various modes.

Directory

Specify the directory path where the IDoc files are located.

Filename

Specify the filename of the IDocs. Wild cards can be specified. Characterssupported are * and ?. Wild cards can be used anywhere in the filename.

Click Apply. The ReadIDocFrom File plugin is initialized when the adapterinstance is initialized, IDoc files matching the selection criteria are read andpublished.

The plug-in ReadIDocFromFile cannot read IDoc files that containnon-ISO8859-1 character data written by the Unicode version of the adapter.

Use TIBCO ActiveMatrix BusinessWorks to read the IDoc file and republish theIDoc.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 80: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

58 | Adapter Instance Options

Sample General Tab Screen

In this example, the ReadIdocFromFile plugin has been enabled to publish all.idoc files from the adapter’s bin directory in the explode mode.

Logging Tab

Use Advanced Logging

When Use Advanced Logging is not selected (the default), you can set twostandard output destinations (sinks) for trace messages and set the tracing levelfor the roles selected.

When Use Advanced Logging is selected, you have complete control on selectingthe destinations and associating desired roles with each of the destinations.

To create and configure the sinks, select the log sinks folder under the Advancedfolder in the project panel.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 81: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 59

To create sinks, drag and drop the Generic log sink icon from the palette panelinto the design panel. From the configuration panel, select the sink type. Thefollowing are the sink types available:

— File

— Hawk

— Network

— STDIO

When File and STDIO sinks are created from the Generic log sink they offerfurther configuration options. For the File sink, the file limit, file count, and theoption to append or overwrite can be specified. When created by default, this isset to 30000 bytes, 3 and append mode respectively. For the STDIO sink, theoption to write to stdout or stderr can be selected. When created by default,stdout is selected.

The Hawk sink uses the hawk session, created and used by the adapter formonitoring purposes, to send tracing messages to the TIBCO Hawk monitor orDisplay. For details on Hawk sessions, see Using Global Variables on page 190.The configuration for the Hawk sink involves specifying the MicroAgent Name

that must be specified in the configuration panel.

The Network sink is used to publish tracing message on TIBCO Rendezvous. Theconfiguration for the network sink involves specifying the session, and the subjecton which the trace messages needs to be published.

For all the sinks, optionally the name and description for the sinks can beprovided.

Log to Standard I/O

(STDIO Sink) When selected, trace messages are displayed in the commandprompt window where the adapter is started. When not selected, trace messagesdo not display in the window.

Log File

Specify the name of the log file (log sink) to which trace messages are written.Global variables can be used to specify the location of the log file. See UsingGlobal Variables on page 190 for more information.

The roles available are Info, Debug, Warning, and Error messages. The tracemessage generated depends on the roles selected. Turning on the roles can affectthe performance of the adapter. Therefore, it is recommended that you turn on therequired roles only. Sample Outbound Log File on page 60 provides an exampleof a log file.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 82: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

60 | Adapter Instance Options

Log Info/Debug/Warning/Error Messages

Trace messages of the selected level(s) will be collected in the named log sink. Youcan configure what levels of trace messages you want logged, and where tracemessages are sent. There are three types of logs (log sinks) that you can configureto hold trace messages, corresponding to three levels (roles) of trace messages,Information, Warning and Error. A fourth level of trace messages, Debug, isreserved and should not be enabled unless requested by the TIBCO ProductSupport Group. This option writes a lot of information to the log file andsignificantly reduces the speed of the adapter.

SampleOutbound Log

File

.2010 Jun 5 16:04:57:227 SAPAdapter.SAOutboundIdoc-Instance008

Info [Adapter] AER3-000158 Adapters initialization mode: Repository

Encoding: ISO8859-1

2010 Jun 5 16:04:57:309 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000265 Creating a Server connection

2010 Jun 5 16:04:57:329 SAPAdapter.SAOutboundIdoc-Instance008Info [Configuration] AER3-000007 TID management is local

2010 Jun 5 16:04:57:347 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000103 Adding Table parameter IDOC_DATA_REC_40,Type IDOC_DATA_REC_40

2010 Jun 5 16:04:57:351 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000103 Adding Table parameterIDOC_CONTROL_REC_40, Type IDOC_CONTROL_REC_40

2010 Jun 5 16:04:57:368 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000103 Adding Table parameter IDOC_DATA, TypeIDOC_DATA

2010 Jun 5 16:04:57:372 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000103 Adding Table parameter IDOC_CONTROL,Type IDOC_CONTROL

2010 Jun 5 16:04:57:379 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000082 Successful initialization of Adapter

2010 Jun 5 16:05:02:845 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000195 Transaction createdA065E08300893B1D65E400B4

2010 Jun 5 16:05:02:849 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000167 Connection State: Pending invocation

2010 Jun 5 16:05:02:850 SAPAdapter.SAOutboundIdoc-Instance008Info [Application] AER3-000098 IDOC RFC Function invoked:IDOC_INBOUND_ASYNCHRONOUS

2010 Jun 5 16:05:02:887 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000116 Function call is transactional, TID:A065E08300893B1D65E400B4

2010 Jun 5 16:05:02:888 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000106 Table = { IDOC_DATA_REC_40 }

2010 Jun 5 16:05:02:902 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000107 Number of records in tableIDOC_DATA_REC_40 = 8

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 83: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 61

2010 Jun 5 16:05:02:902 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000106 Table = { IDOC_CONTROL_REC_40 }

2010 Jun 5 16:05:02:908 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000107 Number of records in tableIDOC_CONTROL_REC_40 = 1

2010 Jun 5 16:05:02:910 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000091 Total IDOC Count in this run: 1

2010 Jun 5 16:05:02:911 SAPAdapter.SAOutboundIdoc-Instance008Info [Application] AER3-000084 Received IDOC Name/Number/ReceivingPartner: MATMAS01/0000000000730901/PUBTEST, Count: 1

2010 Jun 5 16:05:03:014 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000085 IDOC sent in explode modetracking=#BSMjWyPDClpZbUp67WHcc4IarkxKo#

2010 Jun 5 16:05:03:109 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000166 Connection State: Available

2010 Jun 5 16:05:03:127 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000197 Transaction committedA065E08300893B1D65E400B4

2010 Jun 5 16:05:03:366 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000198 Transaction confirmed

2010 Jun 5 16:05:27:336 SAPAdapter.SAOutboundIdoc-Instance008Info [Adapter] AER3-000163 Checking for connections

The default log file name for the adapter is<projectname>.<adapterconfigurationname>.log and is written to the logs directoryspecified by the tibco.clientVar.DirTrace property configured in the adapter.tra file. The default log file name for the TIDManager is<projectname>.R3TIDManager.log. If no file name is specified, trace information isnot written to a file.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 84: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

62 | Adapter Instance Options

Sample Logging Tab Screen

In this example, the default settings of the logging options display. Standardlogging is being used, as the Use Advanced Logging box is cleared. The level oflogging has been set to include Info, Warning and Error messages.

Startup Tab

Show Startup Banner

This check box is enabled by default. The startup banner displays the run-timeadapter version, the infrastructure version on which the adapter is built, andcopyright information in the console window when the adapter is started. Clearthis check box if you do not want the startup banner to be displayed.

Metadata Search URL

This field is predefined and cannot be changed. The field specifies the locationwhere the adapter searches for base schemas. The adapter searches for anyschema that has been defined and saved at this location, and that should beloaded at startup.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 85: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 63

Sample Startup Tab Screen

Monitoring TabMany of the following fields make use of global variables. Click the GlobalVariables tab in the project panel to enter a value for a global variable.

Enable Standard Microagent

Allows you to turn on or off the standard TIBCO Hawk Microagent. The way toturn it on or off is also configurable. By clicking the globe icon, a standard checkbox or text value (true or false) can be used to turn the standard microagent on oroff.

Standard Microagent Name

This is the name for the standard microagent that will be registered with theTIBCO Hawk system. In most cases the default value is used. The InstanceIdvariable need not be set because it is automatically set at run time by the run-timeadapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 86: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

64 | Adapter Instance Options

Enable Class Microagent

Allows you to turn on or off the instance or class specific standard TIBCO HawkMicroagent. The way to turn it on or off is also configurable. By clicking the globeicon, a standard check box or text value (true or false) can be used to turn the classmicroagent on or off.

By default, the input field is populated with the global variable HawkEnabled.

Class Microagent Name

This is the name for the class microagent that will be registered with the TIBCOHawk system. In most cases the default value is used.

Default Microagent Session

This field is disabled and cannot be changed.

R/3 Adapter MicroAgent Name

The name of the adapter microagent used to configure microagents specific to theadapter. The name specified appears in the TIBCO Hawk monitoring console andthe methods associated with the microagent are made available. By default, thename is SAPAdapterMicroAgent.

R/3 Adapter MicroAgent Type

Select the type from the drop-down box. By default, it is set to local.

The session name and the corresponding session are automatically generated byTIBCO Designer. Do not change the session name or the session. However, youcan modify the session parameters if required. Navigate to the Sessions folderunder the Advanced folder to modify the session parameters.

Make sure you have set the correct parameter value for the global variables thatcorrespond to the TIBCO Hawk configuration. If the session parameters are notset properly, the microagents will not display in the TIBCO Hawk Display.

You can use microagents to supplement the monitoring information provided bythe standard logging levels capability. Examples of supplemental information thatyou can obtain with microagents include the repository URL, command linearguments used to start the adapter, and so on.

The global variable should only be used in cases where all instances of the projectshare the same behavior.

In cases where all instances do not share the same behavior, the check box optionmust be used.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 87: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Instance Fields | 65

Sample Monitoring Tab Screen

Defining a TIBCO Hawk Session

A default TIBCO Rendezvous session, HawkSession is defined in the projectwhenever a new instance of the adapter is configured. You can use this session tomonitor the adapter using TIBCO Hawk. Use the following steps to modify theparameters of this default session.

1. In the project tree panel, click the R/3 Adapter Configuration icon defined foryour adapter instance.

2. Select Advanced>Sessions>R3HawkDefault.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 88: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

66 | Adapter Instance Options

3. The default values in the Service, Network and Daemon fields are 7474, Noneand tcp:7474. Change the default values if required and click Apply. Thescreen shot of the default HawkSession is given next.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 89: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting Inbound/Outbound Instance Options | 67

Setting Inbound/Outbound Instance Options

Use both the Run-time Inbound and the Run-time Outbound tabs to configurean instance that is both outbound and inbound. Specify the type of instance in theConfiguration tab by selecting Both in the R/3 Connection Type field.

Enter both Outbound and Inbound Connection Parameters. See Run-timeInbound Tab on page 47 and Run-time Outbound Tab on page 49 for instructionson setting Inbound and Outbound configuration options.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 90: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

68 | Adapter Instance Options

Configuration Task Sequence for a Publication Service

Use the following task sequence to create and configure an adapter publicationservice:

1. Start TIBCO Designer and open a project. See the TIBCO Designer User’s Guidefor details.

2. Drag the R/3 Adapter Configuration icon from the palette panel to the designpanel. Define the adapter configuration by assigning a new name andoptionally change logging options. See Adapter Instance Fields on page 41 fordetails on defining adapter configuration settings.

3. Add a publication service to the adapter configuration by dragging the serviceicon from the palette panel and dropping it in the design panel. The fields inthe Configuration and Advanced tabs are disabled until the schema isassociated with the service as described in step 4.

4. Schema association can be carried out in the Schema tab for IDoc.

a. Navigate to the Adapter Services folder and in the Configuration tabspecify an IDoc filter and click Apply.

b. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided. The filter specified in the previous step is used to reteieve thelist of IDocs.

c. Click Select IDoc, a list of IDocs is displayed in a separate window.

d. Choose an IDoc from the list displayed and click OK. The schema of theselected IDoc is downloaded and displayed in the tab. The IDoc isdisplayed in a hierarchical manner similar to the display in the SAPsystem. Click on the nodes to expose the relationship to those nodes anddisplay the fields for those segments.

e. Services are created appropriately for the IDoc and associated with theIDoc’s schema.

5. Under the Configuration tab, set the combination of options required for yourservice. See Configuration Tab on page 84 for details.

6. Click Save.

7. Export the project to a .dat file.

The names of the fields in segments are displayed, the length is not displayed.The field lengths are available in the project’s schemas folder.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 91: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration Task Sequence for a Publication Service | 69

Assign this .dat file to the adapter property file along with the configurationname.

8. Exit Designer.

9. Create the run-time adapter property file and add the project name andadapter configuration name using the file name specified in .

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 92: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

70 | Adapter Instance Options

Configuration Task Sequence for a Subscription Service

Use the following task sequence to create and configure an adapter subscriptionservice:

1. Start TIBCO Designer and open a project. See the TIBCO Designer User’s Guidefor details.

2. Drag the R/3 Adapter Configuration icon from the palette panel to the designpanel. This creates an adapter named, by default, <name of the default

configuration>. Define the adapter configuration by assigning a new nameand optionally change logging options. See Adapter Instance Fields onpage 41 for details on defining adapter configuration settings.

3. Add a subscription service to the adapter configuration by dragging theservice icon from the palette panel and dropping it in the design panel. Thefields in the Configuration and Advanced tabs are disabled until the schema isassociated with the service as described in step 4.

4. Schema association can be carried out in the Schema tab for IDoc.

a. Navigate to the Adapter Services folder and in the Configuration tabspecify an IDoc filter and click Apply.

b. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided.

c. Click Select IDoc, a list of IDocs is displayed in a separate window.

d. Choose an IDoc from the list displayed and click OK. The schema of theselected IDoc is downloaded and displayed in the tab. The IDoc isdisplayed in a hierarchical manner similar to the display in the SAPsystem. Click on the nodes to expose the relationship to those nodes anddisplay the fields for those segments.

e. Services are created appropriately for the IDoc and associated with theIDoc’s schema.

5. Under the Configuration tab, set the combination of options required foryour service. See Configuration Tab on page 98 for details.

6. Click Save.

7. Export the project to a .dat file.

The names of the fields in segments are displayed, the length is not displayed.The field lengths are available in the project’s schemas folder.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 93: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration Task Sequence for a Subscription Service | 71

Assign this .dat file to the adapter property file along with the configurationname.

8. Save the project and exit TIBCO Designer.

9. Create the run-time adapter property file and add the project name andadapter configuration name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 94: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

72 | Adapter Instance Options

Configuration Task Sequence for Request-Response Invocation

Service

Use the following task sequence to create and configure an adapterRequest-Response Invocation service:

1. Start TIBCO Designer and open a project. See the TIBCO Designer User’s Guidefor details.

2. Drag the R/3 Adapter Configuration icon from the palette panel to the designpanel. This creates an adapter named, by default, <name of the default

configuration>. Define the adapter configuration by assigning a new nameand optionally change logging options. See Adapter Instance Fields onpage 41 for details on defining adapter configuration settings.

3. Add a Request-Response Invocation service to the adapter configuration bydragging the service icon from the palette panel and dropping it in the designpanel. The fields in the Configuration and Advanced tabs are disabled untilthe schema is associated with the service as described in step 4.

4. Schema association can be carried out in the Schema tab for RFC/BAPI.

a. Navigate to the Adapter Services folder and in the Configuration tabspecify an RFC/BAPI filter and click Apply.

b. Click Fetch RFC/BAPI to retrieve the list of RFC/BAPIs based on theRFC/BAPI filter provided.

c. Click Select RFC/BAPI, a list of RFCs/BAPIs is displayed in a separatewindow.

d. Choose an RFC or BAPI from the list displayed and click OK. The schemaof the selected RFC or BAPI is downloaded and displayed in the tab. TheRFC or BAPI details displayed is similar to the display in the SAP system.

e. Services are created appropriately for the RFC/BAPI and are associatedwith the RFC/BAPI schema.

5. Under the Configuration tab, set the combination of options required foryour service. See Configuration Tab on page 107 for details.

6. Save the project

7. Export the project to a .dat file.

Assign this .dat file to the adapter property file along with the configurationname.

8. Save the project and exit TIBCO Designer.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 95: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration Task Sequence for Request-Response Invocation Service | 73

9. Create the run-time adapter property file and add the project name andadapter configuration name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 96: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

74 | Adapter Instance Options

Configuration Task Sequence for Request-Response Service

Use the following task sequence to create and configure an adapterRequest-Response service:

1. Start TIBCO Designer and open a project. See the TIBCO Designer User’s Guidefor details.

2. Drag the R/3 Adapter Configuration icon from the palette panel to the designpanel. This creates an adapter named, by default, <name of the default

configuration>. Define the adapter configuration by assigning a new nameand optionally change logging options. See Overview on page 38 for detailson defining adapter configuration settings.

3. Add a Request-Response service to the adapter configuration by dragging theservice icon from the palette panel and dropping it in the design panel. SeeConfiguration Tab on page 113 for details. The fields in the Configuration andAdvanced tabs are disabled until the schema is associated with the service asdescribed in step 4.

4. Schema association can be carried out in the Schema tab for RFC/BAPI.

a. Navigate to the Adapter Services folder and in the Configuration tabspecify an RFC/BAPI filter and click Apply.

b. Click Fetch RFC/BAPI to retrieve the list of RFC/BAPIs based on theRFC/BAPI filter provided.

c. Click Select RFC/BAPI, a list of RFCs/BAPIs is displayed in a separatewindow.

d. Choose an RFC or BAPI from the list displayed and click OK. The schemaof the selected RFC or BAPI is downloaded and displayed in the tab. TheRFC or BAPI details displayed is similar to the display in the SAP system.

e. Services are created appropriately for the RFC/BAPI and are associatedwith the RFC/BAPI schema.

5. Under the Configuration tab, set the combination of options required foryour service.

6. Save the project.

7. Export the project to a .dat file.

Assign this .dat file to the adapter property file along with the configurationname.

8. Save the project and exit TIBCO Designer.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 97: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuration Task Sequence for Request-Response Service | 75

9. Create the run-time adapter property file and add the project name andadapter configuration name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 98: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

76 | Adapter Instance Options

Adding Adapter Services

After basic configuration of an adapter instance is complete you can add one ormore adapter services to an instance. The Adapter Services folder is automaticallycreated when an adapter instance is created.

Adapter services can be added to the adapter in two ways:

• Automatically - Using the R/3 Filters tab available at the AdapterServices folder level. See Adding Adapter Services Automatically onpage 77 for details on adding services automatically.

• Manually - Dragging adapter service resources from the palette panel to thedesign panel.

Use the following steps to add adapter services manually:

1. Drag the R3 Adapter Configuration icon from the palette panel to the designpanel.

2. In the project panel, select the Adapter Services folder.

3. Drag the required Service icon from the palette panel to the design panel.

4. Specify the options in the tabs.

For details refer to the corresponding section for the service to be added.

• Publication Service Options

• Subscription Service Options

• Request-Response Service Options

Subject names are normally defined by the system. If you manually change asubject name, you must not use SAP.IDoc as a subject since this name is used bythe system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 99: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding Adapter Services Automatically | 77

Adding Adapter Services Automatically

This section describes how to add services automatically. Use the Configurationtab from Adapter Services folder and select the required IDocs, RFCs andBAPIs. Adapter services are automatically created.

For example, go to the IDocs tab and from the list of IDocs displayed, select theUsed? check box against the IDoc MATMAS01. Two adapter services areautomatically created, one for Publication and another for Subscription.

Use the following steps to add adapter services automatically:

1. Drag the R3 Adapter Configuration icon from the palette panel to the designpanel.

2. In the project panel, select the Adapter Services folder.

R/3 Filters Specify the following options in the Configuration tab.

IDoc Filter — The IDoc filter used to restrict the number of IDocs returnedfrom the SAP system. By default, * is specified. Values like CRE*01* cannot beused, the * can appear only at the beginning or the end of the expression.Example: MAT*

RFC Filter — The RFC Filter used to restrict the number of RFCs or BAPIsreturned from the SAP system. The RFC Filter can be used to restrict thenumber based on the actual name of the RFC or BAPI. By default, RFC* isspecified. There is no restriction on the usage of *. Values like BAPI*ORDERare allowed.

RFC Group Filter — The RFC Group Filter used to restrict the number of RFCsor BAPIs returned from the SAP system. By default, * is specified. The RFCGroup Filter can be used to restrict the number based on the RFCs or BAPIsassociated to a particular set of function groups in SAP. If the function group isnot known, leave the value of the RFC Group Filter as * and specify a value inthe RFC Filter field.

To download the list of BAPIs/RFCs with namespaces, you can enter theentire name of the RFC or give a partial filter in the RFC Filter. Ensure that theRFC Group Filter is blank.

Example:

• To download a list of all BAPIs/RFCs with namespaces give RFC Filter as "/*"and leave the RFC Group Filter blank.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 100: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

78 | Adapter Instance Options

• To download an RFC with name space SAPTRX just give RFC Filter as/SAPTRX/* and leave the RFC Group Filter blank.

The character '/' is a reserved character in the TIBCO environment. To supportnamespaces, the adapter performs a literal translation and replaces '/' with'__SLASH__'

The "/" in a BAPI or a RFC name in a namespace will be replaced with"__SLASH__" at design-time and saved to project with this name.

At run-time, the adapter replaces the "__SLASH__" with the "/" character inall its interactions with the SAP system.

Example: The RFC /tibco/MY_CUSTOM_RFC will be visible in the TIBCOenvironment as __SLASH__tibco__SLASH__MY_CUSTOM_RFC.

This applies to parameters referred to by the BAPI/RFC as well.

3. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided. As the list of IDocs is retrieved, an additional tab named IDocs isdisplayed. The IDocs tab contains the list of IDocs available for selection.

The columns presented in the IDocs tab are dependent on the SAP releasecurrently being used.

4. Click Fetch RFC/BAPIs to retrieve the list of RFCs or BAPIs based on the RFCFilter and RFC Group Filter.

Example In this example IDocs and BAPIs would be retrieved as follows:

• Basic IDoc types starting with CREMAS will be retrieved. Extended IDoctypes linked with basic IDoc types starting with CREMAS will also beretrieved.

The default RFC Filter expression "*' does not download BAPI/RFCs withnamespaces.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 101: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding Adapter Services Automatically | 79

• BAPIs starting with BAPI_SALES in all available function groups will beretrieved.

IDocs TabUse the following steps to add services for selected IDocs.

1. Drag the R3 Adapter Configuration icon to the design panel.

2. In the project panel, select the Adapter Services folder and specify therequired filter criteria, then click Fetch IDocs. While the IDocs are beingfetched the IDocs tab is displayed.

3. Click the IDocs tab and proceed to select the required IDocs.

4. Click Apply. The IDocs are retrieved from the SAP system and adapterservices are created.

IDoc Tab Select the required IDocs in the IDocs tab.

Connection Type Service(s) Automatically Added

Inbound Subscription Service

Outbound Publication Service

Both Publication and Subscription Service

The list of IDocs displayed depends on the SAP R/3 Logon Language provided inthe Design-Time Connection tab in the adapter configuration. Only those IDocsmaintained in the SAP R/3 Logon Language are shown. If IDocs are not listed,make sure that IDocs exist in the SAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 102: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

80 | Adapter Instance Options

If an SAP R/3 Logon Language other than English, French, Italian, Danish, Dutch,Norwegian, Portuguese, Spanish, Finnish, and Swedish is in use, the descriptionof the IDoc may be incorrect in some cases

The fields displayed depend on the version of SAP release that is currently in use.Two possible scenarios are detailed in this section.

SAP Releases 4.x

Basic Type - The name of Basic IDoc type in SAP

Extended Type - The name of Extended IDoc type in SAP

Description - The description of IDoc in SAP

Used - Check this box to select the IDoc schema to be downloaded and forappropriate adapter services to be created.

Operation Type - The operation type. Possible values are Outbound, Inbound, orBoth. Values shown depend on the SAP R/3 Connection Type inside the adapterconfiguration.

Release 4.x? - Check this box to download IDoc schema using 4.x schema. Bydefault, it is enabled.

Release 3.x? - Check this box to download IDoc schema using 3.x schema.

When you click Apply, the IDocs are retrieved from the SAP system and adapterservices are created.

SAP Releases 3.x

IDoc Type - The name of basic or extended IDoc type in SAP.

Description - The description of IDoc in SAP.

Used - Check this box to select the IDoc schema to be downloaded and forappropriate adapter services to be created.

Operation Type - The operation type. Possible values are Outbound, Inbound, orBoth. Values shown depend on the SAP R/3 Connection Type inside the adapterconfiguration.

The sequence in which fields are displayed in the IDocs tab can be modifiedusing drag and drop.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 103: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding Adapter Services Automatically | 81

Example In this example, the list of IDocs retrieved from a 4.x SAP system is shown.

RFCs/BAPIs TabUse the following steps to add services for selected RFCs/BAPIs.

1. Drag the R3 Adapter Configuration icon to the design panel.

2. In the project panel, select the Adapter Services folder. Specify the requiredfilter criteria and click Fetch RFC/BAPIs. While the RFC/BAPIs are beingfetched the RFC/BAPIs tab is displayed.

3. Click RFC/BAPIs and then select the required RFC/BAPIs to automaticallyadd the required services.

RFC/BAPI Tab Select the required RFCs or BAPIs in the RFC/BAPI tab.

Name — The name of the RFC or BAPI. The node alongside this field can beused to obtain information on the parameters available in the RFC or BAPI. Ifthe parameter pertains to a structure (denoted by "struct") or table (denotedby "sequence"), field information for these types can be obtained byexpanding the node alongside the name of the parameter.

Type — The type of BAPI.

Direction — Direction of the BAPI parameter. The possible values are In,Out or In/Out. If the parameter is an Import parameter, the direction is In.If the parameter is an Export parameter, the direction is Out. If the parameteris a Table, the direction is In/Out.

The sequence in which fields are displayed in the RFC/BAPI tab can be modifiedusing drag and drop.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 104: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

82 | Adapter Instance Options

Used? — Check this box to select the RFC/BAPI schema to be downloadedand for appropriate adapter services to be created.

Operation Type — The operation type. Possible values are Request-ResponseInvocation or Request-Response.

Invocation Protocol — Select the appropriate Invocation Protocol in order tocreate an adapter service for a particular RFC or BAPI. Possible Invocationtypes are Request/Reply and One Way.

4. Click Apply.

Example The list of RFCs or BAPIs is grouped based on their respective function module.Using the above as an example, BAPI_SALESORDER_CREATEFROMDAT1 isinside function group 2032.

Expanding the node alongside the name allows for browsing the interface of theRFC or BAPI as shown in the following example.

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

To configure a One Way RFC/BAPI select One Way from the Invocation Protocol.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 105: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding Adapter Services Automatically | 83

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 106: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

84 | Adapter Instance Options

Publication Service Options

A publication service is used to publish an IDoc from an SAP system as a TIBCORendezvous message or TIBCO Enterprise Message Service message.

A separate Publication service is required for every IDoc that needs to bepublished. If the same IDoc must be published in different modes, a separatepublication service is required for each mode. In cases where the mode is notexplode, the service still needs to be associated with an IDoc although the IDocschema will not be used. For details on publish modes, see Identifying thePublication Mode on page 88.

You can configure publication service parameters under the following tabs:

• Configuration Tab

• Schema Tab

• Advanced Tab

Configuration TabThis is standard configuration. You can specify publication service configurationoptions using the Configuration tab.

Name — Name of the publication service.

By default, a new publication service is named PublicationService. Oncethe IDoc is selected using the Schema tab, the service name is changed toreflect the IDoc name.

Transport Type — Select the type of message transport used by the service.

— JMS indicates that JMS (Java Messaging Service) mode of transport will beused by the service. An adapter service that uses the JMS mode of transportcan communicate only with the TIBCO Enterprise Message Service server.

— Rendezvous indicates that TIBCO Rendezvous will be used to transportmessages.

The transport can be configured to use a trusted store and identity resourcefor use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous

Communication with the SAP server requires the existence of “logical systems,”the identification of IDoc “message types,” and other custom modifications usingthe SAP graphical user interface. While these are not adapter configuration issues,they must be complete before IDocs can be transmitted.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 107: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 85

sessions and JMS topics have an SSL configuration field which uses a dialog toperform SSL configuration.

To enable and configure SSL, in the Project panel, expand the Advancedfolder, then expand the Sessions folder. Select the TIBCO Rendezvoussession or JMS topic and click Use SSL?. The SSL configuration options areexplained in the online help associated with the session dialog. Click thequestion mark to display the online help.

Publish Mode — Select the appropriate publication mode. See Identifying thePublication Mode on page 88 for details.

5. If you selected Rendezvous in the Transport Type field, the followingoptions need to be specified:

Wire Format — The format in which messages are to be published. Differentoptions are displayed according to the Transport Type selected.

One of the following wire formats can be selected for sending the message.Publishers and subscribers can only send and receive data if they agree on aspecific wire format. Possible values are:

— ActiveEnterprise Message, an externally-described XML message formatsupported by the TIBCO Adapter SDK. Control information for validationis sent in the message. This format allows ActiveEnterprise components toperform extra validation on messages sent or received.

— XML, allows you to retrieve data as XML documents and metadata as XMLSchemas (XSD).

— Rendezvous Message, a self-describing message format used by TIBCORendezvous applications. Control information for validation is not sent inthe message. For Rendezvous wire format, a message of type RVMSG_RVMSG(Rendezvous 5.x) or TIBRVMSG_MSG (Rendezvous 6.x) is always sent whenthis format is selected. If a publisher sends a simple RVMSG_STRING orTIBRVMSG_STRING, an exception is passed to the subscribing application.

If the SSL configuration is used by the adapter service sessions, you shouldmanually change the configuration of the R3JmsTopicSession to SSL. Thiscan be done by selecting the Use SSL? check box in the R3JmsTopicSessionsession.

For integrating two SAP systems, the wire format and transport type for both thepublisher and subscriber must be same, otherwise an error will occur.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 108: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

86 | Adapter Instance Options

Quality of Service — Select the type of service to be used for publishingmessages. Possible values are:

— Reliable indicates reliable message delivery, where messages are receivedwithout explicit confirmation.

— Certified (default) indicates certified message receipt, which offers strongerassurances of message receipt, along with tighter control, greater flexibilityand fine-grained reporting.

6. If you selected JMS in the Transport Type field, specify the followingoptions:

Wire Format — The format in which messages are to be published. Differentoptions are displayed according to the Transport Type selected.

For JMS mode of transport only one wire format is available. Publishers andsubscribers can only send and receive data if they agree on a specific wireformat.

— XML, allows you to retrieve data as XML documents and metadata as XMLSchemas (XSD).

Delivery Mode — The delivery mode for the message. There are two optionsto choose from.

— Persistent indicates that the message will be available to a JMS client evenif the EMS server goes down.

— Non-persistent indicates that the message will not be available to a JMSclient if the EMS server goes down.

See the TIBCO Enterprise Message Service User’s Guide for more information.

Connection Factory Type — A message can be published to a topic or sent to aqueue.

— Queue indicates that a message sent to a queue is consumed by onereceiver. Each message has only one receiver though multiple receiversmay connect to the queue. The first receiver to access the queue gets themessage. The other receivers do not. This messaging model is known aspoint-to-point.

— Topic indicates that a message published to a topic is broadcast to one ormore subscribers. All messages published to the topic are received by allservices that have subscribed to the topic. This messaging model is knownas publish-subscribe.

Transactional (RVTX) quality of service is not supported.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 109: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 87

For details on JMS concepts refer to the TIBCO Enterprise Message Service User’sGuide.

7. Click Apply

See Configuring Schema for Adapter Services on page 119 for details onconfiguring data schema for adapter services. See Configuring User Exits onpage 160 for details on setting advanced options for a publisher service.

Example This example shows a publication service created for MATMAS01 IDoc.

The following example shows a publication service configured for JMS mode oftransport.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 110: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

88 | Adapter Instance Options

Identifying the Publication Mode

You can select from the publication modes available by using the drop-down boxin the Publish Mode field. The following section describe in detail each of theMode options:

Mode none

In the default interface mode, IDoc output from an SAP system is processed in thenative RFC table format. This compressed (unexploded) form uses metadata todescribe an IDoc. The IDoc data is most efficiently transmitted in this format,because no additional processing is required to expand the IDoc segments andfields. For best performance the decompression (exploding) step is left for thestage when the data is actually consumed.

IDocs of SAP System Releases 3.x and 4.x (port types 3 and 4) are supported. SAPreleases 4.x are also capable of sending IDocs in a format understandable by olderreleases, including 3.x.

For SAP releases 4.x, the IDoc contains the following records:

• EDI_DC40 (one control record)

• EDI_DD40 (multiple data records)

For SAP releases 3.x, an IDoc contains the following records:

• EDI_DC (one control record)

• EDI_DD (multiple data records)

Figure 3 shows a truncated example of 4.x IDoc data transmitted in the default“explode” mode. In this example the control record follows the data records.Note that for transmission purposes, the order is not significant to the adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 111: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 89

Figure 3 IDoc in native RFC table format

The following is an example of an XML schema for an IDoc in 3.x mode:<class name="INBOUND_IDOC_PROCESS"><attribute class="sequence[EDI_DC]" name="IDOC_CONTROL"/><attribute class="sequence[EDI_DD]" name="IDOC_DATA"/>

</class>

The following is an example of an XML schema for an IDoc in 4.x mode:<class name="IDOC_INBOUND_ASYNCHRONOUS"><attribute class="sequence[EDI_DC40]"

name="IDOC_CONTROL_REC_40"/><attribute class="sequence[EDI_DD40]"

name="IDOC_DATA_REC_40"/></class>

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 112: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

90 | Adapter Instance Options

Mode Exploded (Default)

IDocs are initially received in compressed form as RFC tables. The received IDocis expanded and serialized into a hierarchical ActiveEnterprise message structure,called the ActiveEnterprise Message format, using IDoc metadata. Figure 4 showsan IDoc in expanded format. Metadata specifies the hierarchical structure,including contained records and fields, associations between different segments,and repetition information. The ActiveEnterprise Message format is described inthe TIBCO Adapter SDK Concepts manual.

If multiple IDocs are received in a batch, then each IDoc in the batch is split fromthe other IDocs and sent individually.

The SAP system sends out data to the adapter with padded blanks wherever afield in the IDoc segment does not occupy the complete field length or a field isnot populated at all.

By default, the adapter trims off the trailing spaces from blank padded fields, andcuts out blanks-only fields.

To override this behavior and allow the adapter to pass on all fields received fromthe SAP system as is to the TIBCO environment, you can specify the followingparameter in the adapter properties file.

adr3.preserveFieldBlanks=ON

This flag causes the adapter not to trim any of the blank-padded fields or filter outempty fields coming from the SAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 113: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 91

Figure 4 Doc in uncompressed “exploded” format

Exploded Batch

Using the Batched Explode mode, the adapter sends a batch of IDocs in theexplode mode. Similarly on the subscriber side, the adapter receives the IDocs in abatch and processes them in SAP.

If the ALE outbound profile for an IDoc-type is set up to Collect IDocs, IDocsare collected within the SAP system till the packet size value is reached andthen sent to the adapter in one shot.

The Exploded Batch publication mode ensures that individual IDocs are'exploded' to a self-describing format and also maintained as a batch. The batch ofexploded IDocs is then published as one single message by the adapter.

Mode 10Xcif

The unexploded form of an IDoc is received and converted to an SAP CertifiedIntermediate Format (CIF). The IDoc message is transformed to a CIF string thatcontains Group, Segment and Field name value pairs, in an implicit hierarchicalstructure. CIF is one of SAP standards for exchanging information with non-SAPsystems.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 114: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

92 | Adapter Instance Options

If multiple IDocs are received in a batch, then each IDoc in the batch is split fromthe other IDocs and sent individually.

Mode 10Xbatched

The10X batched format is useful to offload extensive volumes of IDocs from anSAP R/3 system by first collecting them into the ALE layer, and then dispatchingthe collected IDocs in one single transaction. This achieves the best throughput forboth the SAP R/3 system, and the adapter.

If an ALE outbound profile is not set up to collect IDocs, the IDocs are sent by theSAP R/3 system immediately to the adapter, as they are created. In that case, theadapter packs each IDoc received into a batch format that contains only one IDocand then dispatches it. If more than one IDoc is received, the “batched” messagecontains a string of IDocs packed together. All control records precede the datarecords in the package.

In case of errors, if the subscription service logs the IDoc received by the publisherconfigured with the 10xcif mode, the IDoc that is logged to the file cannot bereplayed using the ReadIdocFrom plugin.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 115: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 93

Schema TabPublication services must be associated with the IDoc schema. Schema associationcan be carried out in the Schema tab.

The procedure to obtain IDocs is detailed in this section.

1. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided.

2. Click Select IDoc, a list of IDocs is displayed in a separate window.

3. Choose an IDoc from the list displayed and click OK. The schema of theselected IDoc is downloaded and displayed in the tab. The IDoc is displayedin a hierarchical manner similar to the display in the SAP system. Click on the

The following restrictions apply to the 10x modes:

• If the subscription service is configured to receive Idocs of type 10x, thetransport and the wire format should be set to RV and RVmsg, respectively.

• IDocs where the Basic IDoc type or IDoc segment names contain a slashcharacter ’/’ are not permitted.

• The transport and the wire format should be set to RV and RVmsg,respectively when using the ReadIdocFromFile plugin.

• When using the ReadIdocFromFile plugin, the exploded batch mode is notavailable.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 116: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

94 | Adapter Instance Options

nodes to expose the relationship to those nodes and display the fields forthose segments.

4. Services are created appropriately for the IDoc and associated with the IDoc’sschema.

Example In this example IDocs have been retrieved.

• The names of the fields in segments are displayed, the length is not displayed.The field lengths are available in the project’s schemas folder.

• When using the unicode version of the adapter, the sizes of the IDoc filewritten by the publication service and the subscription service are different.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 117: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 95

On selecting the required IDoc the service is created as shown in the followingscreen.

Advanced TabAdvanced options can be set for a publication service using two modes oftransport, TIBCO Rendezvous and JMS. The procedures are detailed below:

If TIBCO Rendezvous is selected in the Transport Type field (under theConfiguration tab):

You can configure the subject to be used when publishing IDocs either by usingan Endpoint Reference or by changing the subject name.

Endpoint Reference — Specify the endpoint to be used by the Publicationservice.

Click Browse to locate the endpoint reference.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 118: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

96 | Adapter Instance Options

Message Subject — Specify the subject name to be used by default whenpublishing.

1. Click Apply.

2. Click Go To to access and modify the configuration options of the endpoint, ifrequired. See TIBCO Designer Adapter Resource Management Guide for detailson configuring endpoints.

Example This example screen shows the advanced configuration options for a publicationservice created for the MATMAS01 IDoc.

If JMS is selected in the Transport Type field (under the Configuration tab):

Destination — The destination is the name on which the service publishes toa topic or sends messages to a queue if you are setting advanced options for apublication service.

Endpoint Reference — Specify the endpoint to be used by the service. ClickBrowse to locate the endpoint reference.

1. Click Apply.

• You can overwrite the subject by entering the new subject in Message

Subject field. If you are using global variables in the subject names, ensurethat they are not deleted.

• If you need to globally change the variables %%Domain%% and%%Deployment%% in the default subject name, use the Edit >Global Variablesmenu option. Ensure that the values are not set to null.

• If you need to override the subject name for a specific adapter configuration,override it by entering the required value in the Message Subject field andnot by changing the Global Variables. Once you override the subject namemanually, further updating must be carried out manually when required. Thesubject name is not generated automatically.

The advanced options are identical for all types of services using JMS as the modeof transport.

EMS administrator should define the destinations that will be used by the adapterservices. See TIBCO Enterprise Message Service documentation for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 119: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publication Service Options | 97

2. Click Go To to access and modify the configuration options of the endpoint, ifrequired. See TIBCO Designer Adapter Resource Management Guide for detailson configuring endpoints.

Example This example screen shows the advanced configuration options for a publicationservice.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 120: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

98 | Adapter Instance Options

Subscription Service Options

A subscription service is used to receive IDocs from the TIBCO environment andthen send it to the SAP system. A separate subscription service is required forevery IDoc to be sent to the SAP system.

You can configure Subscription service parameters under the following tabs:

• Configuration Tab

• Schema Tab

• Advanced Tab

Configuration TabSubscription service configuration options can be specified using theConfiguration tab.

1. Specify the following options in the Configuration tab:

Name — A unique and meaningful name for the subscriber.

Transport Type — Select the type of message transport used by the service.

— JMS indicates that JMS (Java Messaging Service) mode of transport will beused by the service. An adapter service that uses the JMS mode of transportcan communicate only with the TIBCO Enterprise Message Service server.

— Rendezvous indicates that TIBCO Rendezvous will be used to transportmessages.

In cases where the IDoc is being sent in a TIBCO Rendezvous 5.x message format,the service must still be associated with an IDoc even though the schema of theIDoc will not be used.

Communication with the SAP server requires the existence of “logical systems,”the identification of IDoc “message types,” and other custom modifications usingthe SAP graphical user interface. While these are not adapter configuration issues,they must be complete before IDocs can be transmitted.

By default a new subscription service is named SubscriptionService. Oncethe IDoc is selected using the Schema tab, the service name is changed toreflect the IDoc name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 121: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Subscription Service Options | 99

The transport can be configured to use a trusted store and identity resourcefor use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvoussessions and JMS topics have an SSL configuration field which uses a dialog toperform SSL configuration.

To enable and configure SSL, in the Project panel, expand the Advancedfolder, then expand the Sessions folder. Select the TIBCO Rendezvoussession or JMS topic and click Use SSL?. The SSL configuration options areexplained in the online help associated with the session dialog. Click thequestion mark to display the online help.

2. If you selected Rendezvous in the Transport Type field, the followingoptions need to be specified:

Wire Format — The format in which messages are to be published. Differentoptions are displayed according to the Transport Type selected.

One of the following wire formats can be selected for sending the message.Publication and Subscription services can only send and receive data if theyagree on a specific wire format. Possible values are:

— ActiveEnterprise Message, an externally-described XML message formatsupported by the TIBCO Adapter SDK. Control information for validationis sent in the message. This format allows ActiveEnterprise components toperform extra validation on messages sent or received.

— XML, allows you to retrieve data as XML documents and metadata as XMLSchemas (XSD).

— Rendezvous Message, a self-describing message format used by TIBCORendezvous applications. Control information for validation is not sent inthe message. For Rendezvous wire format, a message of type RVMSG_RVMSG(Rendezvous 5.x) or TIBRVMSG_MSG (Rendezvous 6.x) is always sent whenthis format is selected. If a publication service sends a simpleRVMSG_STRING or TIBRVMSG_STRING, an exception is passed to thesubscribing application.

If the SSL configuration is used by the adapter service sessions, you shouldmanually change the configuration of the R3JmsTopicSession to SSL. Thiscan be done by selecting the Use SSL? check box in the R3JmsTopicSessionsession.

For an IDoc being received as TIBCO Rendezvous 5.x message, the wireformat must be Rendezvous message.

The wire format and transport type for both the Publication and Subscriptionservices must be same; otherwise, an error will occur.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 122: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

100 | Adapter Instance Options

Quality of Service — Select the type of service to be used for subscribing tomessages. Possible values are:

— Reliable indicates reliable message delivery, where messages are receivedwithout explicit confirmation.

— Certified (default) indicates certified message receipt, which offers strongerassurances of message receipt, along with tighter control, greater flexibilityand fine-grained reporting.

— Distributed Queue indicates load balancing should be enabled.

See TIBCO Rendezvous Concepts for details about quality of service.

3. If you selected JMS in the Transport Type field, specify the followingoptions:

Wire Format — The format in which messages are to be subscribed. Differentoptions are displayed according to the Transport Type selected.

For JMS mode of transport only one wire format is available. Publication andSubscription services can only send and receive data if they agree on a specificwire format.

— XML, allows you to retrieve data as XML documents and metadata as XMLSchemas (XSD).

Delivery Mode — An adapter subscription service can be durable or non-durable.

— Durable indicates that the service is registered with the EMS server.Messages sent to a durable subscription service are held by the EMS serveruntil they are consumed by the service. The service can be down and expectto receive its messages when it comes back up.

— Non-durable indicates that the service is not registered with the EMSserver. Messages sent to a non-durable subscription service are not held bythe EMS server. If the service is down, it will not receive the messages thatarrived at the EMS server while the service was down.

For details, see the TIBCO Enterprise Message Service User’s Guide.

Connection Factory Type — A message can be published to a topic or sent to aqueue.

— Queue indicates that a message sent to a queue is consumed by onereceiver. Each message has only one receiver though multiple receiversmay connect to the queue. The first receiver to access the queue gets the

Transactional (RVTX) quality of service is not supported.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 123: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Subscription Service Options | 101

message. The other receivers do not. This messaging model is known aspoint-to-point.

— Topic indicates that a message published to a topic is broadcast to one ormore subscribers. All messages published to the topic are received by allservices that have subscribed to the topic. This messaging model is knownas publish-subscribe.

For details on JMS concepts refer to the TIBCO Enterprise Message Serviceproduct documentation.

4. Select the Receive IDocs in Exploded Mode check box to receive IDocs in theexploded batch format. See Identifying the Publication Mode on page 88 fordetails of the exploded batch format.

5. Click Apply.

See Configuring Schema for Adapter Services on page 119 for details onconfiguring data schema for adapter services. See Advanced Tab on page 104 fordetails on setting advanced options for a Subscriber service.

Example This example shows a subscription service created for MATMAS01 IDoc configuredusing default options.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 124: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

102 | Adapter Instance Options

The following example shows a subscription service configured for JMS mode oftransport.

Schema TabSubscription services must be associated with the IDoc schema. Schemaassociation can be carried out in the Schema tab.

The procedure to obtain IDocs is detailed in this section.

1. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided.

2. Click Select IDoc, a list of IDocs is displayed in a separate window.

3. Choose an IDoc from the list displayed and click OK. The schema of theselected IDoc is downloaded and displayed in the tab. The IDoc is displayedin a hierarchical manner similar to the display in the SAP system. Click on thenodes to expose the relationship to those nodes and display the fields forthose segments.

4. Services are created appropriately for the IDoc and associated with the IDoc’sschema.

• The names of the fields in segments are displayed, the length is not displayed.The field lengths are available in the project’s schemas folder.

• When using the unicode version of the adapter, the sizes of the IDoc filewritten by the publication service and the subscription service are different.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 125: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Subscription Service Options | 103

Example In this example IDocs have been retrieved.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 126: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

104 | Adapter Instance Options

On selecting the required IDoc the service is created as shown in the followingscreen.

Advanced TabAdvanced options can be set for a subscription service using two modes oftransport, TIBCO Rendezvous and JMS. The procedures are detailed below:

If TIBCO Rendezvous is selected in the Transport Type field (under theConfiguration tab):

1. Specify the following options in the Advanced tab:

Endpoint Reference — Specify the endpoint to be used by the Subscriptionservice.

Click Browse to locate the endpoint reference.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 127: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Subscription Service Options | 105

Message Subject — Specify the subject name to be used by default whensubscribing.

Client Connection Reference— Select the appropriate client connectionreference. By default, the client connection for that instance is used. You canpoint to a different client connection. Click Browse to locate the clientconnection reference.

2. Click Apply.

If JMS is selected in the Transport Type field (under the Configuration tab):

1. Specify the following options in the Advanced tab,

Destination — The destination is the name on which the service subscribes toa topic or receives from a queue if you are setting advanced options for asubscription service.

Endpoint Reference — Specify the endpoint to be used by the service. ClickBrowse to locate the endpoint reference.

You can overwrite the subject by entering the new subject in Message

Subject field. If you are using global variables in the subject names, ensurethat they are not deleted. If you need to globally change the variables%%Domain%% and %%Deployment%% in the default subject name, use theGlobal Variables tab to change the variable value. Ensure that the valuesare not set to null.

If you need to override the subject name for a specific adapter configuration,override it by entering the required value in the Message Subject field andnot by changing the Global Variables. Once you override the subject namemanually, further updating must be carried out manually when required. Thesubject name will not be generated automatically.

If the IDoc is to be posted to a client other than the client in the default clientconnection, the client connection reference must be changed to point to theappropriate client.

The advanced options are identical for all types of services using JMS as the modeof transport.

EMS administrator should define the destinations that will be used by the adapterservices. See TIBCO Enterprise Message Service documentation for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 128: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

106 | Adapter Instance Options

2. Click Apply.

Example This example shows the advanced configuration options for a subscriptionservice created for the MATMAS01 IDoc.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 129: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Invocation Service Options | 107

Request-Response Invocation Service Options

A Request-Response invocation service is used to invoke an Outbound RFC orBAPI from the SAP system to the adapter. A separate Request-Responseinvocation service is required for every RFC or BAPI to be invoked.

You can configure parameters under the following tabs:

• Configuration Tab

• Schema Tab

• Advanced Tab

Configuration TabUse the Configuration tab to specify transport type, quality of service andinvocation protocol to be used for the Request-Response Invocation service.

1. Specify the following options in the Configuration tab:

Name — A unique and meaningful name for the Request-ResponseInvocation service.

Transport Type — Select the type of message transport used by the service.

— JMS indicates that JMS (Java Messaging Service) mode of transport will beused by the service. An adapter service that uses the JMS mode of transportcan communicate only with the TIBCO Enterprise Message Service server.

— Rendezvous indicates that TIBCO Rendezvous will be used to transportmessages.

The transport can be configured to use a trusted store and identity resourcefor use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvoussessions and JMS topics have an SSL configuration field which uses a dialog toperform SSL configuration.

To enable and configure SSL, in the Project panel, expand the Advancedfolder, then expand the Sessions folder. Select the TIBCO Rendezvoussession or JMS topic and click Use SSL?. The SSL configuration options are

By default a new Request-Response Invocation service is namedRequest-ResponseInvocationService. Once the RFC or BAPI is selectedusing the Schema tab, the service name is changed to reflect the RFC/BAPIname.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 130: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

108 | Adapter Instance Options

explained in the online help associated with the session dialog. Click thequestion mark to display the online help.

2. If you selected Rendezvous in the Transport Type field, the followingoptions need to be specified:

Wire Format — The format in which messages are to be published. Differentoptions are displayed according to the Transport Type selected.

One of the following wire formats can be selected for sending the message.Publication and Subscription services can only send and receive data if theyagree on a specific wire format. Possible values are:

— ActiveEnterprise Message, an externally-described XML message formatsupported by the TIBCO Adapter SDK. Control information for validationis sent in the message. This format allows ActiveEnterprise components toperform extra validation on messages sent or received.

Quality of Service — Select the quality of service to be used. Possible valuesare:

— Reliable (default) indicates reliable message delivery, where messages arereceived without explicit confirmation.

— Certified indicates certified message receipt, which offers strongerassurances of message receipt, along with tighter control, greater flexibilityand fine-grained reporting.

See TIBCO Rendezvous Concepts for details about quality of service.

3. If you selected JMS in the Transport Type field, specify the followingoptions:

Wire Format — The format in which messages are to be published. Differentoptions are displayed according to the Transport Type selected.

For JMS mode of transport only one wire format is available. Publication andSubscription service can only send and receive data if they agree on a specificwire format.

— XML, allows you to retrieve data as XML documents and metadata as XMLSchemas (XSD).

If the SSL configuration is used by the adapter service sessions, you shouldmanually change the configuration of the R3JmsTopicSession to SSL. Thiscan be done by selecting the Use SSL? check box in the R3JmsTopicSessionsession.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 131: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Invocation Service Options | 109

Delivery Mode — The delivery mode for the message. There are two optionsto choose from.

— Persistent indicates that the message will be available to a JMS client evenif the EMS server goes down.

— Non-persistent indicates that the message will not be available to a JMSclient if the EMS server goes down.

Connection Factory Type — A message can be published to a topic or sent to aqueue.

— Queue indicates that a message sent to a queue is consumed by onereceiver. Each message has only one receiver though multiple receiversmay connect to the queue. The first receiver to access the queue gets themessage. The other receivers do not. This messaging model is known aspoint-to-point.

— Topic indicates that a message published to a topic is broadcast to one ormore subscribers. All messages published to the topic are received by allservices that have subscribed to the topic. This messaging model is knownas publish-subscribe.

For details on JMS concepts refer to the TIBCO Enterprise Message Service User’sGuide.

4. Click Apply.

See Configuring Schema for Adapter Services on page 119 for details onconfiguring data schema for adapter services. See Configuring MultipleConnections for Inbound Instance on page 171 for details on setting advancedoptions for a Request-Response invocation service.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 132: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

110 | Adapter Instance Options

Example This example shows a Request-Response invocation service that is configuredusing the default values.

The following screen shot shows a Request-Response invocation serviceconfigured to use JMS as the mode of transport.

Schema TabRequest-Response Invocation services must be associated with the RFC/BAPIschema. Schema association can be carried out in the Schema tab.

The procedure to obtain RFC/BAPIs is detailed in this section.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 133: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Invocation Service Options | 111

1. Click Fetch RFC/BAPI to retrieve the list of RFC/BAPIs based on theRFC/BAPI filter provided.

2. Click Select RFC/BAPI a list of RFCs/BAPIs is displayed in a separatewindow.

3. Choose an RFC or BAPI from the list displayed and click OK. The schema ofthe selected RFC or BAPI is downloaded and displayed in the tab. The RFC orBAPI details displayed is similar to the display in the SAP system.

4. Services are created appropriately for the RFC/BAPI and are associated withthe RFC/BAPI schema.

Advanced TabAdvanced options can be set for a Request-Response invocation service using twomodes of transport, TIBCO Rendezvous and JMS. The procedures are detailedbelow:

If TIBCO Rendezvous is selected in the Transport Type field (under theConfiguration tab):

You can configure the subject to be used when invoking an inbound RFC or BAPI,by changing the subject in the Advanced tab.

1. Specify the following options in the Advanced tab:

Endpoint Reference — Specify the endpoint to be used by theRequest-Response Invocation service. Click Browse to locate the endpointreference.

Message Subject — Specify the subject name to be used by default.

2. Click Apply.

You can overwrite the subject by entering the new subject in Message

Subject field. If you are using global variables in the subject names, ensurethat they are not deleted. If you need to globally change the variables%%Domain%% and %%Deployment%% in the default subject name, use theGlobal Variables tab to change the variable value. Ensure that the valuesare not set to null.

If you need to override the subject name for a specific adapter configuration,override it by entering the required value in the Message Subject field and notby changing the Global Variables. Once you override the subject namemanually, further updating must be carried out manually when required. Thesubject name will not be generated automatically.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 134: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

112 | Adapter Instance Options

If JMS is selected in the Transport Type field (under the Configuration tab):

Destination — The destination is the name on which the service publishes toa topic or sends messages to a queue if you are setting advanced options for apublication service. The destination is the name on which the servicesubscribes to a topic or receives from a queue if you are setting advancedoptions for a subscription service.

Endpoint Reference — Specify the endpoint to be used by the service. ClickBrowse to locate the endpoint reference.

1. Click Apply.

Example This example shows the advanced configuration options for a Request-ResponseInvocation service.

The advanced options are identical for all types of services using JMS as the modeof transport.

EMS administrator should define the destinations that will be used by the adapterservices. See TIBCO Enterprise Message Service documentation for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 135: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Service Options | 113

Request-Response Service Options

A Request-Response service is used to invoke an Inbound RFC or BAPI, in theSAP system, from the adapter. A separate Request-Response service is requiredfor every RFC or BAPI.

You can configure parameters under the following tabs:

• Configuration Tab

• Schema Tab

• Advanced Tab

Configuration Tab1. Specify the following options in the Configuration tab:

2. By default, a Request-Response service is named Request-Response

Service. Once the RFC or BAPI is selected using the Schema tab, the servicename is changed to reflect the RFC/BAPI name.

Name — A unique and meaningful name for the Request-Response service.

Transport Type — Select the type of message transport used by the service.

— JMS indicates that JMS (Java Messaging Service) mode of transport will beused by the service. An adapter service that uses the JMS mode of transportcan communicate only with the TIBCO Enterprise Message Service server.

— Rendezvous indicates that TIBCO Rendezvous will be used to transportmessages.

The transport can be configured to use a trusted store and identity resourcefor use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvoussessions and JMS topics have an SSL configuration field which uses a dialog toperform SSL configuration.

To enable and configure SSL, in the Project panel, expand the Advancedfolder, then expand the Sessions folder. Select the TIBCO Rendezvoussession or JMS topic and click Use SSL?. The SSL configuration options areexplained in the online help associated with the session dialog. Click thequestion mark to display the online help.

If the SSL configuration is used by the adapter service sessions, you shouldmanually change the configuration of the R3JmsTopicSession to SSL. Thiscan be done by selecting the Use SSL? check box in the R3JmsTopicSessionsession.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 136: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

114 | Adapter Instance Options

Quality of Service — Select the quality of service to be used. Possible valuesare:

— Reliable (default) indicates reliable message delivery, where messages arereceived without explicit confirmation.

— Certified indicates certified message receipt, which offers strongerassurances of message receipt, along with tighter control, greater flexibilityand fine-grained reporting.

— Distributed Queue indicates load balancing should be enabled.

See TIBCO Rendezvous Concepts for details about quality of service.

3. Click Apply.

See, Configuring Schema for Adapter Services on page 119 for details onconfiguring data schema for adapter services. See Advanced Tab on page 116 fordetails on setting advanced options for a Request-Response service.

If the service is to be invoked as request/reply invocation protocol, thequality of service should be Reliable. If it is to be invoked as one way

invocation protocol the quality of service should be Certified. If the adapterinstance is to be load-balanced with other similarly configured inboundinstances the quality of service should be Distributed Queue.

If the SAP system expects a response from the adapter, the invocation protocolshould be configured as request/reply. If no reply is expected, the protocolshould be set to oneway.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 137: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Service Options | 115

Example This example shows a Request-Response service that is configured using thedefault values.

The following screen shot shows a Request-Response service configured to useJMS as the mode of transport.

Schema TabRequest-Response services must be associated with the RFC/BAPI schema.Schema association can be carried out in the Schema tab.

The procedure to obtain RFC/BAPIs is detailed in this section.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 138: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

116 | Adapter Instance Options

1. Click Fetch RFC/BAPI to retrieve the list of RFC/BAPIs based on theRFC/BAPI filter provided.

2. Click Select RFC/BAPI a list of RFCs/BAPIs is displayed in a separatewindow.

3. Choose an RFC or BAPI from the list displayed and click OK. The schema ofthe selected RFC or BAPI is downloaded and displayed in the tab. The RFC orBAPI details displayed is similar to the display in the SAP system.

4. Services are created appropriately for the RFC/BAPI and are associated withthe RFC/BAPI schema.

Advanced TabAdvanced options can be set for a Request-Response service using two modes oftransport, TIBCO Rendezvous and JMS. The procedures are detailed below:

If TIBCO Rendezvous is selected in the Transport Type field (under theConfiguration tab):

When invoking an RFC or BAPI in the SAP system the subscribed subject mustmatch the subject on which the request is being sent. You can configure the subjectto be used when invoking an inbound RFC or BAPI, either by using an EndpointReference or changing the subject.

1. Specify the following options in the Advanced tab:

Endpoint Reference — Endpoint to be used by the Request-Response service.Click Browse to locate the endpoint reference.

Message Subject — Subject name to be used by default.

Client Connection Reference — Select the appropriate client connectionreference. By default, the client connection for that instance is used. You can

You can overwrite the subject by entering the new subject in Message

Subject field. If you are using global variables in the subject names, ensurethat they are not deleted. If you need to globally change the variables%%Domain%% and %%Deployment%% in the default subject name, use theGlobal Variables tab to change the variable value. Ensure that the valuesare not set to null.

If you need to override the subject name for a specific adapter configuration,override it by entering the required value in the Message Subject field and notby changing the Global Variables. Once you override the subject namemanually, further updating must be carried out manually when required. Thesubject name will not be generated automatically.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 139: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Request-Response Service Options | 117

point to a different client connection.Click Browse to locate the client connection reference.

Commit Required — If an external commit is required select this check box;else, leave it unchecked.

Commit Expiry(ms) — If an external commit is required specify the time (inmilliseconds) after which the commit expires. Default is 60000 ms (oneminute).

Logon Required — If the RFC or BAPI being invoked in the SAP systemrequires explicit, check this box; else, leave it unchecked. See Event DrivenInbound Connections on page 242 for details.

If JMS is selected in the Transport Type field (under the Configuration tab):

Destination — The destination is the name on which the service publishes toa topic or sends messages to a queue if you are setting advanced options for aPublication Service. The destination is the name on which the servicesubscribes to a topic or receives from a queue if you are setting advancedoptions for a subscription service.

EMS administrator should define the destinations that will be used by theadapter services. See TIBCO Enterprise Message Service documentation fordetails.

Endpoint Reference — Specify the endpoint to be used by the service. ClickBrowse to locate the endpoint reference.

2. Click Apply.

3. Click Go To to access the configuration options of the endpoint reference orthe client connection reference.

If the RFC or BAPI needs to be invoked for a client other than the onereferenced in the default client connection, the client connection referencemust be modified to point to the appropriate client.

The advanced options are identical for all types of services using JMS as the modeof transport.

The invocation protocol for an RFC or BAPI cannot be determined using theproperties available in the Request-Response service.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 140: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

118 | Adapter Instance Options

Example This example shows the advanced configuration options for a Request-Responseservice.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 141: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Schema for Adapter Services | 119

Configuring Schema for Adapter Services

Adapter services must be associated with the IDoc or RFC/BAPI schema. Schemaassociation can be carried out in the Schema tab for IDoc or RFC/BAPI schemadepending on the type of service.

Use the following steps to configure adapter service schema.

1. Drag the required adapter service icon from the palette panel to the designpanel, then click Schema. The tab displayed depends on the type of service. Inthe case of publication and subscription services IDoc schema can beobtained. In the case of Request-Response invocation and Request-ResponseRFC or BAPI schema can be obtained. The procedure for both is detailed inthis section.

Schema Tab IDoc

a. Click Fetch IDocs to retrieve the list of IDocs based on the IDoc filterprovided.

b. Click Select IDoc, a list of IDocs is displayed in a separate window.

c. Choose an IDoc from the list displayed and click OK. The schema of theselected IDoc is downloaded and displayed in the tab. The IDoc isdisplayed in a hierarchical manner similar to the display in the SAPsystem. Click on the nodes to expose the relationship to those nodes anddisplay the fields for those segments.

d. Services are created appropriately for the IDoc and associated with theIDoc’s schema.

RFC/BAPI

a. Click Fetch RFC/BAPI to retrieve the list of RFC/BAPIs based on theRFC/BAPI filter provided.

b. Click Select RFC/BAPI a list of RFCs/BAPIs is displayed in a separatewindow.

c. Choose an RFC or BAPI from the list displayed and click OK. The schemaof the selected RFC or BAPI is downloaded and displayed in the tab. TheRFC or BAPI details displayed is similar to the display in the SAP system.

d. Services are created appropriately for the RFC/BAPI and are associatedwith the RFC/BAPI schema.

The names of the fields in segments are displayed, the length is not displayed.The field lengths are available in the project’s schemas folder.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 142: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

120 | Adapter Instance Options

Example 1 In this example IDocs have been retrieved.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 143: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Schema for Adapter Services | 121

On selecting the required IDoc the service is created as shown in the followingscreen.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 144: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

122 | Adapter Instance Options

Example 2 In this example RFCs/BAPIs have been obtained.

On selecting RFC_LOGIN and clicking OK the service is configured as shown inthe following screen.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 145: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Schema for Adapter Services | 123

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 146: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

124 | Adapter Instance Options

Saving the Project

Configuration information for an adapter instance and all other parametersettings related to the adapter instance are saved as a TIBCO Designer project.You can save the project any time during configuration. Each time you save aproject, any configuration information you have entered is saved as a multi-fileproject.

For details on saving a project, see the TIBCO Designer User’s Guide.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 147: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 125

Chapter 4 Configuring the Adapter with AdvancedOptions

This chapter explains how to configure the adapter using advanced options.

Topics

• Overview, page 127

• Configuring Valid Destinations, page 128

• Adding Connections to an Adapter, page 130

• Adding an Active Connection, page 132

• Adding a Connection Reference, page 134

• Adding a Client Connection, page 137

• Dedicated Application Server Client Connection, page 139

• Client Connection with Load Balancing, page 141

• Client Connection with saprfc.ini file, page 143

• Setting Client Connection Advanced Options, page 145

• Adding a Server Connection, page 151

• Default Server Connection, page 152

• saprfc.ini Server Connection, page 154

• Setting Server Connection Advanced Options, page 156

• Sample saprfc.ini Files, page 158

• Configuring User Exits, page 160

• Saving an IDoc to a Directory, page 162

• Publishing IDocs on Dynamic Subjects, page 167

• Replacing Control Fields, page 169

• Configuring Multiple Connections for Inbound Instance, page 171

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 148: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

126 | Configuring the Adapter with Advanced Options

• Configuring Multiple Connections for Inbound Instance, page 171

• Configuring Multiple Connections for Outbound Instance, page 175

• Load Balancing Using Distributed Queue, page 178

• Using Global Variables, page 190

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 149: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Overview | 127

Overview

This chapter describes advanced configuration options available in the adapterpalette so that you can refine and enhance various adapter operations.

Connections required by an adapter are created by default as described in theprevious chapter on adapter configuration. You can however use advancedoptions to create new connection references, add and configure server and clientconnections. You can also maintain advanced client configuration options.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 150: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

128 | Configuring the Adapter with Advanced Options

Configuring Valid Destinations

The Adapter Services tab can also be used to specify a list of destinations towhich the IDocs will be sent. This list of destinations applies globally to all IDoctypes that are sent from the SAP system or to the SAP system. Typically, thesedestinations are SAP logical system names, but they can be a bank identifier, acustomer identifier, or any Partner Type currently configured.

The RCVPRN field of an IDoc's control record specifies the receiving partner(destination) for the IDoc. If an IDoc's RCVPRN field has a value that is notconfigured as a valid destination, the IDoc is not published to the TIBCOenvironment. The IDoc will be logged (saved) into an ASCII text file under theconfigured directory. For details on how to save IDoc under a directory, seeSaving an IDoc to a Directory on page 162.

To configure valid destinations,

1. Make sure you have the publication or subscription services defined beforeconfiguring any valid destinations.

2. In the Adapter Services tab, enter the valid destinations in the ValidDestinations field. The screen is shown next.

3. To add a new entry in the list, enter the name of the valid destination in the listseparated by comma.

4. Click the Apply button.

As entries get saved, they are automatically converted to uppercase. This isdone to ensure consistency with the syntax of logical systems in SAP.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 151: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Valid Destinations | 129

5. Click the Apply button to apply your changes.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 152: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

130 | Configuring the Adapter with Advanced Options

Adding Connections to an Adapter

You can modify the default connections or create additional connections to suityour requirements. When an adapter instance is created, a basic set of connectionsare created depending on whether the adapter instance is Inbound, Outbound orBoth. These Connections can be shared by adapter instances in the same project.

The default connections created for an adapter instance that is both Inbound andOutbound are listed in the next table:

When an adapter instance is created, if no other adapter instance exists, an R3

Connections folder is created under the project folder. The hierarchy of the R3Connections folder will be as follows:

Figure 5 R3 Connections Folder Hierarchy

Client Connections folder - For client connection information shared by allclients. In this case, clients are SAP clients. A client connection folder cancontain individual client connection information. A default client connectionis created when an adapter instance is created.

Connection Type Default Name

Client Connection R3AdapterConfigurationInboundConnection

Server Connection R3AdapterConfigurationOutboundConnection

Active Connection R3AdapterConfigurationActiveConnections

Connection Reference clientConnectionReference

serverConnectionReference

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 153: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding Connections to an Adapter | 131

Server Connections folder - For server connection information shared by theserver. By server, we mean SAP server. A default server connection is createdwhen an adapter instance is created.

Client folder - For SAP client information. A default client is created when anadapter instance is created.

R3AdapterConfiguratioActiveConnections folder - For Connection Referenceinformation indicating the default active server or client connection. Defaultconnection references to a client connection and a server connection are alsocreated by default.

You can carry out the following connection configuration:

• Adding an Active Connection

• Adding a Connection Reference

• Adding a Client Connection

• Adding a Server Connection

The following sections describe each of these connection resources in detail.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 154: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

132 | Configuring the Adapter with Advanced Options

Adding an Active Connection

All connections maintained inside an adapter instance are configured using theActive Connection Resource available from the palette panel.

When you configure an adapter instance, an Active Connection instance is createdby default with reference to one client connection and one server connection. Ifthe default configuration does not meet your requirements, you can modify theexisting Active Connection instance or create a new one. An appropriate referenceto the Active Connection instance must be provided in the adapter instance.

For details on associating an adapter instance with an Active ConnectionReference, see Assigning an Active Connection to an Adapter on page 136.

Setting up Active Connection Configuration OptionsUse the following steps to add and configure an Active Connection.

1. Select R3Connections in the project panel. Drag and drop anActiveConnection icon from the palette panel to the design panel.

2. Specify the following options in the Configuration tab:

ConfigurationTab

Name — Specify a unique and meaningful name for the Active Connection.By default, the Active Connection folder is namedR3AdapterConfigurationActiveConnections. You can change it to a name ofyour choice.

Description — Enter a brief description.

3. Click Apply.

After creating an Active Connection instance, the next step is to create referencesfrom the Active Connection to the required client or server connections.

See Adding a Connection Reference on page 134.

ExampleThis example shows the basic active connection folder screen. The activeconnection folder has been assigned a name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 155: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding an Active Connection | 133

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 156: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

134 | Configuring the Adapter with Advanced Options

Adding a Connection Reference

A Connection Reference is used to associate a particular client or serverconnection inside an Active Connection. On creating an adapter instance, twodefault connection references are created. One points to the client connectioncreated by default on creation of the adapter instance and the second points to theserver connection created by default on creation of the adapter instance. Ifmultiple client or server connections are being maintained you must specify oneof each type as the default.

You can configure Connection reference parameters using the Configuration tab.

Setting up Connection Reference OptionsDefault Connection References are automatically created when you configure anadapter instance. If additional connection references are required, use thefollowing steps to create them.

1. Drag an ActiveConnection icon from the palette panel to the design panel.

2. Drag and drop a ConnectionReference icon from the palette panel to thedesign panel. The Configuration tab displays.

3. Specify the following options in the Configuration tab:

ConfigurationTab

Name — Assign a unique and meaningful name to the Active Connection. Bydefault the name is ConnectionReference. You can change this to a name ofyour choice.

Referenced Connection — Enter the client or server connection to bereferenced by the Active Connection. Click Browse to locate the requiredclient or server connection.

See Adding a Client Connection on page 137 and Adding a Server Connectionon page 151, for details on configuring client connection and serverconnection parameters.

Ensure that client connections and server connections have been created prior tocreating connection references. See Adding a Client Connection on page 137 andAdding a Server Connection on page 151 for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 157: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding a Connection Reference | 135

Default connection — Select this check box if the specified ReferencedConnection needs to be set as the default client connection or serverconnection for the associated adapter instance.

4. Click Apply.

5. If you need to view or modify the client connection or server connectionparameters, click Go To. The display changes to the Configuration tab of theconnection specified.

ExampleThis example shows a connection reference configuration created by default forclient connections.

If multiple client or server connections have been referenced, only oneconnection per type can be set as the default for that particular type.

Ensure that when any connection reference is made Default (by selecting theDefault Connection check box), the default connection is made the top mostchild under the Active Connection folder.

If there is a combination of Server Connection References and Client ConnectionReferences, make sure that the default Server Connection Reference is at the top(first) of all Server Connection References and default Client ConnectionReference is at the top (first) of all Client Connection References. Making theDefault Connection Reference the top element can be achieved by Sorting. Fordetails on sorting, refer to TIBCO Designer documentation.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 158: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

136 | Configuring the Adapter with Advanced Options

Assigning an Active Connection to an AdapterAs described earlier, a default Active Connection instance is created when anadapter instance is created. A reference pointing to the Active Connection is alsocreated in the adapter instance, by default.

In cases where a different Active Connection is required, an appropriate referencemust be set up in the adapter instance.

To associate an adapter instance with an Active Connection Reference, do thefollowing:

1. Select the General tab.

2. Click Browse resources.. against the Active Connection Reference field.

3. Select the required Active Connection from the Select a Resource Window.Click OK and click Apply. The screen shot is given next.

It is recommended that you associate one instance with one active connection.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 159: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding a Client Connection | 137

Adding a Client Connection

Client connections can be of three types:

• Dedicated Application Server Client Connection

• Client Connection with Load Balancing

• Client connection with saprfc.ini file

A client connection of the Dedicated Application Server type is created by defaultwhen you configure an Inbound adapter instance. You can add client connectionsas per your configuration needs, choosing from the three types available.

Use the Configuration Tab to select the type of client connection you want toconfigure.

Selecting Client Connection TypeUse the following steps to select the required client connection type.

1. Select the Client Connections folder in the project panel. You can specify aName for the folder and enter the Description in the Configuration tab.

2. Drag and drop a ClientConnection icon from the palette panel to the designpanel.

3. Select the ClientConnection type in the Configuration tab:

Additional client connections are required in cases where an adapter instancemust connect to multiple SAP application servers or clients. Each applicationserver or client would have its own client connection.

Client connections requiring gateway hosts different from that of the applicationserver are not supported. The workaround is to use client connections inconjunction with saprfc.ini.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 160: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

138 | Configuring the Adapter with Advanced Options

ConfigurationTab

Select Connection Type — Select the type from the drop-down list. Thepossible types are:

— Dedicated Application Server Client Connection

— Client Connection with Load Balancing

— Client Connection with saprfc.ini file

4. Click Apply. The appropriate configuration panel displays. A Client isautomatically created in the Clients folder using the configurationinformation provided in the Client Connection, only if the ClientConnection is configured.

5. The name of the client is derived from the client connection name. However,advanced configuration for the client is maintained in the client.

In cases where a dedicated connection is required and the gateway server hostdiffers from the application server, you must select saprfc.ini file as theClientConnection type.

Make a note of the client name for future reference in case advancedconfiguration is required.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 161: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Dedicated Application Server Client Connection | 139

Dedicated Application Server Client Connection

A client connection can be configured for a specific SAP application server.

Use the following tabs to configure Dedicated Application Server ClientConnection parameters.

• Configuration Tab

• Advanced Tab

Configuring Dedicated Application Server Client ConnectionA Dedicated Application Server is created by default when you configure anadapter instance. You can add connections as required.

Use the following steps to configure a Dedicated Application Server clientconnection.

1. Select the client connection type as Dedicated Application Server, to displaythe Inbound Connection tab.

2. Specify the following options in the Configuration tab:

ConfigurationTab

Application Server — The network name of the host SAP application servermachine.

System Number — The SAP database instance number.

Client — The SAP client number.

User name — Specify a valid user name to log into the SAP client specified

Password — Specify a valid password corresponding to the user name.

R/3 Logon Language — Select the language to be used when logging into theSAP system. The selected language is only used during design time.

3. Click Apply.

4. Click the Advanced tab to access advanced configuration parameters. SeeSetting Client Connection Advanced Options on page 145.

5. Click Test Connection to verify the connection configuration settings.

ExampleIn this example a client connection of the dedicated application server has beenconfigured.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 162: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

140 | Configuring the Adapter with Advanced Options

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 163: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Client Connection with Load Balancing | 141

Client Connection with Load Balancing

Use the following tabs to configure a client connection that uses load balancing.

• Configuration Tab

• Advanced Tab

Configuring Client Connection with Load BalancingDuring creation of the client connection, you can specify the client configurationtype as Load Balancing. To use load balancing, the client machine initiating therequest must have a service named sapmsXXX defined on the system, where XXX isthe value of systemName. The default service value is 3600/tcp, and can bechanged.

Stagger the start time for adapter instances when starting multiple adapterinstances using the same SAP Logon group.

Use the following steps to configure a client connection that uses load balancing.

1. Drag a ClientConnection icon from the palette panel to the design panel.

2. Select Load Balancing from the Select Client Connection Type

drop-down combo box.

3. Click Apply. The Configuration tab is displayed.

4. Specify the following options in the Configuration tab.

ConfigurationTab

System Name — The SAP/R3 system ID used in conjunction with loadbalancing. For example, TIB.

Msg Server — The message server used in conjunction with load balancing.For example, SAPSVR.

Logon Group — The SAP logon group that is used in conjunction with loadbalancing. For example, PUBLIC.

Client — The SAP client number.

User Name — Valid user name for logging into the specified SAP client.

Password — Valid password corresponding to the user name.

In the SAP system, names of Logon Groups are case sensitive.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 164: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

142 | Configuring the Adapter with Advanced Options

R/3 Logon Language — Language to be used when logging into the SAPsystem. The selected language is only used during design time.

5. Click Apply.

6. Click the Advanced tab to configure advanced parameters.See, Setting Client Connection Advanced Options on page 145.

7. Click Test Connection to verify the connection configuration settings.

ExampleIn this example a client connection of the load balancing type has beenconfigured.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 165: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Client Connection with saprfc.ini file | 143

Client Connection with saprfc.ini file

A client connection can be configured to use a saprfc.ini file.

Use the following tabs to configure a client connection with the saprfc.ini file.

• Configuration Tab

• Advanced Tab

Configuring Client Connection with saprfc.ini FileDuring creation of the client connection, you can specify the client connectiontype as saprfc.ini. If selected, the saprfc.ini file is used.

• The file must exist in the current working directory of the process making theconnection request.

or

• An environment variable named RFC_INI must be defined that points to thedirectory and filename.

The filename does not have to be saprfc.ini. Assuming that the file wasnamed tibco.txt and it was located under the temp directory on the C drive,the environment variable would be defined with the valueC:\temp\tibco.txt.

Use the following steps to configure a client connection that uses the saprfc.inifile.

1. Drag a ClientConnection icon from the palette panel to the design panel.

Select Saprfc.ini file from the Select Client Connection Type drop-down box.

In cases where a dedicated connection is required and the gateway server hostdiffers from the application server, you must select saprfc.ini file as theClient Connection type.

2. Click Apply.

3. Specify the following options in the Configuration tab:

Since the adapter requires configuration from the repository, it isrecommended that the INI file be used during the early stages of developmentand test. By using the INI file to define the connection parameters, you avoidmaking changes in the repository which may take longer compared to editingthe INI file itself.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 166: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

144 | Configuring the Adapter with Advanced Options

ConfigurationTab

Destination — The destination application server name. Used in conjunctionwith the saprfc.ini file, the name defines the set of attributes to be retrievedfrom the INI file during the registration of the connection to SAP.

Client — The SAP client number.

User Name — Specify a valid user name to log into the SAP client specified.

Password — Specify a valid password corresponding to the user name.

R/3 Logon language — Specify the language to be used when logging into theSAP system.

4. Click Apply.

5. Click the Advanced tab to configure advanced parameters.See, Setting Client Connection Advanced Options on page 145.

ExampleIn this example a client connection has been configured to use the saprfc.ini

file.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 167: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting Client Connection Advanced Options | 145

Setting Client Connection Advanced Options

Use the following steps to set up advanced client connection options.

1. Click the Advanced tab to enter advanced configuration information.

2. Specify the following options in the Advanced tab:

Advanced Tab Number of Reconnect Attempts Before Suspending Impacted Service(s) —The number of times the connection management process tries to connect tothe application before the listener for a subscription or a one-wayRequest-Response invoke service is suspended. The default value for this fieldis 1.

Maximum number of Reconnect Attempts — The maximum number of timesthe adapter will retry to establish a connection to the SAP system. By default,it is set to 3. This has to be greater than or equal to the value in the Number of

retries before suspend field. For retry to continue forever, set the value to-1.

Interval Between Reconnect Attempts (milliseconds) — The time intervalbetween two successive retries, in milliseconds. The default value is 30000ms.

Adapter Termination Criteria (after max number of reconnect attempts) —This field is relevant for Inbound configurations connected to multiple SAPsystems. This field indicates whether the adapter should stop after allattempts to reconnect are exhausted for just one SAP system or all SAPsystems. This field is not relevant for Outbound configurations.

— First Service indicates that the adapter should stop after all retry attemptsto connect to just one SAP system are exhausted.

— Last Service indicates that the adapter should stop only after retry attemptsto connect to all SAP systems are exhausted.

The default setting is First Service.

Max Connections — The number of SAP connections in the client connection.By default, it is set to 1. A maximum of 99 connections is allowed.

The advanced properties options are identical for all three types of clientconnections.

The Adapter Termination Criteria (after max number of reconnect

attempts) setting is applicable only when an Inbound configuration is connectedto multiple SAP systems.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 168: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

146 | Configuring the Adapter with Advanced Options

The Max Connections option is used to configure the maximum number ofthreads in the adapter instance.

Startup Connectionless — Select this check box if you do not require toconnect to the SAP system during initialization of the adapter. If this checkbox is selected, connection to the SAP system is made when the messagearrives.

3. Select the Is Unicode check box if this connection is to a Unicode SAPsystem.

This step is not mandatory. The run-time adapter is capable of dynamicallydetecting if the target SAP system is Unicode or not. However, this results in aloss of performance during connection time. Check this flag to avoid this lossin performance.

4. Click Apply.

ExampleThe example displays the advanced client connection options.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 169: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting up Client Configuration Options | 147

Setting up Client Configuration Options

A Client is automatically created as a result of the Client Connection

configuration process. There are two ways to modify Client configurationinformation.

— Modify the Client Connection information

— Directly modify the Client configuration

However, advanced Client configuration must be configured directly under theAdvanced tab of Client configuration.

Use the following tabs to configure client parameters:

• Configuration Tab

• Advanced Tab

Use the following steps to configure SAP Clients:

1. Select the Client folder in the project panel.

2. Specify the following options in the Configuration tab:

ConfigurationTab

Name — The name derived from the client connection instance associatedwith this client.

Description — A description of the client.

Client — The SAP client number. This number must exist in the SAP system.

User Name — Specify a valid user name to log into the SAP client specified

Password — Specify a valid password corresponding to the user name.

R/3 Logon Language — Select the language to be used when logging into theSAP system.

3. Click Apply.

4. Click the Advanced tab to configure advanced properties.

ExampleThis example shows the configuration options of a client during creation of aclient connection.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 170: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

148 | Configuring the Adapter with Advanced Options

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 171: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting Advanced Client Options | 149

Setting Advanced Client Options

You can specify the tracing and debugging parameters for an SAP client usingadvanced options. This option can be used to carry out debugging of RFCs fromthe SAP GUI.

It is recommended that you install the SAP GUI on the same machine as theadapter.

Use the following steps to set tracing and debugging parameters at the SAP level:

1. Click the Advanced tab.

2. Specify the following options:

Advanced Tab RFC Trace — Indicate whether the trace is on. Possible values are 0 or 1. Bydefault, set to 0.

ABAP Debug — Indicate whether the debug is on. Possible values are 0 or 1. Bydefault, set to 0.

Use SAPGUI — Indicate whether the trace or debug is on. Possible values are0, 1, or 2. Default value is 0

.

3. Click Apply.

Value Significance

0 The corresponding trace or debug is turned OFF

1 The corresponding trace or debug is turned ON.

The user has to be a dialog user to connect to the SAP system.

2 The corresponding trace or debug is turned on, but launching ofthe SAP GUI occurs only during the invocation of an RFC.

If other values are entered, an error message appears. If a valid value is notprovided, the original value is used.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 172: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

150 | Configuring the Adapter with Advanced Options

The trace files are generated in the working directory of the adapter. This is set inthe adr3.tra file using the parameterapplication.start.dir=C:/Tibco/adapter/adr3/version_number

In case you want the files to be generated into a separate directory you can definean environment variable RFC_TRACE_DIR and assign its value as the directory ofyour choice. Beware, that in this case, you will not be able to put trace files ofseparate instances into separate folders as only the value assigned toRFC_TRACE_DIR will always be picked.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 173: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adding a Server Connection | 151

Adding a Server Connection

Server connections can be of two types, default or saprfc.ini file. A serverconnection of the default type is created automatically when you configure anoutbound adapter instance. You can add server connections as per yourrequirements, choosing from the two types available.

Use the following tab to select the type of server connection you need toconfigure.

• Configuration Tab

Selecting Server Connection TypeUse the following steps to create a server connection and select the connectiontype.

1. Select Server Connections in the project panel, specify a unique andmeaningful Name for the server connection and enter the Description in theConfiguration tab.

2. Drag and drop a ServerConnection icon from the palette panel to the designpanel.

3. Select the connection type in the Configuration tab:

ConfigurationTab

Select Connection Type — Select the type from the drop-down list. Thepossible types are:

— Default Server Connection

— saprfc.ini Server Connection

4. Click Apply, the appropriate Configuration tab is displayed.

The following sections provide instructions on configuring the two types ofserver connections.

Multiple server connections are required in those cases where an outboundadapter instance needs to connect to multiple Gateway Host servers or connect toSAP system using multiple Program IDs. SeeMultiple Connections, page 235 andChapter 6, Advanced Features for details on multiple Program IDs.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 174: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

152 | Configuring the Adapter with Advanced Options

Default Server Connection

Use the following tabs to configure Default Server Connection parameters.

• Configuration Tab

• Advanced Tab

Configuring Default Server ConnectionUse the following steps to configure a default server connection.

1. Drag a ServerConnection icon from the project panel to the design panel.

2. Select the server connection type as Default.

3. Click Apply.

4. Specify the following options in the Configuration tab:

ConfigurationTab

Program ID — A valid existing program ID defined in the RFC destination

inside the SAP system (sm59). The program ID identifies the RFC serverprogram for the SAP system. For details on configuring multiple program IDssee Multiple Connections on page 235.

Gateway Service — The SAP gateway service. The default value is sapgw00.

On Microsoft Windows: A corresponding entry (e.g., sapgw00 3300/tcp)must also be in the services file on the computer’s C: drive at the followingdirectory location: WINDOWS\system32\drivers\etc

Gateway Host — The gatewayHost name, IP address or router string. If thereis no machine acting as a gateway host, it is the same as the application server.

RFC Trace — Indicate whether the trace is on or off. Possible values are 0 or 1only. By default the value is 0.0 - trace is turned OFF.1 - trace is turned ON.If any other values are entered, an error is displayed. If you do not provide avalid value, then it defaults to 0.

5. Click Apply.

6. Click the Advanced tab to set advanced configuration parameters.

See Setting Server Connection Advanced Options on page 156.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 175: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Default Server Connection | 153

ExampleIn this example, a server connection is being configured in the default mode.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 176: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

154 | Configuring the Adapter with Advanced Options

saprfc.ini Server Connection

The server connection can be configured to use the saprfc.ini file.

Use the following tabs to configure Server Connection with saprfc.ini file.

• Configuration Tab

• Advanced Tab

Configuring Server Connection with saprfc.iniUse the following steps to configure a server connection that uses the saprfc.inifile.

1. Select Server Connections in the project panel, enter the Name andDescription of the Server Connections folder in the Configuration tab.

2. Drag and drop a Server Connection icon from the palette panel to the designpanel, the Configuration tab is displayed.

3. In the Server Connection Type field, select saprfc.ini file.

4. Click Apply.

5. Specify the following option in the Configuration tab.

ConfigurationTab

Destination — The destination application server name. Used in conjunctionwith the saprfc.ini file, it defines the set of attributes to be retrieved fromthe INI file during registration of the connection to SAP .

6. Click Apply.

7. Click the Advanced tab to set advanced configuration parameters. See SettingServer Connection Advanced Options.

See Sample saprfc.ini Files on page 158 for samples files.

ExampleIn this example a server connection that uses the saprfc.ini file has beenconfigured.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 177: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

saprfc.ini Server Connection | 155

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 178: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

156 | Configuring the Adapter with Advanced Options

Setting Server Connection Advanced Options

The Advanced tab is used to configure the connection retry management forServer Connections.

1. Click the Advanced tab in the Configuration panel.

2. Specify the following options in the Advanced tab:

Advanced Tab Maximum Number of Reconnect Attempts — The maximum number oftimes the adapter will retry to establish a connection to the SAP system. Bydefault, it is set to 3. For retry to continue forever, set the value to -1.

Interval Between Reconnect Attempts (milliseconds) — The time intervalbetween two successive retries, in milliseconds. The default value is 30000ms.

Adapter Termination Criteria (after max number of reconnect attempts) —This field is relevant for Inbound configurations connected to multiple SAPsystems. This field indicates whether the adapter should stop after allattempts to reconnect are exhausted for just one SAP system or all SAPsystems. This field is not relevant for Outbound configurations.

— First Service indicates that the adapter should stop after all retry attemptsto connect to just one SAP system are exhausted.

— Last Service indicates that the adapter should stop only after retry attemptsto connect to all SAP systems are exhausted.

The default setting is First Service.

Max Connections — The number of outbound SAP connections in the serverconnection. By default, it is set to 1. A maximum of 99 connections is allowed.The Max Connections option is used to configure the maximum number ofthreads in the adapter instance.

3. Click Apply.

The Stop on Retry Fail setting is applicable only when an Inboundconfiguration is connected to multiple SAP systems.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 179: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting Server Connection Advanced Options | 157

ExampleIn this example advanced options for a server connection are displayed.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 180: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

158 | Configuring the Adapter with Advanced Options

Sample saprfc.ini Files

The following sample demonstrates using the saprfc.ini file for:

• Register RFC Server programs

• Connect RFC Client programs to SAP

Refer to the SAP Documentation accompanying your SAP installation foradditional information.

Example: Registering an RFC Server Program ExampleThe following parameters register an RFC server program at an SAP gateway, inSAP using transaction SM59. To reference the block, the destination field in theserver connection should be defined as DEST-TIB-R. See Configuring ServerConnection with saprfc.ini on page 154 for details.DEST=DEST-TIB-RTYPE=RPROGID=UseAUniqueProgramIDGWHOST=sapsvrGWSERV=sapgw00RFC_TRACE=0

It is important to note that if PROGID is not defined, the value of DEST is usedinstead.

The RFC server program is registered as follows:

• Program ID is UseAUniqueProgramID

• SAP gateway is sapsvr

Using Logon Groups to Connect an RFC Client to SAP ExampleThe next parameter connects an RFC Client program to SAP using logon groups.In SAP using transaction SMLG, the logon group defined is SPACE

The SAP System ID (SID) is TIB and the message server is sapsvr.

In this example, there is no RFC tracing since RFC_TRACE is defined with a valueof 0.

In this example, there is no RFC trace and ABAP debugging since RFC_TRACEand ABAP_DEBUG are defined with a value of 0.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 181: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Sample saprfc.ini Files | 159

To reference the parameters given below, the destination field in the clientconnection should be defined as DEST-TIB-B. See Configuring Client Connectionwith Load Balancing on page 141 for details.

Note that if R3NAME is not defined, the value of DEST is used instead.DEST=DEST-TIB-BTYPE=BR3NAME=TIBMSHOST=sapsvrGROUP=SPACEABAP_DEBUG=0USE_SAPGUI=0

Using a Dedicated Application Server to Connect an RFC Client Program toSAP

The parameters given below connect an RFC Client program to SAP using adedicated application server.

The application server is sapsvr and the system number is 00.

Similar to the load balancing example, there is no RFC trace and ABAPdebugging.

To reference the parameters given below, the destination field in the clientconnection should be defined as DEST-TIB-A. See Configuring DedicatedApplication Server Client Connection on page 139 for details.

In this example, it is assumed that running on the same machine as theapplication server is a gateway service. If this is not the case, you need to definethe additional parameters GWHOST and GWSERV. These parameters are similar to theones available under Registered RFC Server programs (see Using Logon Groupsto Connect an RFC Client to SAP Example on page 158).DEST=DEST-TIB-ATYPE=AASHOST=sapsvrSYSNR=00RFC_TRACE=0ABAP_DEBUG=0USE_SAPGUI=0

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 182: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

160 | Configuring the Adapter with Advanced Options

Configuring User Exits

This feature is used to perform user-defined operations on IDocs beforepublishing or after subscribing from the TIBCO environment.

Configuring User Exit for Publication ServiceTo associate a User Exit operation to a publication service, the check box in theAdvanced tab of the Publication service should be selected and the correspondingoperation should also be associated.

If you define an operation and associate it to a particular service, the operation isinvoked and its results are used for posting to the TIBCO environment.

The defined operation is invoked by the adapter after receiving the IDoc messagefrom SAP and converting it into a format corresponding to the configuredpublication mode.

If the User Exit operation is configured for Request-Response, the reply from theUser Exit is published. In case of Oneway operations, the adapter just invokes theremote operation and does not publish data in the TIBCO environment.

1. User Exits — Select the User Exits check box for this publication service.

2. RPCClient — Choose the RPC Client from the reference field for making theinvocation. Only RPC Clients are listed. Do not select RPC Clients associatedwith adapter services.

3. In the Operation Name field, specify the name of the operation.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 183: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring User Exits | 161

4. From the Invocation Protocol drop-down list, select the type of invocation.Choose between oneway or request/reply.

You must enter values in all the fields to create a new operation and to savethe user exit information in the project. See TIBCO ActiveMatrix Adapter forSAP Examples Guide for an example of User Exit.

Configuring a User exit for a Subscription ServiceTo associate a user exit operation to a subscription service, the check box in theAdvanced tab of the particular service should be selected and the correspondingoperation should also be associated.

If you define an operation and associate it to a particular service, the operation isinvoked and its results are used for posting to SAP.

Configuration of user exit on the inbound side is similar to the outbound side. Fordetails, see Configuring User Exits on page 160. The screen shot is given next.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 184: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

162 | Configuring the Adapter with Advanced Options

Saving an IDoc to a Directory

An IDoc message gets written to a file under the following circumstances:

• When a Publication service or a Subscription service receives an IDoc whosedestination is not there in the list of valid destinations.

• A Subscription service configuration will write an IDoc message to a file, if theSAP system gives a valid process exception. The exception could be due toinvalid data etc., while posting the IDoc. In this case, the data may bemanually changed in the file and replayed later using the ReadIDocFromFileplugin. This file can be configured to be written under a required directory.

Configuring IDoc Logging DirectorySteps to configure an IDoc logging directory are given next.

1. Navigate to the Advanced tab of the Subscription service as shown in the nextscreen.

2. In the Log Idoc To Directory field, enter the directory in which these files areto be saved.

Each of the IDocs will be written to a unique file. The name of the file is createdaccording to the following syntax:

Filename = IdocType_DateTimeStamp_IdocCount.idoc

Validation of the directory will not be done during design-time. If this field is notpopulated, the ASCII text file will be logged in the current working directory ofthe adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 185: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Saving an IDoc to a Directory | 163

For example, MATMAS01_20030825114438762_1.idoc

These ASCII files may be manually replayed, if necessary, using theReadIDocFromFile plugin. For more information, see General Tab on page 54.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 186: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

164 | Configuring the Adapter with Advanced Options

Configuring Reporting

This feature enables the adapter to report adapter processing errors, applicationerrors or informational messages about successful posting of messages to the SAPsystem for all one way inbound scenario.

This includes:

• Subscription service messages posted in the SAP system as IDocs

• Oneway Request-Response service messages invoked in the SAP system asRFCs

• Oneway Request-Response service messages invoked in the SAP system astRFCs

Configuring Subscription Services for Reporting1. Select the Advanced tab of the service.

2. Select the Confirmation Required check box. A Confirm Publisher

reference field is displayed.

3. Create a publisher endpoint under the Advanced->Sessions-><anysession> with required transport, quality of service and subject attributes.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 187: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Reporting | 165

4. Associate this publisher endpoint to the Subscription service by referring tothis endpoint in the Confirm Publisher reference field. The screen shot isgiven next.

Configuring Request-Response Services for Reporting1. Select the Advanced tab of the service.

2. Select the Confirmation Required check box. A Confirm Publisher

reference field is displayed.

3. Create a publisher endpoint under the Advanced->Sessions-><anysession> with required transport, quality of service and subject attributes.

It is recommended to configure a reporting publisher endpoint under a dedicatedsession, rather than the same session as the Subscription service.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 188: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

166 | Configuring the Adapter with Advanced Options

4. Associate this publisher endpoint to the Request-Response service byreferring to this endpoint in the Confirm Publisher reference field. Thescreen shot is given next.

Even though the confirm publisher reference is displayed for configuration fornon oneway protocol Request-Response services, the feature is available atrun-time for Request-Response services in oneway protocol only.

It is recommended to configure a reporting publisher endpoint under a dedicatedsession, rather than the same session as the Subscription service.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 189: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Publishing IDocs on Dynamic Subjects | 167

Publishing IDocs on Dynamic Subjects

You can configure the adapter to publish an IDoc on a dynamic subject name andspecify the dynamic subject using a special notation. Before the adapter publishesan IDoc, it constructs the subject name by using the contents of the control recordof the IDoc.

An IDoc control record contains the following fields, which are listed inalphabetical order in Table 2:

Use these names to specify a dynamic subject name. To use a control record fieldname within a dynamic subject name, you must surround the control record fieldname with two $ characters. For example, to use RCVPRN control record field,you must use $RCVPRN$ within a dynamic subject name. Some examples aregiven below:MYSUBJECT.$MANDT$$RCVPRN$.$DOCNUM$

$TABNAM$.TEST

MARY.$SNDPRN$.IDOC

To configure dynamic subject names do the following:

Table 2 IDoc Control Record Fields

ARCKEY CIMTYP CREDAT CRETIM STD

DIRECT DOCNUM DOCREL DOCTYP STDMES

EXPRSS IDocTYP MANDT MESCOD STDVRS

MESFCT MESTYP OUTMOD RCVLAD TEST

RCVPFC RCVPOR RCVPRN RCVPRT TABNAM

RCVSAD REFGRP REFINT REFMES

SERIAL SNDLAD SNDPFC SNDPOR

SNDPRN SNDPRT SNDSAD STATUS

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 190: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

168 | Configuring the Adapter with Advanced Options

1. In the Advanced tab of the Publication service, enter the dynamic subjectnames in the Message Subject field. The screen shot is given next.

2. Click Apply.

The adapter scans the dynamic subject name and replaces the control recordfield names (such as $SNDPRN$, $DOCNUM$, and so on) with actual values fromthe control record of the IDoc. The resulting subject name must be a validTIBCO Rendezvous subject name in case of RV transport and a validdestination name in case of JMS transport.

If you specify a name that does not represent a valid control record field name,the subject name is left intact. For example, if you specify A.$XYZ$ for thedynamic subject name, the adapter leaves the subject name intact because XYZdoes not represent a valid control record field name. In short, the adapterpublishes under the subject A.$XYZ$. Some of the control record fields (of theIDoc) may be empty.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 191: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Replacing Control Fields | 169

Replacing Control Fields

Replacing control fields is a feature available for the IDoc Publication service.Using this feature you can replace the field value for the control record. Forexample you can override the receiving partner value coming from SAP withyour inputs.

Configuring control fields replacement:

1. The Advanced tab of the Publication service is shown below.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 192: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

170 | Configuring the Adapter with Advanced Options

2. Click the Control Fields button to invoke the following screen.

3. In the Name field, enter the control field record, which is to be replaced.

4. In the Value field, enter the value to be changed.

5. Click Set to add the name value pair.

6. To remove an entry from the list, choose the entry and then click Delete.

7. Click Save to apply the changes.

As entries get added to the list, the name is automatically converted touppercase. This is done to ensure consistency with the syntax of SAP system.

The name value pairs you have entered are added to the project only whenyou click Save.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 193: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Multiple Connections for Inbound Instance | 171

Configuring Multiple Connections for Inbound Instance

For an inbound instance the connections are specified at the service level. Thismeans, you can have different connections for different services. When theadapter instance is configured all the services have a default connection. You canadd new connections to the adapter and then for each service specify one of thenewly added connections.

Carry out the following steps to add a new connection.

1. Configure an inbound adapter instance.

This will create default connection for all the services. Expand theR3Connections>ClientConnections folder to view this connection. The nameof the connection will contain the adapter instance name. Similarly there willbe a reference created for this connection in the ActiveConnections folder ofthat particular adapter instance. This is the default connection and if neededthe parameters of this connection can be modified.

2. Click on the R3Connections>ClientConnections folder. Drag and drop theClientConnection icon from the palette panel to the design panel.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 194: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

172 | Configuring the Adapter with Advanced Options

3. Select the Client connection type and click Apply. Enter all the parameters forthe second connection in the Inbound Connection tab. You can specifyadvanced connection parameters in the Advanced tab. Click Apply.

4. Click on the Active Connection folder for the adapter instance. Drag and dropa ConnectionReference icon from the palette panel to the design panel.

5. Enter an appropriate name in the Name field. Click the Browse Resource iconto display the Select a Resource window.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 195: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Multiple Connections for Inbound Instance | 173

6. Select the newly created Client Connection resource. Click OK to attach theclient connection you created to this reference resource.

7. Click on the Advanced tab of the service for which this connection wascreated. In the Client Connection Reference field, click the Browse Resourceicon to display the Select a Resource window.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 196: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

174 | Configuring the Adapter with Advanced Options

8. Select the client connection for this service and click Apply to save the adapterinstance.

9. Save the adapter configuration and start the adapter. The adapter dispatchesthe calls to SAP on the connections configured for each service.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 197: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Multiple Connections for Outbound Instance | 175

Configuring Multiple Connections for Outbound Instance

Server connections are specified at the instance level. The configured services canuse all the connections created for the instance.

Carry out the following steps to add a new server connection to the adapter.

1. Configure an outbound adapter.

This will have a default connection. Expand theR3Connections>ServerConnections folder to view this connection. The nameof the connection will contain the adapter instance name. Similarly there willbe a reference created for this connection in the ActiveConnections folder ofthat particular adapter instance. This is the default connection and if neededthe parameters of this connection can be modified.

2. Click on the R3Connections>ServerConnections folder. Drag and drop theServerConnection icon from the palette panel to the design panel.

3. Select the Server connection type and click Apply. Enter all the parameters forthe second connection in the Outbound Connection tab. Specify advancedconnection parameters in the Advanced tab. Click Apply.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 198: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

176 | Configuring the Adapter with Advanced Options

4. Click on the Active Connection folder for the adapter instance. Drag and dropa ConnectionReference icon from the palette panel to the design panel.

5. Enter an appropriate name in the Name field. Click the Browse Resource iconto display the Select a Resource window.

6. Select the newly created Server Connection resource. Click OK to attach theserver connection you created to this reference resource.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 199: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Configuring Multiple Connections for Outbound Instance | 177

7. Save and start the adapter instance. Now whenever you start the adapter itwill act as an RfcServer and create connections for all SAP application servers.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 200: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

178 | Configuring the Adapter with Advanced Options

Load Balancing Using Distributed Queue

Load balancing, as the name indicates, is a concept that allows message loads tobe balanced or shared by multiple adapter instances. Load balancing ensures nosingle instance is over-loaded, and minimizes stress-failures.

It also allows fault-tolerance by avoiding a single point of failure. The adapter canrun in load-balanced configurations both on the Inbound side as well as theOutbound.

Configuring Inbound Load-Balanced InstancesThis section outlines the steps necessary to configure inbound load-balancedinstances containing subscription services and Request-Response services.During the configuration of the services, the Quality of Service must beconfigured as Distributed Queue as shown in the following screen:

This section outlines the steps used to configure inbound load-balanced instancescontaining Subscription services (Inbound IDocs) and/or Request-Responseservices (Inbound RFC/BAPI.)

During the configuration of the adapter services, the Quality of Service must beconfigured as type Distributed Queue.

Configuration of inbound load-balanced instances can be done either by:

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 201: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Load Balancing Using Distributed Queue | 179

• Creating multiple inbound instances where the CMQ names are the sameacross the instances.

• Creating one inbound instance that can be invoked multiple times.

RVCMQ Session Attributes

The behavior of RVCMQ is complex and attributes for RVCMQ sessions must beset with care. This section lists relevant sections from the TIBCO RendezvousConcepts manual. For more detailed information, see the manual itself. Also seeTIBCO Designer SDK Resource Guide for details on configuring an RVCM Session.You can access TIBCO Designer documentation using the Help menu. ClickHelp>Help for>Adapter Resources

— Understanding Rank and Weight

— Weight Values

— Assigning Weight

— Rank among members with different weight

— Rank among members with equal weight

— Status quo among members with equal weight

— Adjusting Weight

— Understanding and setting heartbeats

It is recommended that you have a good grasp of the concepts listed below anddiscussed in TIBCO Rendezvous Concepts manual before you finalize theconfiguration of any inbound instance running in RVCMQ mode.

Before changing the Quality of Service, make sure that no network sinks have aSession Reference, referring to the Default Sessions (DefaultRVSession,DefaultRVCMSession, DefaultRVCMQSession) created by the palette. To avoidthis, have a Custom Session associated with the Network Sink.

To avoid message loss after activation of a suspended RVCMQ service, assignCompleteTime to a value greater than Zero.When the completeTime is assignedZero the scheduler does not set a timer and does not reassign tasks when the taskcompletion confirmation is not received. So after activation of a suspendedservice the scheduler does not reassign the task to the worker member. For moreinformation on RVCMQ parameters, refer to TIBCO Rendezvous documentation.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 202: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

180 | Configuring the Adapter with Advanced Options

Multiple Inbound ConfigurationsUse the following steps to configure an inbound instance as part of a group ofload balanced instances:

1. Assign one of the instances as the master or root. Provide an unique RVCMQsession name for this instance. Obtain the RVCMQ session using these steps:

a. Click the Advanced tab of one of the services.

b. Click Go To corresponding to the endpoint reference. The Configurationtab for the endpoint is displayed.

c. As the view changes from the service’s Advanced tab to the endpoint’sConfiguration tab, the focus in the project panel also shifts to theendpoint. Then find the RVCMQ Session linked to the endpoint selected,as shown in the following figure.

In the example shown, the endpoint namedEndpointForSubscriptionService is linked to the RVCMQ session namedR3AdapterConfigurationRVCMQSession. All the instances should have thesame CMQ Name to achieve load balancing using Distributed Queue. Providean unique CMQ name to the R3AdapterConfigurationRVCMQSession. In theexample shown, the CMQ Name provided is test.CMQ.

2. For other instances that have not been assigned as the master or root, theCMQ name property of the RVCMQ sessions used by those instances must be

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 203: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Load Balancing Using Distributed Queue | 181

changed to reflect the name in step 1. Change the CMQ Name property, usingthe following steps:

a. Identify the RVCMQ sessions used by the instances. Refer to step 1.

b. For each instance, change the CMQ Name property of the session asshown in the following example:

In the example shown, the CMQ Name of the slave is the same as the master orroot.

Single Inbound ConfigurationConfigure an inbound instance with RVCMQ quality of service and invoke itmultiple times.

Use client variables to specify different log file names for each invocation of theinstance. If this is not done, then all trace messages are written to the same file.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 204: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

182 | Configuring the Adapter with Advanced Options

For each file sink available in the Log Sinks folder, make sure to include%%LOG_FILENAME%% as the filename. It is assumed that a value is passed alongwith the tra file.

.

File sinks are located in the project in the following path:

Instance>Advanced>Log Sinks

In this example, the filename for the sink fileSink has been updated to reflect%%LOG_FILENAME%%.

The client variable LOG_FILENAME is used to illustrate how to configure filenamesat run-time. As long as the client variable is unique, you can use any name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 205: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Load Balancing Using Distributed Queue | 183

Configuring Outbound Load-balanced InstancesThis section outlines the steps necessary to configure Outbound Load-balancedinstances containing Publication services (Outbound IDocs) and/orRequest-Response Invocation services (Outbound RFC/BAPI). The steps outlinedin this section are applicable for any adapter instance configured with the R/3Connection type Outbound or Both.

Outbound Load-balanced instance can be configured either by

1. Creating multiple outbound instances using the same Program ID for theServer Connections.

Or

2. Creating one outbound instance that can be invoked multiple times.

The subsequent section focuses on the second option where one outboundinstance is created using client variable substitution as the means for providingunique names for both the RVCM session name and File Sink filename duringeach invocation of the adapter instance.

Single Outbound Instance

To invoke the same adapter instance multiple times, use the steps outlined belowwhen configuring the instance using TIBCO Designer.

1. For each RVCM with a client variable, for example, session in the Sessionsfolder, replace the value of the CM Name with %%PASSED_CM_NAME%%. TheLedger File and log file values should also be changed to reflect the usageof the same client variable. It is assumed that a value would be passed alongwith the .tra file for the adapter instance.

When creating multiple instances, make sure that the TIDManager Clientreferences the same remote TIDManager instance.

The client variable PASSED_CM_NAME is used to illustrate how to configure CMnames and ledger file names at run-time. As long as the client variable is unique,you can use any name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 206: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

184 | Configuring the Adapter with Advanced Options

2. For each file sink available in the Log Sinks folder, include %%LOG_FILENAME%%as the filename. It is assumed that a value would be passed along with the .trafile for the adapter instance.

The FileName field for a file sink is not editable. To change the value of theFileName for the file sink, go toR3AdapterConfiguration->Logging->LogFile tab and add the%%LOG_FILENAME%% global variable to the Log File field. This change will bethen reflected in the FileName field for the file sink.

The variables are added to the .tra files for the adapter instance as follows:

tibco.clientVar.LOG_FILENAME=Secondadapter.logtibco.clientVar.PASSED_CM_NAME=Secondadapter.CM

The files are created in the startDir which is by default the installation directory,for example c:\tibco\adapter\adr3\version_number.

The client variable LOG_FILENAME is used to illustrate how to configurefilenames at run-time. Any unique client variable name can be used.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 207: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Load Balancing Using Distributed Queue | 185

For information on client variables refer to your TIBCO RepositoryDocumentation.

In the example screen, file sinks are located in the project in the following path:

Instance name>Advanced>Log Sinks

In this example, the filename for the sink fileSink has been updated to reflect%%LOG_FILENAME%%.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 208: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

186 | Configuring the Adapter with Advanced Options

BDC Implementation

SAP provides many interfaces for transferring external data to SAP. RFCs, BAPIsand IDocs are the most commonly used interfaces. BDC, which is one of the datatransfer mechanisms provided by SAP, can be used for data integration in theabsence of standard BAPIs, RFCs or IDocs. One of the advantages of BDC is whendata is posted in SAP using BDC transaction all the validations required for thattransaction are performed on the data.

Sometimes, it is much easier, cleaner and faster to write a custom RFC for acustom screen that fills a custom table in SAP.

Using BDCs you can create transactions in SAP by going through the SAP dialogscreens of a particular transaction. For instance, you can create a purchase orderthrough BDCs by going through the different screens of the Purchase OrderCreation transaction. (ME21).

The following methods can be used to implement BDCs:

• BDC implementation through standard RFC (ABAP4_CALL_TRANSACTION). SeeBDC Implementation through Standard RFC(ABAP4_CALL_TRANSACTION) on page 186 for details.

• BDC implementation through custom RFCs. In this case you will have acustom RFC for every transaction in SAP. See BDC Implementation throughCustom RFCs on page 189 for details.

BDC Implementation through Standard RFC (ABAP4_CALL_TRANSACTION)SAP provides a standard RFC that can be used for implementing BDCs. Itsupports both SAP standard transactions like ME21 as well as customer specificcustom transactions like ZE21. The RFC configuration needed in the adapter isjust like any other RFC configuration in TIBCO Designer. TIBCO ActiveMatrixBusinessWorks can call the RFC in both Request-Response mode as well astransactional one-way invocation mode depending upon the need.

To get the PO number after it is created, you should use the Request-Responsemode. To post the PO and not receive a reply you should use the transactionalmode. You will not be able to get exceptions back from the SAP system if you usethe transactional mode. To receive the errors immediately, use theRequest-Response mode.

The RFC used to implement BDC is called ABAP4_CALL_TRANSACTION. It accepts afixed number of parameters and the transaction code as inputs and carries out thetransaction in SAP. The key inputs for executing this RFC are:

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 209: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

BDC Implementation | 187

Table 3 Input Parameters used in the RFC to implement BDC

TCODE Transaction code that needs to be called from the adapter.

SKIP_SCREEN This field has to be always “X” because we are executing this transaction from outsideSAP. It can be left blank to see the screens when we are executing the BDC within theSAP system.

MODE_VAL There are three modes. Always use “N” since we are executing the call from outsideSAP.

A Display all screens

E Display errors

N Background processing

UPDATE_VAL There are three modes of updates.

L Local

S Synchronous

A Asynchronous

UPDATE parameter specifies how updates produced by a transaction should beprocessed. You can select between these modes:

UPDATE_VAL = A

Asynchronous updating. In this mode, the called transaction does not wait for anyupdates it produces to be completed. It simply passes the updates to the SAP updateservice. Asynchronous processing therefore usually results in faster execution of yourdata transfer program. Asynchronous processing is NOT recommended for processingany larger amount of data. This is because the called transaction receives nocompletion message from the update module in asynchronous updating. The callingdata transfer program, in turn, cannot determine whether a called transaction endedwith a successful update of the database or not. If you use asynchronous updating,then you will need to use the update management facility (Transaction SM12) to checkwhether updates have been terminated abnormally during session processing. Erroranalysis and recovery is less convenient than with synchronous updating.

UPDATE_VAL = S

Synchronous updating. In this mode, the called transaction waits for any updates thatit produces to be completed. Execution is slower than with asynchronous updatingbecause called transactions wait for updating to be completed. However, the calledtransaction is able to return any update error message that occurs to your program. Itis much easier for you to analyze and recover from errors.

This is the preferred method in our case since we are executing the transaction fromoutside and this allows good error handling also.

L Local updating. If you update data locally, the update of the database will not beprocessed in a separate process, but in the process of the calling program. (See theABAP keyword documentation on SET UPDATE TASK LOCAL for moreinformation.)

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 210: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

188 | Configuring the Adapter with Advanced Options

The BDC data is the key structure through which the data is passed to completethe SAP transaction. So if you to pass through SAP screens 100 and 200 and fillfields' f1 to f7. The USING_TAB would look like

SAPSCREEN 100

X F1 10000

F2 20000

F3 30000

F4 4000

F5 59

SAPSCREEN 200

X F6 6000000

F7 70000000

Output Parameters:

MESS_TAB gives the output of the BDC. Usually the last line of this sequencewould give the PO Number details.

Configuration Steps for BDC Implementation using Standard RFC

1. Configure an inbound adapter instance.

2. Download the ABAP4_CALL_TRANSACTION RFC (either one-way or requestresponse depending upon the implementation need)

3. Design a TIBCO ActiveMatrix BusinessWorks process that can accept thestandard set of BDC inputs. The input data that is set determines which SAPTransaction should be executed. So irrespective of the number of SAPtransactions you need to execute there is only one process that is needed forthe BDC itself.

4. If there is a need for having multiple BDC services, then consider having thesame services in multiple adapter instances.

USING_TAB(BDCDATA)

PROGRAM BDC module pool

DYNPRO BDC Screen number

DYNBEGIN BDC screen start

FNAM Field name

FVAL BDC field value

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 211: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

BDC Implementation | 189

BDC Implementation through Custom RFCsOnce a BDC data is recorded using the SHDB transaction in SAP, you can create aspecific custom RFC for that particular data set and the transaction itself. TIBCOActiveMatrix BusinessWorks can then use this program to create the transactionin SAP.

Configuration Steps for BDC Implementation using Custom RFCs

1. Configure an inbound adapter instance.

2. Download the custom RFC created for the specific BDC recording.

Example: Z_BDC_CREATE_PO (either one-way or Request-Response dependingupon the implementation need)

3. Design a TIBCO ActiveMatrix BusinessWorks process that can accept the setof BDC inputs. The input data set in this case can only be specific to creatingthe PO in SAP. So each one of the SAP transactions has its own process forexecuting the BDC.

4. If there is a need for having multiple BDC services, then consider having thesame services in multiple adapter instances.

The most important step in designing the BDC is the collection of the BDC inputdata and the order in which the SAP screens should be traversed. Sometimes, thenumber of fields and the screens involved could be very simple andstraight-forward (example: custom screens in SAP). But in case of standard SAPtransactions, the number of fields and screens are quite complex and the flow ofscreens could be varied. (For instance, you can create a PO by filling ten fields andtwo screens, you can also fill hundred fields across ten screens in different order).

The order to traverse the screens should be fixed. Once the same transaction is runin SAP by following the same order of screens and filling the same fields, you canstart recording the process. At the end of the recording, SAP system gives a filethat can be downloaded; this is the sample data with which data mapping shouldbe done. Every field name and field value in the data file, should be understoodand mapped. It is recommended that you run the BDC for testing purposes beforegetting into the complexities of the mapping process.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 212: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

190 | Configuring the Adapter with Advanced Options

Using Global Variables

The variable substitution mechanism can override global variables predefined inthe project in a restricted manner. Predefined variables can be viewed and set inTIBCO Designer. Variables are specified as %%VARNAME%% and cannot contain anywhite space.

Variable substitution allows you to accomplish the following.

• Substitute string variables specified in the project at startup time.

• Locally define the value for a variable for a specific project. The local valuetakes precedence over any global value.

• Specify the value for a variable in a properties file. This overrides the projectrepository and values set in code, but not variables set on the command line.

• Enforce the pre-defined variables listed in Predefined Global Variables onpage 192.

Variables can be used anywhere in the configuration and will be replaced bythe locally-defined adapter instance.

Specifying Variables Using TIBCO Designer

Global variables provide an easy way to set defaults for use throughout yourproject.

• Define a variable using TIBCO Designer, then override the value forindividual applications at deployment time using TIBCO Administrator. Youcan also override values for predefined variables, unless the GUI does notallow you to make them settable later.

• Predefine a variable using TIBCO Designer, then override the value forindividual services (for example, publication service or TIBCO ActiveMatrixBusinessWorks process) at deployment time using TIBCO Administrator. Thevalues you specify are then used at runtime. You can also override values forpredefined variables, unless the GUI does not allow you to make themsettable later.

For example, you could assign the value 7474 to the predefined globalvariable RvDaemon. You can then use the variable in different sessions in youradapter. If you wish to change the TIBCO Rendezvous daemon for youradapter, you can globally set it to a different value or override it from thecommand line.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 213: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Using Global Variables | 191

To use global variables in your project, follow these steps:

1. In TIBCO Designer, click on the Global Variables tab.

The project panel is updated to display all currently defined global variables.Click Open Advanced Editor (pencil icon at the top left corner). You now havethese choices:

— To assign or change a variable value, select that region and triple-click thevariable. The variable expands so you can change either the variable nameor the variable value. Click Enter when you are done.

— To add a new global variable group, click the left most icon at the bottom ofthe dialog box. Specify the name of the group, then click Enter. With thegroup icon selected, you can click the abc icon to add variables to thegroup.

— To add a global variable, click the abc icon. A new global variable item isadded to the bottom of the list. Supply the variable name and, optionally,the value. Click Enter when you are done.

The global variable is now displayed in the global variables list.

2. When you want to use the global variable in the fields of a resource, enter thevariable name surrounded by %% on both sides.

When the project is deployed and the configured components are run, alloccurrences of the global variable name are replaced with the global variablevalue (unless it was overridden in a way that had higher precedence).

A number of global variables are predefined. See Predefined Global Variables onpage 192 for information. You may add definitions of any variables you need tothe predefined variables.

Changing Global Variable Values at RuntimeYou can change the value of a global variable when you deploy your project inTIBCO Administrator. See the section on modifying runtime variables in theTIBCO Administrator User’s Guide for more information on using TIBCOAdministrator.

You can also specify values for global variables when starting a process engine onthe command line. To do this, specify the following as a command line argumentwhen starting the process engine:

-tibco.clientVar.<variablePathAndName> <value>

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 214: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

192 | Configuring the Adapter with Advanced Options

where variablePathAndName is the name of the variable you wish to set, includingthe path to the variable if it is contained in a folder. value is the value you wish toset the variable to. For example, if you have a global variable named item1

contained in a folder named myGroup and you wish to set its value to 500, add thefollowing argument to the command line when starting the process engine:-tibco.clientVar.myGroup/item1 500

Predefined Global VariablesThe next table lists and explains the predefined global variables. Some globalvariables are automatically used within the system when an adapter instance isconfigured.

Table 4 Predefined Global Variables

Variable Description

Deployment Defaults to the TIBCO Designer project name. This globalvariable is used by the system to partially define thesubject name defined for a service.

DirLedger Specifies the path name of the TIBCO Rendezvouscertified messaging ledger file. The default is the rootinstallation directory.

DirTrace Specifies the path name for log file used by the adapter.The default is the root installation directory.

Domain The default value for file-based local projects is MyDomain.The value for server-based projects is the domain to whichthe project was saved.

HawkEnabled Indicates whether TIBCO Hawk is used to monitor theadapter. True indicates that a TIBCO Hawk microagent isdefined for the adapter. False indicates the microagent isnot to be used.

JmsProviderUrl Tells applications where the JMS daemon is located.Setting this value mostly makes sense in early stages of aproject, when only one JMS daemon is used.

JmsSslProviderUrl

Specifies applications where the JMS SSL daemon islocated.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 215: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Using Global Variables | 193

RemoteRvDaemon TIBCO Rendezvous routing daemon (rvrd) to be used. SeeTIBCO Administrator Server Configuration Guide for detailsabout setting up a domain using rvrd.

RvDaemon TIBCO Rendezvous daemon. Sessions use this daemon toestablish communication. The default value is 7500.

RvNetwork TIBCO Rendezvous network. This variable need only beset on computers with more than one network interface. Ifspecified, the TIBCO Rendezvous daemon uses thatnetwork for all outbound messages.

In most cases, you can leave the default.

RvService TIBCO Rendezvous service. The Rendezvous daemondivides the network into logical partitions. Each transportcommunicates on a single service. A transport cancommunicate only on the same service with othertransports.

Unless you are using a non-default TIBCO Rendezvousconfiguration, you should leave the default (7500).

RvaHost Computer on which the TIBCO Rendezvous agent runs.This variable is only relevant if you are using the TIBCORendezvous Agent (rva) instead of the TIBCORendezvous daemon, and if you have configured anon-default setup. See TIBCO Rendezvous Administrationfor details about specifying the rva parameters.

RvaPort TCP port where the TIBCO Rendezvous agent (rva) listensfor client connection requests. See TIBCO RendezvousAdministration for details about specifying the rvaparameters. Defaults to 7501.

TIBHawkDaemon TIBCO Rendezvous daemon used in the TIBCO Hawksession. See the TIBCO Hawk Installation and Configurationmanual for details about this parameter.

TIBHawkNetwork TIBCO Rendezvous network used by the TIBCO Hawksession. See the TIBCO Hawk Installation and Configurationmanual for details about this parameter.

Table 4 Predefined Global Variables

Variable Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 216: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

194 | Configuring the Adapter with Advanced Options

TIBHawkService TIBCO Rendezvous service used by the TIBCO Hawksession. See the TIBCO Hawk Installation and Configurationmanual for details about this parameter.

AppServer The network name of the SAP application server hostmachine.

Client SAP client number.

CodePage SAP application server code page. Set this to viewIDoc/RFC /BAPI schema descriptions in non LATIN-1character sets in TIBCO Designer.

The selected value is only used by the non-unicodeadapter at runtime.

GatewayHost The gatewayHost name or IP address or router string. Ifthere is no specified machine acting as a gateway host, thisis the same as the Appserver.

GatewayService The SAP gateway service. The default value is sapgw00.

Password Valid password corresponding to the user name.

ProgramID Valid existing program ID that identifies the RFC Serverprogram for the SAP system.

SystemNumber SAP database instance number.

UserName Valid user name to log into the SAP client specified.

Table 4 Predefined Global Variables

Variable Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 217: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

TID | 195

TID

Chapter 5 TIDManager

Topics

• Introduction, page 196

• Setting TIDManager Configuration Options, page 199

• Setting TIDManager Logging Options, page 200

• Setting TIDManager Startup Options, page 201

• Setting TIDManager Monitoring Options, page 202

• Setting TIDManager General Options, page 203

• Setting TIDManager for Fault Tolerance, page 206

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 218: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

196 | TIDManager

Introduction

The Transaction Identity Manager (TIDManager) is used to ensure exactly-oncedelivery when tRFCs or IDocs are exchanged with the SAP system. TheTIDManager component ensures that no transactional data is lost or duplicated incase of communication errors between the adapter and the SAP system.

The TIDManager server configuration is required in one of the following twoscenarios:

• Outbound Configurations — Scenario where multiple publication serviceconfigurations (for IDocs) or Request-Response Invocation serviceconfigurations (for tRFCs) use the same program IDs and running in a loadbalanced fashion.

• Inbound Configurations — Scenarios where multiple Subscription serviceconfigurations (for IDocs) run in a load-balanced fashion.

Outbound configurations sharing the same program ID should reference the sameremote TIDManager server configuration.

Interactions between the Adapter and the TIDManager server configurationWhen configured for remote TIDManagement, the adapter invokes theTIDManagement operations on the remote TIDManager server in the TIBCOenvironment. The adapter and the TIDManager server can interact on TIBCORendezvous (default) or JMS transports.

The TIDManager server maintains the status of each Transaction Identifier (TID)associated with a transaction being executed by the adapter. The TID status ismaintained in a TID file that is created and maintained on the local file system bythe TIDManager server.

Ensure that the TIDManager Client in the Adapter Services tab of each adapterinstance has been configured correctly. See Adapter Services Tab on page 51 fordetails on setting RPC client reference.

The subject specified for the RPC client should match the subject specified for theRPC Server referenced in the options of the TIDManager. See General Tab onpage 203.

If more than one TIDManager is maintained for the same Program ID, once-onlydelivery from SAP cannot be guaranteed.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 219: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Introduction | 197

Recovering from network outages and TIDManager server downtimesWhen an adapter is configured for remote TIDManagement, it is mandatory forthe TIDManager server to be up and running to perform TIDManagementoperations. The adapter cannot proceed with a transaction if it is unable tocommunicate with the TIDManager server. Thus availability of the TIDManagerserver is critical for remote TIDManagement.

Outbound TIDManagement

In case of remote TIDManagement for outbound configurations, if theTIDManager server is not running or not reachable because of network outages,the adapter throws the following errors upon receiving a transaction from theSAP system:2010 Aug 29 10:07:52:633 GMT +5 SAPAdapter.R3AdapterConfigurationError [Adapter] AER3-000102 TID operation timed out.

2010 Aug 29 10:07:52:633 GMT +5 SAPAdapter.R3AdapterConfigurationError [Adapter] AER3-000410 Server thread exited, message : Rpcinvocation timeout

The transaction itself is not lost and is maintained in the SAP system's tRFCqueue. The SAP system will periodically try to push out the transactions and clearthe queue. If communication to the TIDManager server is restored, normalprocessing will continue.

Inbound TIDManagement

In case of remote TIDManagement for outbound configurations, if theTIDManager server is not running or not reachable because of network outages,the adapter throws the following errors upon receiving an IDoc from the TIBCOenvironment:2010 Aug 29 10:20:37:192 GMT +5 SAPAdapter.R3AdapterConfiguration1Error [Adapter] AER3-000102 TID operation timed out.

2010 Aug 29 10:20:37:212 GMT +5 SAPAdapter.R3AdapterConfiguration1Error [Adapter] AER3-000493 Remote TIDManager server unreachable

The AER3-000493 error is also published as a Hawk Notification that can besubscribed to from TIBCO Hawk.

The TID operation timeout condition determined by the configurable parameterTIDManager Client Retry Count in the adapter configuration

The TIDManager Client Retry Count determines the number of times theadapter will try to invoke the TID operation on the TIDManager server beforeconcluding that the TIDManager server is indeed unreachable.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 220: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

198 | TIDManager

Once the TIDManager server is found to be unreachable, the Subscriber adaptercannot proceed with posting the IDoc. The IDoc should not be confirmed to thesending application in the TIBCO environment as it will result in message losses.

Hence, upon detection of this situation, the adapter suspends all its subscriptionservices, does not confirm received IDocs to the TIBCO environment, and goesinto a silent retry mode to try and reconnect to the TIDManagement server. This isachieved by pinging the TIDManager server periodically. The adapter willcontinue to remain in this suspended state till it establishes communication withthe TIDManagement server again.

The configurable parameter TIDManager Client Retry Interval in the adapterconfiguration determines the time interval in milliseconds between any two pingattempts to the TIDManager server.

Use the following tabs to configure the TIDManager instance:

• Configuration Tab on page 199

• Logging Tab on page 58

• Startup Tab on page 62

• Monitoring Tab on page 63

• General Tab on page 54

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 221: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting TIDManager Configuration Options | 199

Setting TIDManager Configuration Options

Use the following steps to configure a TIDManager instance:

1. Drag an R3TIDManagerConfiguration icon from the palette panel to thedesign panel.

2. Specify the following options in the Configuration tab:

ConfigurationTab

Instance Name — Assign a unique name to the TIDManager instance. Bydefault the name is R3TIDManagerConfiguration. You can change it to aname of your choice.

Show All Tabs — Select this check box to access the General tab. See SettingTIDManager Monitoring Options on page 202 for details on settingmonitoring options.

3. Click Apply.

It is recommended that you use the Program ID defined in SAP as part of theTIDManager name.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 222: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

200 | TIDManager

Setting TIDManager Logging Options

You can configure logging preferences and information in the Logging tab. Youcan configure the level(s) of trace messages to be logged, and then specify thedestination for the trace messages. You have the option of using advanced loggingoptions or standard logging options.

Use the following steps to set up TIDManager logging options.

1. Drag the R3TIDManager Configuration icon from the palette panel to thedesign panel.

2. Click Logging. The Logging tab is displayed.

TIDManager logging options are identical to those of an adapter instance. Forinstructions on setting logging options see Logging Tab on page 58.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 223: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting TIDManager Startup Options | 201

Setting TIDManager Startup Options

TIDManager Startup options are similar to the adapter instance level startupoptions. The only difference is that the DefaultSession field in the Startup tabof the TIDManager does not have a configured default session. See Startup Tab onpage 62 for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 224: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

202 | TIDManager

Setting TIDManager Monitoring Options

Configure TIBCO Hawk information for the TIDManager using the monitoringoptions. You can use microagents to supplement the monitoring informationprovided by the standard logging levels capability.

Use the following steps to configure TIDManager monitoring options:

1. Drag the R3TIDManagerConfiguration icon from the palette panel to thedesign panel.

2. In the Configuration tab, select the Show All Tabs check box and clickMonitoring, the Monitoring tab is displayed.

TIDManager monitoring options are similar to those set for an adapter instance.For instructions on setting monitoring options see Monitoring Tab on page 63

The fields R/3 Adapter Microagent Name and R/3 Adapter Microagent

Type, described in the referenced section, are not applicable for TIDManagermonitoring.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 225: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting TIDManager General Options | 203

Setting TIDManager General Options

Configure the RPC Server endpoint to be used by the TIDManager. Ensure thatthe subject assigned to the RPC server matches the subject name of the RPC client.This RPC client is referred to in the TID Manager Client field in the AdapterServices tab of the adapter instances using this TIDManager instance.

Use the following steps to configure TIDManager options.

1. Drag the R3TIDManagerConfiguration icon from the palette panel to thedesign panel.

2. Select the Show All Tabs check box in the Configuration tab to display theGeneral tab.

3. Specify the following options in the General tab:

General Tab TIDManager Server — Specify the TIDManager server reference. ClickBrowse to locate the appropriate server endpoint.OrClick Go To, the RPC Server Session Configuration tab is displayed,allowing you to configure the RPC server. By default, an endpoint namedTID_RPC_SERVER is provided for a TIDManager instance for messaging onTIBCO Rendezvous. For details on configuring a TIDManager server for JMSmessaging, see Configuring a TIDManager server on JMS on page 204.

By default, the subject name for the TIDManager Server Session isSAP.TIDMANAGER. You can change the subject as appropriate. The subject mustbe unique for each TIDManager.

TID Filename — Assign a unique TID filename. The TID file is used by theTIDManager to maintain state information on the transaction IDs (TID) sentfrom the SAP system. By default, the name of the TID file is tidFile.tid.

The subject name should match subject names being used by TIDManagerClient references in all adapter instances using this TIDManager.

It is recommended that you use the name of the TIDManager instance as partof the filename.

The subject specified for the TIDManager Server and the TID filename mustbe unique for each TIDManager instance.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 226: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

204 | TIDManager

4. Click Apply.

ExampleThis example shows the run time options set for the default TIDManager instance.

Configuring a TIDManager server on JMS1. In the project panel, select the Advanced>Sessions folder for the TIDManager

Server configuration.

2. Create a JMS Session at the level of the default TIDManagerSession.

3. Create a JMS RPC Server under this new session and associate theTIDManager server to this RPC Server.

You must change the name of the log file, adapter.log, if you intend to runmultiple SAP TIDManagers.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 227: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Setting TIDManager General Options | 205

Example

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 228: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

206 | TIDManager

Setting TIDManager for Fault Tolerance

The TIDManager can be set up in the fault tolerant mode using the JMS exclusivequeue feature.

To setup the TIDManager for fault tolerance:

1. Edit the <EMS_HOME>/bin/queues.conf file and specify the queue nameusing the exclusive property for the TIDManager.

For example:

SAP.TIDMgr exclusive

See the TIBCO Enterprise Message Service documentation for moreinformation on editing the queues.conf file.

2. Make sure both the instances of the TIDManager point to the same TID file.

3. Start the instances of the TIDManager.

4. Start the adapter.

The primary instance of the TIDManager will to process IDocs while it is up andrunning. The secondary instance will take over when the primary instance goesdown.

If the instances of the TIDManager are started on different machines make surethe TID file is in a location accessible by both instances of the TIDManager.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 229: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 207

Chapter 6 Advanced Features

This chapter covers advanced features offered by TIBCO ActiveMatrix Adapterfor SAP.

Topics

• Handling Large Internal Tables from SAP, page 211

• IDoc Filtering, page 215

• Inbound BAPI Transactional Support, page 218

• Invoking BAPIs/RFCs Using Transactional Semantics in SAP, page 227

• Multithreading, page 233

• Multiple Connections, page 235

• Event Driven Inbound Connections, page 242

• Connecting an Adapter Instance to Two SAP Systems with a SingleConnection, page 247

• Using JMS Destination Bridges, page 251

• Working with Non-Blocking RPC Servers, page 252

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 230: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

208 | Advanced Features

Using the Adapter with a Revision Control System

TIBCO Designer supports revision control systems such as Microsoft VisualSourceSafe and Perforce. If you are using a revision control system, you mustmanually add some configured resources to the revision control system and checkin the resources when completing the instance configuration.

As part of service configuration, the adapter creates schema files inroot/AESchemas/ae/<SAPSystemNumber>/basic. For example, if you configurea publication or a subscription service in an adapter configuration Instance1, thefollowing files are created:Project_root/AESchemas/ae/45B/basic/Idocs.aeschemaProject_root/AESchemas/ae/45B/basic/structures.aeschema

If you configure a Request-Response Invocation or a Request-Response service inan adapter configuration Instance1, the following files are created:Project_root/AESchemas/ae/45B/basic/functionModules.aeschemaProject_root/AESchemas/ae/45B/basic/structures.aeschema

The file ae.aeschema found underProject_root/AESchemas/ae/scalar/ae.aeschema will be modified to updatecustom scalars if necessary.

The file R3Connections.adr3Connections under Project_root will bemodified to update connections for the instance.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 231: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Using the Adapter with a Revision Control System | 209

When the project is saved and a revision control system has been specified, theadapter displays a warning that additional files were created and should beadded to the revision control system. This warning appears only when the filesare created for the first time. The warning displays a Go To Resource button thathelps in navigating to the resource. You should use the Multi-User>AddResources to RCS menu command to add these files to the revision controlsystem.

For information about how to use the Multi-User feature in TIBCO Designer, referto the TIBCO Designer User’s Guide.

Copy, Cut, Paste and Move Operations

To successfully copy and paste a service from adapter Instance1 to Instance2, theadapter configuration file for the Instance2 and the connection file must bechecked out.

To successfully cut and paste a service from adapter Instance1 to Instance2, theadapter configuration file for both Instance1 and Instance2 and the connection filemust be checked out.

To successfully move a service from adapter Instance1 to Instance2, the adapterconfiguration file for both Instance1 and Instance2 and the connection file must bechecked out.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 232: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

210 | Advanced Features

Regeneration When Moving, Copying and Pasting

• Default subjects are not regenerated to reflect the new instance name when aservice is moved.

• Manually changed certified messaging and certified messaging queue ledgerfile names are regenerated to defaults when a service is moved, or copied andpasted to a new instance.

• If a service associated with a custom session is moved, or copied and pasted,the custom session is not moved, or copied and pasted. The session isregenerated as a default session.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 233: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Handling Large Internal Tables from SAP | 211

Handling Large Internal Tables from SAP

Certain BAPIs/RFCs configured as Request-Response services query the SAPsystem based on specific search criteria. Depending on the queries executed in theSAP system, the records retrieved by the adapter could vary between a few tomany hundreds. Example: BAPI_SALESORDER_GETLIST returns the list of salesorders for a given customer within specific dates for a sales organization to theTIBCO environment.

The adapter allows you to retrieve controlled number of records for convenienceand easy processing and handling at the requesting client-side in the TIBCOenvironment. The BAPI itself is executed only once in the SAP system. Theadapter caches the entire result set retrieved from the SAP system, say 1000 salesorders, and splits the 1000 sales orders into multiple chunks.

The client can make multiple requests to the adapter to retrieve each chunk. Thecache maintained by the adapter can be browsed in the forward and backwarddirections. The adapter also indicates to the client by means of a return variablewhether all chunks have been returned or not. The adapter also allows you toclear the maintained cache from the client.

A typical usage would be displaying of Salesorders from the SAP system tomultiple users on Web-browsers over the internet. Each user specifies the numberof salesorders to be displayed on each screen and navigates using Previous andNext buttons. The client-side only converts the user actions into suitable requeststo the adapter and formats the data chunks.

This feature offers powerful capabilities when used in combination with thedynamic-logon feature.

Enabling Data-ChunkingTo enable data-chunking, you must set appropriate attributes in the closureargument in the userClosure attribute of the request class. The userClosureclass is a packet that is associated with the actual application request from theclient and defines the nature of the actual request to the adapter.

The adapter provides a userClosure class, RFCCLOSURE. This class containsattributes for defining data-chunking requests.

The RFCCLOSURE class is included by default in every Repository projectcontaining a TIBCO ActiveMatrix Adapter for SAP configuration and is availableunder /classes/ae/SAPAdapter40/classes in the Repository Project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 234: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

212 | Advanced Features

The following table lists the input and output parameters for the RFCCLOSUREclass. The input parameters should be set by the client for every data-chunkingrequest and the output parameters are returned to the client based on which theclient takes necessary action.

Table 5 Input Parameters

Name Description Valid Values

GUID A globally unique identifier. This associates theclient request with adapter-side cache. Eachcache is identified solely by the GUID passed bythe client.

Unique String

bUseCache Identifies if the request from the client is adata-chunking request. When this is set, cachingis turned on in the adapter.

Boolean (0/1)

packetSize The number of records the adapter should sendback to the client in the reply. If multiple tablesare returned from the SAP system with differentnumber of records, then every table in the replywill contain those many rows specified by thepacketSize. If the number of remaining rows isless than the packetSize for a table, that tablereturns all the remaining rows.

If there are multiple tables in the reply and if allthe records for a table have been sent, the nextinvocation would not contain any records forthat table.

An integer number

cacheDirection Indicates to the adapter which direction tobrowse the cache in. A "forward" directionreturns the next set of records in the cache. A"backward" direction returns the previous set ofrecords from the cache. Defaults to "+" if not set.

Forward '+'Backward '-'

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 235: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Handling Large Internal Tables from SAP | 213

Table 6 Output Parameters returned by the adapter to the client for each chunking request

Also, note the following while enabling the client to make use of thedata-chunking feature:

— Since browsing in the negative direction is possible at anytime during achunking call sequence, the adapter does not automatically clear the cacheafter sending back all retrieved records. The cache is automatically clearedonly if the cacheDirection attribute is never set.

— The client has to explicitly clear the cache by setting the bClearCacheattribute to true. A separate cache-clearing request has to be made for thesame RFC/BAPI for which caching is enabled. The GUID associated withthe cache should also be set to identify the cache to be cleared.

bClearCache Indicates to the adapter whether to clear thecache or not. This attribute is meaningful onlyfor caches already created in the adapter. TheGUID specifies which cache to clear. A separaterequest has to be made for each cache for theBAPI/RFC concerned. On receipt of theclear-cache request, the adapter simply clearsthe cache and returns a success message to theclient.

Boolean (0/1)

Name Description

bMore Indicates the status of the cache. If there are more chunks to be return to theclient from the adapter cache, this returns true else false. The client can takenecessary action based on this flag.

CurrentRowCount Maintains the current count of the rows returned to the client in a cache. Forexample, if there are 1000 records totally and packetSize is 100, and theadapter returns records 801-900 in the course of the chunking requests,currentRowCount is set to 900. In case records from multiple tables arereturned, this attribute always indicates the row count of the table with themaximum records.

maxRowCount Maintains the total size of the cache in terms of records. For example, ifthere are 1000 records totally, maxRowCount is always set to 1000. In caserecords from multiple tables are returned, this attribute always indicates thesize of the table with the maximum records.

Name Description Valid Values

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 236: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

214 | Advanced Features

If the cache is not cleared, the adapter memory usage will go up with eachcaching call.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 237: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

IDoc Filtering | 215

IDoc Filtering

The default behavior of an IDoc Publication Service is to publish the completeIDoc data received from the SAP system. IDoc Filtering enables an IDocPublication Service to filter segments and fields of an IDoc received from the SAPsystem before publishing the IDoc message to the TIBCO environment. Selectivepublishing of segments or fields at run-time is achieved by specifying thesegments or fields to filter in the IDoc publication service schema. This can bedone in TIBCO Designer at design-time.

The filtered IDoc message that is published in the TIBCO environment willcontinue to conform to the original IDoc schema, but the data for the segmentsand fields filtered will not be published. Subscribing systems can use the originalIDoc schema downloaded into the project to receive the filtered IDoc messages.

To configure filtering for an IDoc Publication Service, follow the below steps:

1. Go to the Schema tab of the Publication Service. This tab displays the SAPschema for the IDoc type. For example, in the screens given in this section, theschema for MATMAS01 is displayed.

2. Filter out an IDoc segment or field by selecting the check box provided againsteach of the IDoc segments or fields. For example, in the first screen in this

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 238: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

216 | Advanced Features

section, the segment E1MARCM and its children segments are being filtered. Thesecond screen shows field-level filtering in the segment E1MAKTM.

— To filter an entire IDoc segment and its children segments, select the checkbox against that segment. The children segments are automatically filteredat run-time.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 239: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

IDoc Filtering | 217

3. Click Apply and save the project.

Segments that are defined as mandatory in the SAP system are not filtered even ifthe check boxes against these segments are selected.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 240: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

218 | Advanced Features

Inbound BAPI Transactional Support

An external system invoking a BAPI Request-Response service in the adapter hasthe choice to explicitly commit or rollback the changes applied to one or morebusiness objects by the BAPI in the SAP system. The explicit commit or rollback isnot a mandatory requirement for all BAPIs but is needed wherever theunderlying BAPI in SAP is implemented this way.

For example, an invocation of BAPI_SALESORDER_CREATEFROMDAT2 in the SAPsystem from the adapter does not effect permanent changes to database till anexplicit commit invocation is made with BAPI_TRANSACTION_COMMIT.

To maintain the contexts for individual BAPI invocations, the Request-Responseservice for the BAPI requiring explicit commit needs additional configuration inTIBCO Designer. Before configuring a BAPI Request-Response service for explicitcommit, run through the checklist given below to ensure that the service reallyrequires configuration for explicit commit.

Explicit configuration for this feature is required only when one or more of thefollowing conditions are satisfied:

• The BAPI requires explicit commit/rollback in the SAP system.

• Multiple connections (maxConnections > 1) are configured for the client,which invokes the BAPI in the SAP system and can be used to scale thenumber of concurrent transactions.

The steps for configuring a BAPI Request-Response service for explicit commitare given below:

Inbound BAPI transactional support is available only when using a singleadapter instance.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 241: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Inbound BAPI Transactional Support | 219

1. Go to the Advanced tab of the BAPI Request-Response service and check theCommit Required check box, as shown in figure below.

2. Set the CommitExpiry value based on the types of transactions invoked in theSAP system. This field defines the maximum time, in milliseconds, for theadapter to hold the transaction context for each invocation of the BAPI. Uponexpiry of this time-interval, connection to the SAP system is closed and thetransaction context for an invocation is released automatically and anypending updates are not committed.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 242: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

220 | Advanced Features

3. Configure Request-Response services in the same configuration for thestandard SAP commit/rollback BAPIs, API_TRANSACTION_COMMIT andBAPI_TRANSACTION_ROLLBACK as shown in figure below.

See the table given below for descriptions of these BAPIs.

Sample ScenarioAssume a scenario where a sales order is to be created. Depending on the resultthe sales order will either be committed or rolled back using the appropriateexternal BAPI. When the sales order creation BAPI is sent to the adapter with theCommit Required flag enabled, the adapter instance generates a session ID, whichis passed in the user closure (RFCclosure) argument of the reply schema. Thissession ID needs to be mapped to the request event ofBAPI_TRANSACTION_COMMIT or BAPI_TRANSACTION_ROLLBACK andsent to the SAP system.

Procedure

1. Configure an inbound adapter instance.

BAPI Task

BAPI_TRANSACTION_COMMIT • Ends current transaction

• Commits changes

• Initiates new transaction

BAPI_TRANSACTION_ROLLBACK • Ends current transaction

• Discards changes

• Initiates new transaction

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 243: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Inbound BAPI Transactional Support | 221

2. Fetch the RFC/BAPI, which requires commit or rollback. For example,BAPI_SALESORDER_CREATEFROMDAT2. See Adding Adapter ServicesAutomatically on page 77 for details.

3. Fetch BAPI_TRANSCATION_COMMIT or BAPI_TRANSCATION_ROLLBACK.

4. Select the Commit Required check box under the Advanced tab ofBAPI_SALESORDER_CREATEFROMDAT2. See Advanced Tab on page 95 fordetails.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 244: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

222 | Advanced Features

5. Configure a Process Definition with two Invoke an adapter request responseservice activity palettes: one for the BAPI_SALESORDER_CREATEFROMDAT2 andthe other for BAPI_TRANSCATION_COMMIT.

6. Under the Input tab of the Commit activity palette, configure RFCCLOSUREfor both the process data panel and the activity input panel (bothRFCCLOSURE to be configured under _caret_userClosure_caret_ ).

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 245: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Inbound BAPI Transactional Support | 223

7. The steps for configuring RFCCLOSURE class in the Process Data panel aregiven below:

a. Click the Coercions button.

b. Add an element. Choose XML Type Reference from the Type drop-downmenu.

c. Point it to the RFCCLOSURE class in the Select a Resource... window.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 246: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

224 | Advanced Features

8. The steps for configuring RFCCLOSURE class in the Activity Input panel aregiven below

a. Click the button. The Edit Statement window appears.

b. Choose Element in the Statement Type drop-down menu.

c. Click the Type tab and select Type Substitution check box.

d. Choose XML Type Reference from the Type drop-down menu.

e. Browse the Schema field to point to RFCCLOSURE class.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 247: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Inbound BAPI Transactional Support | 225

9. Map the sessionID from Process Data Panel to the Activity Input Panel.

10. Start the adapter instance.

11. When an RFC with the Commit Required flag enabled is triggered from aclient application, the Session ID is returned as part of the reply. This SessionID is mapped to the request event of BAPI_TRANSACTION_COMMIT orBAPI_TRANSACTION_ROLL BACK (depending on the content of the reply) andsent to the SAP system. This ensures the commit or rollback of the transaction.

Configuring Multiple Transactional RFC CallsFollow this process to configure multiple transaction calls within the same TIBCOActiveMatrix BusinessWorks process:

1. Create the RFC/BAPI operations required for the transaction.

2. Create the RFC/BAPI commit service.

3. Create the RFC/BAPI rollback service.

4. Click the Advanced tab of the RFC/BAPI request-response service.

a. Check the checkbox for Commit Required.

b. Set the CommitExpiry value based on the types of transactions invoked inthe SAP system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 248: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

226 | Advanced Features

5. Configure process definitions for the RFC/BAPI invoke operations in theorder required for a transaction.

6. Provide the SessionID of the RFC_CLOSURE_DATA for the service invocationto the input of the following service as shown. Similarly provide the SessionIDof the RFC_CLOSUIRE_DATA of the second service to input of the nextservice. Repeat this for all subsequent services.:

7. In the Advanced tab of the Adapter connections select the number ofconnections. The adapter will create threads calculated based on the numberof services and connections.

8. Save the project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 249: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Invoking BAPIs/RFCs Using Transactional Semantics in SAP | 227

Invoking BAPIs/RFCs Using Transactional Semantics in SAP

BAPIs and RFCs can be invoked using transactional semantics in the SAP system.

The transactional semantics in SAP ensures data consistency and exactly-onceexecution, in case of exception situations (network outages or system failures) inSAP while the call is being executed.

Transactional RFCs (tRFCs) are always executed as one-way invocations and arebest suited for transferring transactional data into the SAP in real-time. To executea BAPI/RFC in a transactional mode, the BAPI/RFC has to be downloaded andsaved to the adapter configuration as a one-way operation.

Any one-way Request-Response service can be executed as a tRFC in SAP. Toexecute a one-way BAPI/RFC as a tRFC, each invocation of the BAPI/RFCshould be accompanied by userClosure information, as defined in the classRFCCLOSURE under /tibco/public/classes/ae/SAPAdapter40/RFCCLOSURE.

The parameters that need to be set in the RFCCLOSURE class and sent along witheach tRFC request are:

• bTransactional — This boolean variable determines whether the call mustbe invoked transactionally or not in SAP. Set this to true for a tRFCinvocation.

• TID — Each tRFC invocation has to be carried out with a globally uniquetransaction identifier (TID) that uniquely identifies each tRFC invocation.Based on this parameter SAP internally ensures exactly-once invocation forthe transaction associated with this TID. The sending system is responsible forgenerating and setting this parameter for each tRFC call.

With valid values for bTransactional and TID, a one-way Request-Responseinvocation is recognized as a tRFC call by the adapter and the call is invoked withtransactional semantics in the SAP system.

Ensure that the TID parameter is a non-null unique identifier for each tRFCinvocation.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 250: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

228 | Advanced Features

By default, the messaging protocol for one-way BAPI/RFC services is set toCertified messaging.

Support for qRFCsqRFC is an enhancement on tRFC. qRFC allows tRFC invocations to be handledsequentially in the target SAP system. The adapter allows external systems in theTIBCO environment to invoke tRFCs as qRFCs in the SAP system.

Inbound qRFC

Any tRFC can be invoked as a qRFC in the inbound adapter. No design-timeconfiguration is required. All parameters necessary to invoke a tRFC as a qRFCcan be provided at run-time as part of the RFCCLOSURE class discussed in theprevious section.

The qRFC parameters that have to be set in the RFCCLOSURE for performing aqRFC invocation in the SAP system are discussed below:• bQueue

This boolean variable determines whether the call must be invoked as a qRFC ornot in SAP. Set this to true for a qRFC invocation. This value is applicable only ifthe bTransactional attribute is also set to true.• qName

Every qRFC invocation is made in the SAP system for a specific queue defined inthe system. Set this field to indicate which queue the qRFC call is to be insertedinto.• qCount

This is the counter for the receiving queue in the SAP system. Specify uniqueinteger values for each qRFC invocation inserting into a specific queue.

Outbound qRFC

Outbound qRFC calls can be invoked in the adapter from the SAP system. Theadapter extracts the queue parameters for each qRFC invocation from the SAPsystem and appends them in the request's RFCCLOSURE class that is passed on tothe TIBCO environment.

It is strongly recommended to use the Certified Messaging protocol for one-wayBAPI/RFC invocations. The SAP system requires that if any exception situation(like network outages) occurs during the execution of the call in SAP, then thetransactional call be repeated with the same TID later, to avoid datainconsistencies. This requirement is automatically handled by the certifiedmessaging protocol.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 251: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Invoking BAPIs/RFCs Using Transactional Semantics in SAP | 229

The queue-name and queue-count values are extracted from the SAP system foreach qRFC invocation. They are set to the qName and qCount attributes of theRFCCLOSURE class respectively. The attribute bQueue is set to true.

This allows receiving systems in the TIBCO environment to recognizetRFC/qRFC invocations made by the outbound adapter.

Receiving IDocs through qRFCThe qRFC invocations (including IDocs) from SAP are handled sequentially bythe SAP system. Hence all qRFCs are sequenced by the adapter as well.Consequently, multiple threads and load balancing will not contribute toenhanced performance of qRFC in the adapter.

The unicode version of the adapter supports outbound IDocs sent throughqRFCs. The following transaction codes are used for configuring qRFCs for theSAP system and for the monitoring activities:

• WE20

This transaction code is used to configure an outbound message type forqRFC on a specific destination.

a. Use the Partner Profiles transaction, WE20, to access the partner profiles.

b. Select a partner and for the selected partner, choose an outboundparameter say, MATMAS.

c. Check the checkbox for Queue Processing and save.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 252: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

230 | Advanced Features

The Rule Name field is now visible on the right side of the Queue Processingfield as shown in the following figure.

d. Choose one of the available Rule Names. This rule name will be used tocreate or use an outbound queue for the chosen logical system and thechosen message type.

• WEOUTQUEUE

This transaction code is used to view all Queues that are configured orcreated. You can start a queue so that all the IDocs in the queue will be

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 253: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Invoking BAPIs/RFCs Using Transactional Semantics in SAP | 231

delivered to the corresponding port. When the IDocs are delivered to the port,the status of the IDocs is updated.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 254: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

232 | Advanced Features

• SMQ1

This transaction is use to monitor the status of the LUWs in the outboundqueue and restart any hanging queues manually.

a. Execute the SMQ1 transaction.

b. Specify values for Queue Name and QDEST and click the execute button.

c. The queues with pending messages are displayed as when in the nextscreen.

d. Double-click a Queue Name in the next two screens for the pendingmessage list for the chosen queue. The status of any message that was notdelivered is marked in pink. You can attempt to re-deliver the message byright-clicking and selecting Execute LUW.

Subsequent messages are not delivered till previous messages have beensuccessfully delivered.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 255: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Multithreading | 233

Multithreading

Multithreading of an application allows the application to simultaneously processmultiple, independent events. Multithreading is supported in both inbound andoutbound instances.

The number of threads required can be configured for each Client Connection(Inbound) and Server Connection (Outbound) by setting the value for MaxConnections field in the Advanced Tab present inR3Connections>ClientConnections folder andR3Connections>ServerConnections folder respectively. The number of threadscan also be set through the adr3.maxconnections property in the adr3.tra file.

By default, every additional thread created is assigned a stacksize of 1.25MB. Toavoid stack overflows at runtime, ensure that this stack limit is sufficient for thelargest message that you would expect by sending out a single message of thissize to the adapter.

The stack size for an adapter configuration can be increased by specifying it as aparameter from the command-line during startup or in the adapter .tra file.

For example, to set the stacksize to 2MB, specify the following parameter in the.tra file, adr3.stacksize 2097152 or provide the following command lineargument while starting upadr3 -system:repourl C:/Repositories/StackTest.dat-system:configurl/tibco/private/adapter/SAPAdapter40/R3AdapterConfiguration-system:stacksize 2097152

The number of threads should be equal to the number of connections required.The maximum limit is eight threads per client connection or server connection.

The number of connections to a SAP Gateway server is limited based on thenumber of connections allowed. To configure the maximum number ofconnections allowed, modify the profile parameter GW/MAX_CONN for the SAPapplication server.

For details on setting up number of threads see:

- Setting Client Connection Advanced Options on page 145- Setting Server Connection Advanced Options on page 156

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 256: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

234 | Advanced Features

Note that the stacksize value must be specified in bytes.

Multithreading with Distributed Queues

BAPI/RFC Request-Response services and IDoc Subscription services may be runin load-balanced Distributed Queue (or RVDQ) mode. For multithreading to beenabled for such configurations, ensure that the worker tasks for worker instancesare set to values greater than 1. The number of threads active in each instance isequal to the worker task set for that instance, provided sufficient connections arecreated for the configuration.

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

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

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 257: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Multiple Connections | 235

Multiple Connections

The adapter can connect to multiple gateways/program IDs on the outbound sideand multiple application servers on the inbound side.

Posting BAPIs/RFCs/IDocs from multiple gateways in the Outbound AdapterThe SAP gateway enables communication between different SAP applicationservers or between an application server and an external program.

The host machine on which the SAP gateway resides is called the Gateway Host.Each SAP application server can communicate to external systems through itsown gateway often residing on the same machine as the application server.Alternatively, the gateway process may also reside on a machine entirely differentfrom the one where the application server runs. In such cases, multipleapplication servers can share the same gateway and the gateway host acts as acentralized gateway server.

The Outbound adapter can service requests to invoke or post BAPIs/RFCs/IDocsin the TIBCO environment from one or multiple SAP gateways. This is achievedby configuring the adapter for multiple Outbound connections. See ConfiguringMultiple Connections for Outbound Instance on page 175 for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 258: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

236 | Advanced Features

Figure 6 Outbound Adapter Connecting to Multiple SAP Gateways

Posting BAPIs/RFCs/IDocs from multiple RFC Destinations in the OutboundAdapter

From within a single SAP gateway, RFCs/BAPIs/IDocs are passed on to theOutbound adapter from RFC destinations. When an RFC/BAPI or an IDoc isexecuted on a specific RFC Destination, the SAP system passes on the request tothe adapter registered on the Program ID that is mapped to the RFC Destination.

A single instance of the Outbound adapter can service RFCs/BAPIs/IDocs frommultiple RFC destinations. This is achieved by configuring the adapter formultiple Outbound connections in TIBCO Designer palette. See ConfiguringMultiple Connections for Outbound Instance on page 175 for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 259: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Multiple Connections | 237

Figure 7 Outbound Adapter Registering on Multiple Program IDs on One Gateway

Responding to Dynamic Changes in the Application Server environmentLoad balancing Outbound messaging on the SAP side is achieved by clusteringmultiple application servers under a central SAP Instance.

The Outbound adapter can respond to dynamic changes to such clusteredenvironments in terms of detecting addition or removal of application servers toor from the cluster. The Outbound adapter automatically registers itself with allactive application servers in a cluster and receives and processes messages fromthe servers.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 260: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

238 | Advanced Features

To achieve this, the Outbound adapter is to be run in conjunction with a discoveryagent that is supplied with the adapter Run-time environment installation. Thefigure given next explains the steps involved in this dynamic discovery scenario.gw1, gw2 in the figure are the gateway hosts through which the SAP applicationservers communicate to the Outbound adapter.

The Discovery Process

The Discovery Agent is a special pre-configured Inbound adapter. The discoveryprocess involves the following steps, also schematically presented in the abovefigure.

1. Discovery Agent polls the central SAP instance, retrieves the list of applicationservers connected to the central Instance.

2. The Discovery Agent publishes the list as a message to the TIBCOenvironment.

3. The Outbound adapter configuration(s) pick up the discovery message.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 261: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Multiple Connections | 239

4. The Outbound adapter configurations(s) register on the gateway hosts ofdiscovered application servers.

The Outbound adapter automatically disconnects from application servers thathave gone down and cleans up connections after all attempts to retry to theapplication server are exhausted. The Outbound adapter does not create a newconnection to a gateway host, if it is already connected to it.

Configuring the Outbound Adapter

The Outbound adapter does not need additional configuration in TIBCODesigner to be able to respond to dynamic changes to the application serverenvironment.

The following properties need to be set in the adapter launcher file to enable thisfeature for an Outbound adapter configuration.

• adr3.discovery — This property can be used to turn on/off thedynamic-discovery feature. The feature is commented by default. To turn iton, it needs to be uncommented.

• adr3.discovery.pid— This property allows you to specify the program-idson which to register with the discovered application server's gateway.Multiple program-ids can be specified as comma-separated values.

Example:adr3.discovery.pid=tibcotest

adr3.discovery.pid=tibcotest,idoctest

If the dynamic-discovery feature is turned on, this is a mandatory property.The adapter will exit on starting up with an appropriate error if this propertyis not specified.

• adr3.discovery.listenerSubject — This specifies the subject to listen onto subscribe to the discovery message published by the discovery agent. Thediscovery message contains the list of active application servers. If notspecified, this property defaults to R3.APPSERVERS.ACTIVE

Ensure that the discovery-listener subject matches the publish subject onthe discovery agent side.

Example:adr3.discovery.listenerSubject=APPSERVER.DISCOVERY.DYNAMIC

If the adapter and the Discovery Agent span different network subnets, use ofRendezvous Enterprise Daemon is required. You must obtain a separate licensefor the Rendezvous Enterprise Daemon that is appropriate for your usage.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 262: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

240 | Advanced Features

• adr3.discovery.listenerSession — This specifies the TIBCORendezvous or JMS session to be used by the discovery listener.

Example:adr3.discovery.listenerSession=MyDiscoverySession

A valid session by this name should be available in the project. If notspecified, this property defaults to the default adapter session R3RVSession

• adr3.discovery.maxconnections —This property specifies the maximumnumber of connections that can be established to the gateway of eachdiscovered application server. If not specified, it defaults to 1.adr3.discovery.maxattempts

adr3.discovery.retryinterval

These parameters together define the behavior of the outbound adapter in theevent of connection loss to a gateway. Connection loss could be due tonetwork glitches or because of a planned shutdown. Because the adaptercannot distinguish between the two causes, it will behave in exactly the sameway in both situations.

If an application server has been brought down because of a plannedshutdown, it will still continue to establish a valid connection till all attemptsare exhausted.

Example:adr3.discovery.maxattempts=10

adr3.discovery.retryinterval=30000

Note that the retry interval must be specified in milliseconds.

If not specified, maxattempts defaults to 3, and retryinterval to 30000

milliseconds.

Configuring the Discovery Agent

The discovery agent is a preconfigured Inbound adapter. The configuredrepository is available in the adapter bin directory as adr3Discoverer.dat.

Start the discovery-agent with the following command from command lineadr3 --propFile adr3Discoverer.tra

Do not open this configuration in TIBCO Designer. All parameters that may needto be customized are exposed in the launcher file, adr3Discoverer.tra.

The discovery agent should be started from the command-line only and notthrough TIBCO Administrator.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 263: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Multiple Connections | 241

Configuring the Inbound Adapter for multiple application serversTypically, an Inbound adapter is configured to connect to a messaging serverbelonging to a central SAP instance, which distributes load across multipleapplication servers.

The Inbound adapter can also establish dedicated connections to multipleapplication servers that may not be part of a messaging server configuration. Toachieve this, the Inbound adapter should be configured for multiple InboundConnections in the TIBCO Designer palette. During configuration, ensure thateach BAPI/RFC/IDoc Service configured points to that application server towhich Inbound messages for that service are posted. Refer to ConfiguringMultiple Connections for Inbound Instance on page 171 for details.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 264: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

242 | Advanced Features

Event Driven Inbound Connections

This feature allows users to dynamically establish connections to the SAP systemin an inbound adapter configuration. This feature provides flexibility to externalsystems and the following advantages accrue:

• The inbound adapter need not be connected to the SAP system always, if theRFC/BAPI Request-Response services or IDoc Subscription servicesconfigured in the adapter are not invoked frequently.

• External systems can login with specific authorizations in SAP afterauthentication and execute RFCs/BAPIs in SAP through the inbound adapterwith these authorizations.

Connectionless Inbound ConfigurationsAny Inbound adapter can be configured to start up connectionless. Such anInbound adapter configuration does not establish any connections to the SAPsystem during startup.

Request-Response and/or Subscription services configured in the adapter willmake use of connections created dynamically.

A dynamic connection may be created in one of the following two ways:

— Based on logon parameters defined at design-time

— Based on logon parameters passed at run-time (explicit logon)

Based on the logon parameters defined at design-time

In this case, the adapter opens and closes connections on a per-message basis. Theconnection parameters for opening connections are picked up based on theConnection references configured for the corresponding Request-Response orSubscription services.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 265: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Event Driven Inbound Connections | 243

Configuration

To enable this feature, instruct the adapter not to establish connections on startupby browsing to R3Connections folder>ClientConnections folder for theparticular configuration and selecting the Startup Connectionless check box inthe Advanced tab for each of the configured Client connections.

Based on dynamic logon with different logon parameters and authorizations

In this case, the external system can logon to the SAP system by explicitlyperforming a logon operation in the adapter. Once logged on, the external systemcan use this SAP logon session for performing BAPI/RFC invocations in the SAPsystem.

This feature is available for BAPIs/RFCs only and not IDocs.

If an Inbound adapter is configured with Request-Response services for explicitlogon, no client connection information is saved to the TIBCO Designer project.Hence, do not use this feature if you are configuring IDoc Subscription services.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 266: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

244 | Advanced Features

To enable this feature,

1. Select the Show All Tabs at the adapter configuration level, go to theAdapter Services tab and select the Enable Connectionless check box asshown below.

2. Configure individual Request-Response services for explicit-logon. SeePerforming explicit logon for RFCs/BAPIs on page 244 for configurationdetails.

Performing explicit logon for RFCs/BAPIsAn RFC/BAPI Request-Response Service can be enabled for explicit logon byselecting the Logon Required check box in the Advanced tab for the RFC/BAPIservice. The client system invoking the RFC/BAPI should use the Logon class forlogging on to the SAP system. The Logon class is found underSchemas/Classes/ae/SAPAdapter40/classes in the TIBCO Designer project panel.

Any RFC from an external system to the Inbound adapter instance can beconfigured to require explicit logon in order to be serviced. Such an RFC cannotuse connections established by the inbound adapter instance during initialization.

The Dynamic Logon/Logoff feature is not available as an adapter service inTIBCO ActiveMatrix BusinessWorks process configurations.

When using the Dynamic Logon feature, the transport should be set to RV.

You must configure a GenericAdapterConfiguration having a Request-Responseservice with schema pointing to/tibco/public/classes/SAPAdapter40/RFCClient

This service can be used for the Logon and Logoff operations from TIBCOActiveMatrix BusinessWorks.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 267: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Event Driven Inbound Connections | 245

All inbound adapter instances expose Logon and Logoff operations. The RFC firstobtains a valid connection by logging on to the inbound adapter instance aftersupplying valid logon information. This connection is used to service the RFC.

When configuring a Request-Response Service for an RFC, you can enable use ofevent driven inbound connections by selecting the Logon Required check box inthe Advanced tab. See, Advanced Tab on page 116 for details. To obtain details ofthe Logon class use the Schemas folder in the project panel. The path is as follows:Schemas/Classes/ae/SAPAdapter40/classes.

The inbound instance uses a preconfigured subject name to process logonrequests. The subject name is preconfigured and cannot be modified.RFCClient.RPCServer.<adapter instance name>

To logon to the inbound adapter instance, appropriate attributes have to be set forthe Logon class in the Request, and the operation must be invoked with thepreconfigured subject.

If the logon operation is successful and a valid client connection to the SAPsystem is obtained through the inbound adapter instance, a Session ID is sentback in the reply to the calling system. The reply contains the Session ID in itsRFCCLOSURE class. To obtain details of the RFCCLOSURE class use the Schemasfolder in the project panel. The path is as follows:Schemas/Classes/ae/SAPAdapter40/classes

The external system invokes the RFC with this Session ID to be serviced by theinbound adapter instance. By default, the external system can continue to use thisSession ID for all subsequent invocations of this RFC. When the session is nolonger required, the connection to the SAP system is closed by explicitly loggingoff from the SAP system through the same inbound adapter instance. To obtaindetails of the Logoff class use the Schemas folder in the project panel. The path isas follows:Schemas/Classes/ae/SAPAdapter40/classes

The inbound instance uses a preconfigured subject name to process logoffrequests. The subject name is preconfigured and cannot be modified.RFCClient.RPCServer.<adapter instance name>

The Session ID obtained after logon is passed in the request.

When the explicit logon feature is in use, the adapter’s load balancingfunctionalities, RVCMQ and multiple instances of the adapter cannot be used.

The following attributes are not supported for RFCs that require authentication:• useSAPGUI

• abapDebug

• rfcTrace

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 268: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

246 | Advanced Features

If the external system requires a separate connection for each invocation, eachinvocation should be preceded by a separate logon request. Each invocation of theRFC needs to be populated with the appropriate Session ID. However, in suchcases, explicit logoff is not necessary. To terminate the session and disconnectfrom the SAP system, the attribute bLogoutAfterCall in RFCCLOSURE shouldbe set to TRUE and the appropriate Session ID must be populated. IfbLogoutAfterCall is set to true, the connection is closed on servicing the RFC.By default, bLogoutAfterCall is FALSE.

While the Logon-Required property for an RFC is at an RFC level and has to bedetermined at design time, the termination of a session with bLogoutAfterCall

is at individual invocation level and can be determined at run-time by theexternal system.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 269: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Connecting an Adapter Instance to Two SAP Systems with a Single Connection | 247

Connecting an Adapter Instance to Two SAP Systems with a Single

Connection

This section describes how to configure an adapter instance to connect to two SAPsystems with a single connection.

Sample ScenarioAssume a sample scenario with two SAP systems, one named CER and the other,LCM. Each has RFC destinations named RFCTEST with program id = RFCTEST(sm59 transaction). Assume also that you have configured an adapter instance(Outbound) to run on CER (for example). Refer to the following procedure toconfigure the other system (LCM) so that it can use the same SAP adapterinstance.

Procedure

1. Log in to the second system, LCM, and invoke sm59 transaction.

Figure 8 RFC Destinations

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 270: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

248 | Advanced Features

2. Click on Find, and enter the name of your RFC Destination as shown inFigure 9. (This example assumes the name RFCTEST.)

Figure 9 Find RFC Destinations Screen

3. Click on Continue and the following screen appears:

Figure 10 RFC Destination RFCTEST Screen

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 271: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Connecting an Adapter Instance to Two SAP Systems with a Single Connection | 249

4. Enter the values for Gateway host and Gateway Service that corresponds tothe system against which the adapter is already running (recall in thisscenario, it is CER).

5. Save the destination.

6. Test the connection using the Test Connection button on the button bar. Itshould show OK.

When assigning a specific gateway host to an RFC destination, you must ensurethat this gateway host is available at all times. Regardless of whether or not youare able to make an RFC request from another host, if the specified gateway hostis unavailable, then the RFC request to the adapter will not be successful.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 272: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

250 | Advanced Features

Figure 11 Test Connection Button

Now, you're ready to run the adapter from the other system (LCM in ourscenario).

However, the disadvantage in this scenario is that if the SAP system’s CER isdown, the adapter instance cannot obtain messages from the other SAP system’sLCM. In a scenario where one instance of the adapter can connect to multipleprogram IDs of multiple SAP systems the problem does not arise.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 273: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Using JMS Destination Bridges | 251

Using JMS Destination Bridges

A Destination bridge can be used to specify one or more destinations for servicesusing JMS transport. The destination can be either a topic or a queue. Within thecontext of the adapter, the adapter service is on such destination.

The destination bridge is configured using the bridges.conf file. See the TIBCOEnterprise Message Service documentation for more information.

Examples

Consider the scenario where you have an Adapter subscriber configured with aJMS queue and destination name SAP_Sub and a TIBCO ActiveMatrixBusinessWorks project with a publisher with a JMS topic and destinationBW_Pub. The bridges.conf file would be:

[topic:BW_Pub]queue=SAP_Sub

The adapter subscriber on receiving the IDoc would post it to the SAP system.

In the above example, if the publisher was configured with a JMS queue, thebridges.conf file would be:

[queue:BW_Pub]queue=SAP_Sub

When using a Request-Response or a Request-Response Invocation Service makesure you do not specify different destination bridges.

For example, do not configure an Adapter Request-Response Invocation Servicewith a JMS topic and a TIBCO ActiveMatrix BusinessWorks project with aRequest-Response service with a JMS queue.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 274: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

252 | Advanced Features

Working with Non-Blocking RPC Servers

When working with non-blocking Request-Response services, you can specify atimeout in the RFCCLOSURE class. The adapter will timeout if a reply is notreceived within the specified time by the rfcBapiTimeout parameter.

The following figure shows the parameter:

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 275: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 253

Chapter 7 Program Internationalization

This chapter describes Unicode and how to apply it using TIBCO ActiveMatrixAdapter for SAP.

Topics

• SAP Language Support, page 254

• Getting Ready to Run Unicode on Microsoft Windows, page 256

• How the Adapter Handles Unicode, page 260

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 276: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

254 | Program Internationalization

SAP Language Support

Single and Multi-byte Codepages

SAP provides multi-lingual support through simple single-byte codepage(ISO8859-1,ISO8859-2) and multi-byte codepage (like ShiftJIS, Big5 etc.)installations.

Simple codepage installations of SAP cannot support characters outside of thecodepage with which the system is installed.

Blended Code Pages

In order to support more languages from unrelated code pages, SAP introducedthe notion of blended code pages. A SAP blended code page comprises charactersfrom the intersection of two or more code pages and from a disjoint set of thesecode pages. Creating a code page in such a way allows users to use somecharacters from any of the code pages.

Unicode

SAP Enterprise and higher versions of SAP support Unicode. A single Unicodeinstallation of SAP can support all the characters defined by the Unicodecharacter set.

Support for Non-Unicode SAP Systems

The Outbound adapter receives multi-byte character data from Non-Unicode SAPsystems, converts it to Unicode, and passes on the data to the TIBCOenvironment. The conversion from multi-byte to Unicode is based on thelogon-language of the SAP user invoking the adapter from the SAP system.

The Inbound adapter receives character data in Unicode from the TIBCOenvironment, converts them to multi-byte character data based on the logonlanguage chosen for the adapter connection and passes on the data to the SAPsystem.

The adapter supports single-byte, multi-byte and blended codepage installationsof SAP. The adapter communicates to the Unicode and Non-Unicode SAP systemsthrough the Unicode interface of the SAP RFC C++ libraries.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 277: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

SAP Language Support | 255

Support for Unicode SAP Systems

The Outbound and the Inbound adapters operate in a homogenous mode. Theyreceive character data in Unicode from the SAP system or the TIBCOenvironment, and pass on the data to the target environment without anyconversions for character data in the adapter.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 278: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

256 | Program Internationalization

Getting Ready to Run Unicode on Microsoft Windows

Complete the following steps prior to running the adapter so that it can handleCharacter data correctly.

1. Configure inter-communication encoding

The wire format encoding used for communication between adapters andTIBCO applications is determined by the encoding property set in the project.The adapter configuration can be saved in a local or repository server-basedproject.

— If the adapter configuration is saved in a TIBCO Administrator basedproject, inter-communication encoding is determined by therepo.encoding property in the tibcoadmin.tra file. Every adapterconfiguration that uses the repository server for storing and retrievingconfiguration data from a project uses this encoding setting whencommunicating. This assures that all TIBCO components that use the samerepository also use the same encoding value to communicate.

The adapter requires the repo.encoding property value to be set to UTF-8irrespective of the character set being processed in the adapter and the SAPsystem the adapter connects to.

— If an adapter configuration is saved in a local project, theinter-communication encoding is determined by the encoding property ofthe local project file.

The adapter requires the local project encoding is set to UTF-8. This isirrespective of the character set being processed in the adapter and the SAPsystem the adapter connects to.

The encoding property discussed above is the encoding used by thecommunication between adapters and applications; and not the encodingused for the persistent storage of the project files. Project files are alwayssaved using UTF-8.

The adapter does not require any additional configuration to handle RFCcharacter data for both Unicode and Non Unicode SAP systems. The adapterautomatically detects whether the SAP system connected to, is a Unicodesystem or not.

To communicate with other TIBCO components using the same encoding, thelocal project file encoding property setting for all TIBCO components must beidentical.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 279: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Getting Ready to Run Unicode on Microsoft Windows | 257

In case of Unicode SAP systems, the adapter receives data from the SAPsystem and passes it on to the TIBCO environment without any conversions.

In case of Non-Unicode SAP systems, the adapter further determines thecodepage on which the Non-Unicode SAP system is running and performscharacter conversion accordingly.

2. Configure adapter encoding for explosion of IDoc data in Publication services.

The adapter publication service receives IDoc data from the SAP system inNative RFC format. The Native format is then exploded into a self-describingIDoc structure. The explosion is performed by chopping down the Native RFCtable data into individual segments and individual fields under segments. Toensure correct explosion, perform the following configuration.

This configuration step for publishing IDocs in exploded mode is required forIDoc data posted from Non-Unicode SAP systems only:

Configure the adapter for the appropriate encoding. To specify the encodingfor the adapter configuration, navigate to the General tab, and choose anencoding from the drop-down. See for details.

In the figure below, the adapter is configured for processing Shift-JIS characterdata, Shift JIS(932). The equivalent SAP code page value is 8000.

The setting maybe overridden from the adapter properties file by setting theadr3.encoding parameter.

Example: adr3.locale=ibm-943

Refer to Encoding/Locale Table on page 258 for possible values.

At run-time, a set of Non-Unicode adapter binaries (adr3.exe and adr3.tra) existsin the SAP adapter which is compatible with the earlier 5.x releases of the SAPadapter. This set of binaries can exchange data with Non-Unicode SAP systemsonly. To communicate with Unicode SAP systems and exchange data, you mustuse the Unicode executable adr3u.exe and adr3u.tra files. The Unicode binariescan communicate with Non-Unicode SAP systems as well.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 280: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

258 | Program Internationalization

The adapter does not perform any validation for the encoding value uponstartup. Appropriate errors are thrown at run-time incase of conversion errors.

Table 7 Encoding/Locale Table

Character data-types in SAP IDoc/RFC/BAPI schema are single-byterepresentations.

A field, say KUNNR in RFC_CUSTOMER_GET, of type char.10 means that the KUNNRfield can hold 10 bytes of data.

International characters belonging to multi-byte character sets can beaccommodated only to the extent of the total number of bytes as specified in theschema description.

As an illustration, consider the field KUNNR in RFC_CUSTOMER_GET. The field canhold 10 characters of English data (single-byte), but can hold only 5 characters of adouble-byte character set. When more than 5 double-byte characters are set to theKUNNR field, the field is not guaranteed to be processed completely.

Encoding/Locale Encoding Value

ASCII ascii

ISO8859-1 LATIN_1

ISO8859-2 ibm-912

ISO8859-5 ibm-915

ISO8859-7 ibm-813

ISO8859-8 ibm-916

ISO8859-9 ibm-920

UTF-8 UTF8

Shift_JIS (CP943) ibm-943

Shift_JIS (TIBCO) tibx-943

Shift_JIS (932) tibx-932

KSC_5601 ibm-949

Big5 ibm-1370

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 281: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Getting Ready to Run Unicode on Microsoft Windows | 259

GBK ibm-1386

Encoding/Locale Encoding Value

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 282: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

260 | Program Internationalization

How the Adapter Handles Unicode

The adapter always operates in Unicode mode. The adapter interfaces with theSAP RFC Unicode libraries for communicating with both Unicode andNon-Unicode SAP systems.

Support for Non-Unicode SAP SystemsWhen the source or target SAP application server code pages are multi-byte; forexample SHIFT-JIS, the adapter performs conversion between multi-byte andUnicode.

Inbound Adapter Configurations

On the Inbound side, the adapter acts as a client and invokes the SAP system. Thecharacter data in the SAP System is maintained in multi-byte codepages. Toenable the SAP system interpret the character data correctly, the adapter performsa conversion from UTF-16 encoded Unicode character data received from theTIBCO environment to multi-byte character data which is passed on to the SAPsystem.

The conversion is done based on the logon language specified for the adapterconnection.

Outbound Adapter Configurations

The adapter acts as a server to the SAP system. Multi-byte character data receivedfrom the SAP system is converted to UTF-16 encoded Unicode data based on thelogon language of the user invoking the Outbound adapter. The adapter passeson the Unicode data to the TIBCO environment.

Support for Unicode SAP SystemsSupport for Unicode SAP systems is straight-forward. The data transfer betweenthe adapter and the SAP system is homogenous and there are no conversionsmade on character data.

Figure 12 shows how the adapter handles character conversions with Unicodeand Non-Unicode SAP systems.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 283: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

How the Adapter Handles Unicode | 261

Figure 12 Adapter Conversion with Unicode and Non-Unicode SAP Systems

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 284: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

262 | Program Internationalization

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 285: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 263

Chapter 8 Deploying and Starting an Adapter UsingTIBCO Administrator

This chapter provides an overview about deploying, starting, stopping andmonitoring the adapter using TIBCO Administrator web interface.

Topics

• Create an EAR File in TIBCO Designer, page 264

• Deploy the Project, page 265

• Start or Stop the Adapter, page 267

• Monitor the Adapter, page 268

• Adapter Properties File, page 269

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 286: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

264 | Deploying and Starting an Adapter Using TIBCO Administrator

Create an EAR File in TIBCO Designer

Generate an Enterprise Archive file (EAR) that contains information about theadapter services to deploy.

The EAR file contains information on what you wish to deploy. This could be oneor more adapters, one or more TIBCO ActiveMatrix BusinessWorks processengines, or both.

In TIBCO Designer, follow these steps to create an EAR:

1. Configure the adapter instance.

2. Drag and drop the Enterprise Archive resource from the palette panel tothe design panel. If there are any configured adapter services in your project,an Adapter Archive resource becomes available in the palette panel.

3. Drag the Adapter Archive into the design panel and specify information inthe Configuration tab, then click Apply.

See Also

See the TIBCO Designer User’s Guide for more information about this procedure.The guide is available from the Designer Help menu.

Building an archive creates the EAR file, which you can then deploy from TIBCOAdministrator. If you make changes to the business processes or adapter servicesincluded in the archive, you need to rebuild the archive. Saving the project doesnot affect the archive.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 287: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Deploy the Project | 265

Deploy the Project

Before deploying a project, the machine on which the adapter is installed must bepart of a TIBCO administration domain. After you have installed the TIBCOAdministration Server, any machine on which you install TIBCO Runtime Agent(required by an adapter) can be added to the administration domain. The TIBCOsoftware installed on the machine is then visible and accessible via the TIBCOAdministrator GUI.

When you deploy a project, startup scripts and other information about thedifferent components are sent to the machines to which the components wereassigned. The project data store and TIBCO Administration Server are updatedwith the deployed components.

To deploy a project:

1. Import the EAR file into TIBCO Administrator Enterprise Edition.

2. Assign adapter archives in the EAR file to adapters installed in theadministration domain and likewise assign process archives to processengines.

3. Specify startup options for each adapter service.

Password Handling

At design-time, the adapter uses a password to connect to the backendapplication and fetch metadata. At run-time, the adapter uses a password toconnect to the back-end application and interoperate with it. If you create a 4.xconfiguration using TIBCO Designer 5.x, and use the configuration against a 4.xadapter version, some special considerations are required for security.

When deploying the adapter check the Service property of the global variable inthe global variables section, then go to the Advanced tab of the adapter archiveand set the password value under the Run-Time Variables section.

If the .EAR file uses the saprfc.ini connection, make sure the saprfc.ini file islocated in the <TIBCO_HOME>\adapter\adr3\<version number>\bin directorywhich is the default startDir.

Do not set the password to type Password in the global variables section foradapter configurations that are set to AE Version 4.0 or AE Version 5.0 (in theConfiguration tab Version field) or any intermediate version.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 288: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

266 | Deploying and Starting an Adapter Using TIBCO Administrator

See Also

See the TIBCO Administrator User’s Guide for an introduction to the TIBCOadministration domain and detailed information about the above steps.

See the TIBCO Administrator Server Configuration Guide for fault toleranceinformation.

Deploying a 4.x TID Manager in TIBCO AdministratorTo deploy a 4.x TID Manager in TIBCO Administrator, carry out the followingsteps:

1. Click on the Add Custom Software button to make a new entry for the 4.xTID Manager under the Installed Software list. Refer to the screen givennext for the valid values.

2. Choose the TID Manager entry as the target application while deploying theEAR file created with the 4.x TID Manager. For details on creating an EAR file,see Create an EAR File in TIBCO Designer on page 264.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 289: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Start or Stop the Adapter | 267

Start or Stop the Adapter

The TIBCO Administrator Application Management module allows you to start,and stop deployed applications.

To start the adapter from the module:

1. In the Administrator GUI left pane, expand Application Management >Application-Name > Service Instances.

2. In the Service Instance panel, select the check box next to the adapterservice.

3. Click the Start Selected button.

The status changes from Stopped to Starting up to Started.

4. To stop the adapter, click the Stop Selected button.

See the TIBCO Administrator User’s Guide for more information.

(AIX 6.1 platforms only) Set the value of the WRAPPER_ADJUSTMENT variable toFALSE in the adr3_env.sh and adr3u_env.sh files.

These files are located in the <TIBCO_HOME>\adapter\adr3\<version number>\bindirectory.

To start the adapter from the command line, set the value of the variable on thecommand line console:WRAPPER_ADJUSTMENT=FALSE

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 290: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

268 | Deploying and Starting an Adapter Using TIBCO Administrator

Monitor the Adapter

TIBCO Administrator offers a number of monitoring options.

• Specify alerts and TIBCO Hawk rulebases for each machine in the domain.

• Specify alerts and Hawk rulebases for each adapter service.

• View the log for each adapter service.

See the TIBCO Administrator User’s Guide for information about configuring theabove monitoring options.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 291: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Properties File | 269

Adapter Properties File

The run-time adapters parse a properties file at startup. The default run-timeadapter properties file is named adr3.tra.

The default properties file is located in bin subdirectory of the adapterinstallation directory.

Each line in a properties file is a single property. Each property consists of a keyand a value. The key starts with the first non-whitespace character and ends at thefirst "=" or ":" or whitespace character. The value starts at the first character afterthe equal sign (=). For example:

tibco.configurl=/tibco/private/adapter/R3AdapterConfigurationtibco.repourl=tibcr://TEST_PROJECTadr3.maxconnections=admintibco.clientVar.service=7600tibco.clientVar.daemon=tcp:7600

Properties defined in the properties file override the same properties defined inthe project.

Properties File FormatThe following restrictions apply to properties:

• The "!" character may not be used as a comment line indicator. Only the "#"character is recognized.

• The line continuation character is ignored (a value must fit on a line).

• The key may not contain any of the termination characters. Java allowstermination characters by escaping the value with a preceding "\" character.The adapter does not support this syntax.

Tagging Values for Obfuscation

The presence of a "#" character as the first character in a value (not the key)indicates that the value has been obfuscated or is to be obfuscated. Theobfuscation command-line tool prompts for values to be obfuscated when itencounters a value with "#" as the first character in the properties file.

When the obfuscate tool is run, it rewrites the properties file with the obfuscatedvalue in place. See Obfuscating or Encrypting a Password in the Properties File onpage 274 for more information.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 292: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

270 | Deploying and Starting an Adapter Using TIBCO Administrator

Predefined PropertiesThe next table describes predefined properties. Properties that start withntservice are available only on Microsoft Windows platforms.

All paths inside a properties file, including Windows directory names, must useforward slashes.

Table 8 Predefined Properties

Property Description

adr3.addCustomHawkMethodstoClassMAgent <on/off>

If set to ON, custom methods are added to the class microagent. If set to off,the invocation of these custom methods will return default values. Defaultis on.

adr3.createRefreshTimer When set to ON, refreshes the ABAP context held by the adapterconnections every 30 minutes.

adr3.discovery This property can be used to turn on/off the dynamic-discovery feature.The feature is commented by default. To turn it on, it needs to beuncommented.

See Configuring the Outbound Adapter for more information.

adr3.discovery.listenerSubject Specifies the subject to listen on in order to subscribe to the discoverymessage published by the discovery agent. The discovery messagecontains the list of active application servers. If not

specified, this property defaults to R3.APPSERVERS.ACTIVE.

See Configuring the Outbound Adapter for more information.

adr3.Hawk500 This parameter is for backward compatibility with 4.x for loading theTIBCO Hawk Microagent methods. By default this parameter is set to on.While running the 4.x configuration ensure that this is set to off.

adr3.jmscompress <on/off> If set to ON, the adapter (when using JMS transport) compresses messagesbefore publishing them. This applies for JMS topics and queues.

This property will be applicable to all publishers in a project using JMStransport.

Default is OFF.

adr3.locale Specifies the locale encoding for the adapter instance, to be used withUTF-8 encoded projects

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 293: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Properties File | 271

adr3.maxconnections Specifies the maximum number of server/client connections to beestablished with SAP. It is recommended to set this only whenmaxConnections is greater than one and when you have to override thevalue of maxConnections specified in the project.

adr3.perfMon <on/off> Turns the performance statistics microagent on or off. The default is off. Ifthis property is set to on, the adapter does all the performance relatedcalculations. When you invoke the TIBCO Hawk methods, if this propertyis set to off, default values are displayed and not the valid values.

adr3.preserveFieldBlanks<on/off>

Any blank spaces in the field values are retained and not trimmed.

Default is ON

adr3.requireSlashReplacement For the non-unicode version of the adapter when, processing IDocs wherethe IDoc name or the IDoc segment contains the slash (/) character thisproperty should be set to ON. The slash (/) characters will then be replacedwith __SLASH__ when processing the IDocs.

For the unicode version of the adapter this property is not required as theadapter handles the slash (/) character by default.

For both the non-unicode and unicode versions of the adapter whenpublishing IDocs from TIBCO BusinessWorks, make sure you populate theSEGNAM field for each IDoc segment.

adr3.rfcBapiReplaceNullFieldsWithSpace <on/off>

For the unicode version of the adapter if this property is set to ON theadapter replaces empty fields (NULL) with a space.

Default is OFF.

adr3.stoponsubscribersaperror<on/off>

If set to ON, the adapter stops on encountering an SAP System error on theIDOoc subscriber.

Default is OFF.

ntservice.account Username under which to run the Windows Service.

You can use this property to initially set the account for the service, butonce the service is installed, use the Services control to change the useraccount of services.

ntservice.binary.path.absolute Absolute path to the executable that is run when the service is started. Forexample:

ntservice.binary.path.absoluteC:/tibco/adapter/adr3/<version_number>/bin/adr3.exe

Table 8 Predefined Properties

Property Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 294: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

272 | Deploying and Starting an Adapter Using TIBCO Administrator

ntservice.displayname Name to display in the Services control for this Windows Service.

This property is useful if you wish to have multiple Windows Services forthe same executable. That is, you may wish to have two adapters runningon the same machine. By specifying different service names and displaynames for the adapters, you can accomplish this.

ntservice.interactive Specifies whether the Windows Service is interactive. Either true or false.

ntservice.interactive=true

ntservice.name Name for this Windows Service.

This property is useful if you wish to have multiple Windows Services forthe same executable. That is, you may wish to have two adapters runningon the same machine. By specifying different service names and displaynames for the adapters, you can accomplish this.

ntservice.password Password for the username in the ntservice.account property.

You can use this property to initially set the password for the user account,but once the service is installed, use the Services control to change thepassword.

ntservice.starttype Start type for this Windows Service. Either manual or automatic. Forexample:

ntservice.starttype automatic

You can use this property to initially set the start type for the service, butonce the service is installed, use the Windows Services control to changethe start type of services.

tibco.clientVar.<varname> Specifies run-time values to substitute for global variables defined in theproject. This value takes precedence over the named global value set in theproject. Substitution takes place only at start up.

You append the global variable to tibco.clientVar, then give its value.For example:

tibco.clientVar.DirLedger=C:/tibco/adapter/adr3/<version_number>/ledger

tibco.configurl Specifies the location of the adapter configuration inside the project file.

If a relative path is specified, the adapter service is assumed to be under thedefault area in the project: /tibco/private/adapter/

If an absolute path is specified, the adapter configuration is looked up inthe project as defined by the argument.

tibco.minstanceimpl LIST Add this property for improved memory utilization when working withIDocs of a larger size.

Table 8 Predefined Properties

Property Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 295: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Properties File | 273

When deploying adapter instances or a remote TID Manager in TIBCOAdministrator, values for the properties listed in Table 9 can be modified beforedeployment. The values defined in TIBCO Administrator override the values in.tra files. If the .tra file does not list the property, the default value of theproperty is used. If the values for the properties are modified in TIBCOAdministrator, the adapter instance has to be saved and deployed.

Table 9 Predefined Properties in TIBCO Administrator

tibco.repourl Identifies the absolute pathname to the Designer project where the adapterconfiguration is defined.

tibco.username The user name and password used by the repository server to access theproject.

tibco.password

Table 8 Predefined Properties

Property Description

Property Default Value

adr3.locale LATIN_1

adr3.maxconnections 1

adr3.perfMon OFF

adr3.discovery OFF

adr3.discovery.listenerSubject R3.APPSERVERS.ACTIVE

adr3.addCustomHawkMethodstoClassMAgent ON

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 296: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

274 | Deploying and Starting an Adapter Using TIBCO Administrator

Obfuscating or Encrypting a Password in the Properties File

Password Handling

At design-time, the adapter uses a password to connect to the backendapplication and fetch metadata. At run-time, the adapter uses a password toconnect to the back-end application and interoperate with it. If you create a 4.xconfiguration using TIBCO Designer 5.x, and use the configuration against a 4.xadapter version, some special considerations are required for security.

If you plan to run the adapter locally, define the run-time password value to be aglobal variable. Before starting the adapter, include the run-time password asclient variable in the adapter's .tra file and obfuscate it using obfuscate tool. Forexample, if the password value is defined as %%myPassword%%, create a globalvariable named myPassword in the global variables section with no value andinclude the following entry in the adapter's .tra file:tibco.clientVar.myPassword

Obfuscating a Password

If the run-time adapter uses a password to access the vendor application, thepassword is stored in readable form as a value to thetibco.clientVar.<variable>=# <password> property in the run-time adapter’sproperties file. You can use the obfuscate tool to hide the password in theproperties file so the password cannot be viewed by unauthorized users.

To obfuscate the password:

1. Using TIBCO Designer, open the adapter configuration and navigate to thepanel where the password used by the run-time adapter to connect to SAP isdefined. In the password field, provide a user defined global variable, such as%%MyPassword%%. The global variable must also be added to the globalvariable list. See Using Global Variables on page 190 for information aboutcreating global variables.

2. In the run-time adapter properties file, verify that thetibco.clientVar.<variable>=# <password> property is defined in the file.

3. Run the obfuscation tool supplied with adapter software against theproperties file. This tool is named obfuscate.exe and resides in the<install_dir>\tibco\tra\<version number>\bin directory.

The command syntax on Windows for a default installation is:C:\tibco\tra\<version number>\bin\obfuscate <tra-file-path-name>

Do not set the password to type Password in the global variables section foradapter configurations that are set to AE Version 4.0 or AE Version 5.0 (in theConfiguration tab Version field) or any intermediate version.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 297: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Adapter Properties File | 275

where <tra-file-path-name> is the absolute pathname of the adapter propertiesfile that contains the tibco.clientVar.<variable>=# <password> property.

For example, on Windows:C:\tibco\tra\<version number>\bin>obfuscate

C:\tibco\adapter\adr3\<version number>\bin\adr3.tra

The password is now obfuscated and you can start the adapter with thechanged properties file.

Encrypting a Password

Encryption is only supported for version 5 adapters and higher. If you have aproperty in a properties file that needs to be encrypted, follow these steps:

1. In the property file, add the #! characters in front of the value you wish toencrypt. For example:

Repo.serverPassword = #!mysecret

2. Invoke the obfuscate utility from the command line:

<install-path>/tibco/tra/<version number>/bin/obfuscate.exe--propertyfile=<property-file-name>

The next time you open the property file, mysecret will have been replaced witha random sequence of characters.

If you do not want to obfuscate a password, remove the # at the beginning of theobfuscated password and replace it with the password in plain text.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 298: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

276 | Deploying and Starting an Adapter Using TIBCO Administrator

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 299: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

TID | 277

TID

Chapter 9 Working with Secure NetworkCommunications (SNC)

Topics

• Introduction, page 278

• SAP Cryptographic Library for SNC, page 278

• Procedure for SNC Setup, page 279

• Transaction Codes, page 302

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 300: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

278 | Working with Secure Network Communications (SNC)

Introduction

The Secure Network Communications (SNC) component integrates the adapterwith SAP Systems. With SNC, you strengthen the security between the adapterand the SAP system.

SNC provides the following three levels of security protection between theadapter and the SAP system:

• Authentication

• Integrity

• Privacy

Refer to the SAP documentation for more information.

SAP Cryptographic Library for SNCThe SAP Cryptographic Library is the default security product delivered by SAPfor performing encryption functions in SAP Systems. For example, you can use itfor providing Secure Network Communications

This section describes using the SAP Cryptographic Library for SNC. SAP CryptoLibrary provide the entire functionality defined in the standard interface, theGSS-API V2 (Generic Security Services Application Programming InterfaceVersion 2).

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 301: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 279

Procedure for SNC Setup

The following steps describe the procedure of setting up the SNC in the SAPsystem and the SAP Adapter.

1. Download the SAP Cryptographic Library, page 280

2. Install the SAP Cryptographic Library, page 280

3. Set the Trust Manager Profile Parameters, page 281

4. Create the Personal Security Environment (PSE), page 282

5. Setup SNC Profile Parameters for SAP, page 284

6. Installing the PSE, page 286

7. Install the SAP Cryptographic Library on the Adapter, page 285

8. Setup the SNC Parameter Specific to an Inbound Scenario, page 292

9. Setup SNC Parameters Specific to Outbound Scenarios, page 297

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 302: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

280 | Working with Secure Network Communications (SNC)

Download the SAP Cryptographic LibraryDownload the SAP Cryptographic Library from SAP Service Market Place from:

https://websmp101.sap-ag.de/~form/handler?_APP=00200682500000000917&_EVENT=DISPLAY

The following libraries are required:

Microsoft Windows

• sapcrypto.dll

• sapgenpse.exe

• ticket

UNIX

• libsapcrypto.so ( or sl )

• sapgenpse

• ticket

Install the SAP Cryptographic LibraryFollow these steps to install the SAP Cryptographic libraries:

1. Extract the contents of the SAP Cryptographic Library installation package.

2. Copy the library file and the configuration tool sapgenpse.exe to thedirectory specified by the application server's profile parameterDIR_EXECUTABLE.

In the following example, this directory is represented by the notation$(DIR_EXECUTABLE).

UNIX:

DIR_EXECUTABLE: /usr/sap/<SID>/<INSTANCE>/exe/

Location of SAP Cryptographic Library:/usr/sap/<SID>/<INSTANCE>/exe/libsapcrypto.so

Microsoft Windows:

DIR_EXECUTABLE: <DRIVE>:\usr\sap\<SID>\<INSTANCE>\exe

Location of SAP Cryptographic Library:C:\usr\sap\BAM\DVEBMGS00\exe\sapcrypto.dll

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 303: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 281

3. Check the file permissions for the SAP Cryptographic Library. For example, ifyou copied the library using ftp on UNIX, platforms the file permissions maynot be set correctly. Make sure that <sid>adm (or SAPService<SID>underMicrosoft Windows) has the permissions required to execute the libraryfunctions.

4. Copy the ticket file to the sub-directory SEC in the instance directory$(DIR_INSTANCE).

UNIX:

DIR_INSTANCE: /usr/sap/<SID>/<instance>

Location of the ticket: usr\sap\BAM\DVEBMGS00\sec

Microsoft Windows:

DIR_INSTANCE: <DRIVE>:\usr\sap\<SID>\<instance>

Location of the ticket: <DRIVE>:\usr\sap\<SID>\<instance>\sec\ticket

5. Set the environment variable SECUDIR. The application server uses thisvariable to locate the ticket and its credentials at run-time.

SECUDIR=D:\usr\sap\BAM\DVEBMGS00\sec

If you set the environment variable using the command line the value may notbe applied to the server's processes. Therefore, we recommend settingSECUDIR in the startup profile for the server's user or in the registry(Microsoft Windows).

The SAP Cryptographic Library is installed on the application server and theenvironment is set up so that the library can be located by the server at runtime.

Set the Trust Manager Profile ParametersFollow these steps to set the profile parameters, using transaction RZ10, so thatthe trust manager can access the SAP Cryptographic Library:

1. Set the profile parameters on each SAP Web AS ABAP instance. The followingtable provides the profile parameters and sample values.

Table 10 Trust Manager Profile Parameters

Profile Parameters Value

sec/libsapsecu Path and file name of the SAP Cryptographic Library

ssf/ssfapi_lib Path and file name of the SAP Cryptographic Library

ssf/name SAPSECULIB

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 304: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

282 | Working with Secure Network Communications (SNC)

sec/libsapsecu = D:\usr\sap\BAM\DVEBMGS00\exe\sapcrypto.dllssf/ssfapi_lib = D:\usr\sap\BAM\DVEBMGS00\exe\sapcrypto.dllssf/name = SAPSECULIB

Where sec/libsapsecu is the path and file name of the SAP CryptographicLibrary, and

ssf/ssfapi_lib is the path and file name of the SAP CryptographicLibrary.

For more information on these profile parameters refer to the SAPdocumentation.

2. Restart the application server.

The SNC PSE can now be maintained using the trust manager.

Create the Personal Security Environment (PSE)Before creating the PSE make sure you have:

• installed the SAP Cryptographic Library on the application server.

If the SAP Cryptographic Library is not installed, then the trust manager doesnot display the node for the SNC PSE.

• set the environment variable SECUDIR to point to the location where the PSEis stored.

• the naming convention you use for the Distinguished Name matches theDistinguished Name part of the server's SNC name that you define in theprofile parameter snc/identity/as. If this profile parameter is not yet set,then you can still specify the server's Distinguished Name, but you receive awarning that you have to maintain the profile parameter.

Additionally, the server's Distinguished Name for SNC must be unique. Itcannot also be used in a different PSE.

Follow these steps to create the PSE that the server will use for SNC. If you areusing a single PSE for all server components and you have already created thePSE on a different server, then see Importing the SNC PSE

Using the trust manager (transaction STRUST):

1. Select the SNC PSE node.

2. Using the context menu, choose Create (if no PSE exists) or Replace.

3. The <Create/Replace> PSE dialog appears.

If the server's SNC name is defined in the profile parametersnc/identity/as, then the system automatically determines the

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 305: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 283

Distinguished Name accordingly. Otherwise, enter the Distinguished Nameparts in the corresponding fields, for example:Name = <SID>

Org. (opt.) = Test

Comp./Org. = MyCompany

Country = US

If you want to use a reference to a CA name space, then the elementscontained in the CA field are automatically used for the server's DistinguishedName. In addition, you cannot modify the Country field. Use the togglefunction to activate or deactivate the reference to a CA name space.

In addition, the application server's Distinguished Name to use for SNC mustbe unique. You cannot specify a Distinguished Name that the server uses in adifferent PSE, for example, the system PSE.

4. Choose Enter.

You return to the Trust Manager screen.

5. For SNC you must assign a password to the PSE. Choose Assign password.

The PSE dialog appears.

6. Enter a password for the PSE and choose Enter.

You return to the Trust Manager screen.

The SNC PSE is created and distributed to the individual application servers. Thesystem protects the PSE with a password and creates credentials for the server toaccess the PSE at run-time.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 306: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

284 | Working with Secure Network Communications (SNC)

Setup SNC Profile Parameters for SAPThis section describes how to set the SNC-relevant profile parameters. The RZ10Transaction code is used to set the following parameters in the instance profile.

Setting the profile parameter snc/enable to 1 activates SNC on the applicationserver. If this parameter is set but the SNC PSE and credentials do not exist, thenthe application server will not start. Therefore, setting the SNC parameters shouldbe the last step in the configuration procedure.

Make sure the SNC PSE and the corresponding credentials exist for theapplication server.

1. Set the following profile parameters on the application server so that theserver can communicate using SNC.

The important parameters are listed below. For a complete list, see the SNCUser's Guide.

Table 11 SNC Profile Parameters

Profile Parameters Value

snc/enable 1

snc/gssapi_lib The path and file name where the SAP Cryptographic Library islocated

snc/identity/as Application server's SNC name in the format:p:<Distinguished_Name>

The Distinguished Name part must match the DistinguishedName that you specify when creating the SNC PSE.

snc/data_protection/max 1: Authentication only

2: Integrity protection

3: Privacy protection

snc/data_protection/min 1: Authentication only

2: Integrity protection

3: Privacy protection

snc/data_protection/use 1: Authentication only

2: Integrity protection

3: Privacy protection

9: Use the value from snc/data_protection/max

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 307: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 285

For example:

snc/identity/as = p:CN=BAM, OU=ENGG, O=TIBCO, C=USsnc/gssapi_lib = D:\usr\sap\BAM\DVEBMGS00\exe\sapcrypto.dllsnc/accept_insecure_rfc = 1snc/accept_insecure_r3int_rfc = 1snc/accept_insecure_gui = 1snc/accept_insecure_cpic = 1snc/data_protection/use = 3snc/data_protection/min = 1snc/data_protection/max = 3snc/enable = 1snc/permit_insecure_start = 1

2. Restart the application server.

3. Save and activate the profile.

4. Restart the application server.

The application server is now ready to use SNC.

Install the SAP Cryptographic Library on the Adapter1. Extract the SAP Cryptographic Library.

2. Copy the SAP Cryptographic Library file to any folder. Make sure you add thepath to this folder to the SNC_LIB parameter of the saprfc.ini file.

3. Create the SEC directory and copy the ticket file to this directory.

This is the same ticket file obtained in step 4 in Install the SAP CryptographicLibrary.

snc/accept_insecure_cpic 0: do not accept

1: accept

snc/accept_insecure_gui 0: do not accept

1: accept

snc/accept_insecure_r3int_rfc 0: do not accept

1: accept

snc/accept_insecure_rfc 0: do not accept

1: accept

Profile Parameters Value

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 308: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

286 | Working with Secure Network Communications (SNC)

4. Set the SECUDIR environment variable to point to the sec directory created instep 3

This parameter is set for the user that executes the adapter process. Ifdeploying and running the adapter using TIBCO Administrator, make surethe SECUDIR variable is set and is available for the adapter process.

On Microsoft Windows platforms, the SECUDIR variable is set in theadr3u.tra (for Unicode adapter) or adr3.tra (for non-Unicode adapters)files.

On UNIX platforms, the SECUDIR variable is set in the adr3u_env.sh (forUnicode adapter) or adr3_env.sh (for non-Unicode adapters) files.

If using the adapter tester, the SECUDIR variable is set in the adr3u.tra (forUnicode adapter) or adr3.tra (for non-Unicode adapters).

The SAP Cryptographic Library is now installed.

Installing the PSEFollow these steps to create the PSE that the adapter will use for SNC

Using a Single PSE for All Components

In this scenario you create a single PSE for all components.

1. Create the PSE on a single component, for example, the AGate and copy it tothe other servers.

2. Copying a Single PSE to all Server Components

3. Copy PSE into SEC directory

4. Create Credential on client (the SAP Adapter) cred_v2 file using the followingcommand and copy cred_v2 into the SEC directory:

sapgenpse seclogin -p SAPSNCS.PSE -O username

Using Individual PSE for All Components

In this scenario you create an individual PSE for each component. To establish thenecessary trust relationships between these components, you must exchange thecorresponding public-key certificates. For each of the servers, export the server'spublic-key certificate and import it into its partners' PSEs. See the graphic below:

Using Individual PSEs and Exchanging Public-Key Certificates

To Create PSE for the Client

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 309: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 287

1. Create a directory on your system to store the PSE.

2. Copy the ticket license file and the SAP Certified Client Cryptographic library(ex. SECUDIR) to the directory you just created.

Make sure you set the SECUDIR environment variable to this directory, copy thelibrary to a different directory, and add this path to your PATH environmentvariable.

3. Execute the following command to generate the PSE

The client PSE is named as RFC.pse. From the command line, you can specifythe distinguished name. For example: "CN=RFC, OU=IT, O=CSW, C=DE"> sapgenpse gen_pse -v -p RFC.pse

Got absolute PSE path "<your path>/RFC.pse".

Please enter PIN: ********

Please reenter PIN: ********

get_pse: Distinguished name of PSE owner: CN=RFC, OU=IT, O=CSW,C=DE

Supplied distinguished name: "CN=RFC, OU=IT, O=CSW, C=DE"

Generating key (RSA, 1024-bits) ... succeeded.

certificate creation... ok

PSE update... ok

PKRoot... ok

Generating certificate request... ok.

PKCS#10 certificate request for "<your path>/RFC.pse"

4. Execute the following command to export the Client Certificate of the newlycreated PSE.

The exported certificate is named as RFC.crt.> sapgenpse export_own_cert -v -p RFC.pse -o RFC.crt

Opening PSE your path>/RFC.pse"...

No SSO credentials found for this PSE.

Please enter PIN: ********

PSE open ok.

Retrieving my certificate... ok.

writing to file ...... ok

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 310: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

288 | Working with Secure Network Communications (SNC)

5. Import the Client Certificate to Server PSE via the transaction STRUST.

a. Open the Node SNC (SAPCryptolib) again

b. Enter the SAPCryptolib password.

c. Click on the Import certificate button.

d. Set the file format to Base64 and choose the file.

e. Click Add to Certificate List.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 311: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 289

6. Export the Server Certificate via the transaction STRUST.

a. At node SNC (SAPCryptolib), double click on your own certificate so itdisplays in the Certificate field.

b. Click on Export certificate.

c. From the File tab, choose Base64 for the File format and provide a namefor the file.

7. Import the Server Certificate to the Client PSE

On the command line run:> sapgenpse maintain_pk -v -a SNC.crt -p RFC.pse

Opening PSE your path>/RFC.pse"...

No SSO credentials found for this PSE.

Please enter PIN: ********

PSE open ok.

Adding new certificate from file "SNC.crt"

---------------------------------------------------------------

Subject : CN=IDS, OU=IT, O=CSW, C=DE

Issuer : CN=IDS, OU=IT, O=CSW, C=DE

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 312: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

290 | Working with Secure Network Communications (SNC)

Serialno: 00

KeyInfo : RSA, 2048-bit

Validity - NotBefore: Wed Mar 6 21:37:32 2008 (060927193732Z)

NotAfter: Fri Jan 1 01:00:01 2038 (380101000001Z)

---------------------------------------------------------------

PKList updated (1 entries total, 1 newly added)

8. Create the cred_v2 file.

After setting up the client PSE you must create a file called cred_v2 which isused to securely give the RFC Program access to the PSE without providingthe password for the PSE.

On the command line run:> sapgenpse seclogin -p RFC.pse -O root running seclogin withUSER="root"

creatingcredentials for yourself (USER="root")...

Please enter PIN: ********

Added SSO-credentials for PSE "<your path>/RFC.pse"

"CN=RFC, OU=IT, O=CSW, C=DE"

When you generate the cred_v2 file, the seclogin must be carried out underthe account of the <sid>adm.

9. Allow SNC RFC Connection.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 313: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 291

Map the x.509 certificates that were created for the user accounts on the SAPServer.

a. Start Transaction SM30 and enter the view VSNCSYSACL.

This view is used to restrict the SNC RFC Connections by an Access ControlList (ACL). You will see an alert window pop-up, just click on the "right"symbol.

b. Choose E for the Type of ACL entry.

c. Enter System ID and SNC name.

Do not forget the p: in front of the DN.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 314: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

292 | Working with Secure Network Communications (SNC)

d. Check the boxes according to the following figure.

e. Save the entry.

Setup the SNC Parameter Specific to an Inbound ScenarioFor the communication path from an external program to an AS ABAP whenusing RFC, the external program is the initiator of the communication and the ASABAP is the acceptor. One example of such a connection is the connection from anAS Java to an AS ABAP server. In this case, the AS Java uses the Java Connector(JCo) to establish the connection.

Initiator (External Program)

To apply SNC protection to external programs that communicate with an ASABAP using RFC, you need to specify the SNC options in either the saprfc.ini fileor over the program interface in rfclib. This section describes how to specify theinformation in the saprfc.ini file.

The program may have a user interface for maintaining the parameters. See thedocumentation for the program for details. For example, on the AS Java you makethe settings according to the application that establishes the connection. Theapplication may also have its own user interface, or it may use the Destination orRFC Adapter service.

Before setting the SNC parameters make sure:

When trying to edit the entry, you may see an alert window pop-up. Click on theright symbol and make your changes.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 315: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 293

• You want to apply SNC protection to the communications between the RFCexternal program and the AS ABAP.

• The external program uses the saprfc.ini file.

Procedure

Use the following table to set the SNC parameters in saprfc.ini:Table 12 SNC Parameters for saprfc.ini

Sample saprfc.ini file

DEST=SNCINBOUNDTYPE=AASHOST=adsapSYSNR=00SNC_MODE=1SNC_PARTNERNAME=p:CN=BAM, OU=ENGG, O=myCompany, C=USSNC_LIB=C:\SAPUsr\Dev\Ongoing\SNC\sapcrypto.dllSNC_QOP=9SNC_MYNAME=p:CN=RFC, OU=ENGG, O=TIBCO, C=US

This example sets up the application server adsap as the RFC destination. Theserver's SNC name is p:CN=BAM, OU=ENGG, O=myCompany, C=US and the SNClibrary is located at C:\SAPUsr\Dev\Ongoing\SNC\sapcrypto.dll.

Parameter Description Required? Valid values DefaultValue

SNC_PARTNERNAME The SNC name of thecommunication partner(application server)

Y string none

SNC_LIB The path and file nameof the gssapi library

Y string none

SNC_MODE The SNC activationindicator

Y 0,1

0 = SNC disabled

1= SNC activated

none

SNC_QOP Quality of protection(protection level)

N 1,2,3,8,9 3

SNC_MYNAME The SNC name of theuser sending the RFC.

N string The nameprovided bythe securityproduct for thelogged-onuser.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 316: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

294 | Working with Secure Network Communications (SNC)

Acceptor (AS ABAP)

Follow steps described in the SAP documentation to configure the acceptor (theAS ABAP) for using SNC, set the profile parameters on the application server.

The value contained in the parameter snc/accept_insecure_rfc determineswhether or not to accept unprotected RFC connections. You can define thisparameter to deny all insecure RFCs, accept all insecure RFCs, or accept insecureRFCs for specific users only (based on the Insecure communications permittedindicator in the table USRACL).

User Authentication in the SAP System

As with RFC calls without SNC protection, you need to specify a user and a clientin the RFC program when connecting to the SAP system. Note the followingdetails about the authentication procedure when using SNC:

— If the SNC name from the RFC program corresponds to the SNC name inthe specified user's master record in the designated client, then the SAPsystem accepts the RFC logon request (without performing additionalauthentication).

— Otherwise, the SAP system searches the USRACLEXT table for an entrycorresponding to the client, user, and SNC name combination. If amatching entry is found, then the SAP system accepts the logon request(without performing additional authentication).

— Otherwise, the SAP system searches the USRACLEXT table for an entrycorresponding to the client, user, and an asterisk (*) as the SNC name. If amatching entry is found, then the system verifies the user's password. If thepassword is valid, then the SAP system accepts the logon as a secure logon.

— Otherwise, the SAP system searches the USRACLEXT table for an entrycorresponding to the client, an asterisk as the user ID, and the RFCprogram's SNC name. If a matching entry is found, then the system verifiesthe user's password. If the password is valid, then the SAP system acceptsthe logon as a secure logon.

— Otherwise, the SAP system searches the USRACLEXT table for an entrycorresponding to the client, an asterisk as the user ID, and an asterisk as theSNC name. If a matching entry is found, then the system verifies the user'spassword. If the password is valid, then the SAP system accepts the logonas a secure logon.

— Otherwise, the SAP system denies the logon request.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 317: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 295

When Establishing the RFC connection

The RFC connection is established over a gateway port. For SNC-protectedconnection requests, the RFC library normally uses the secure gateway port,which accepts only SNC-protected connections. However, if both SNC andload-balancing are used, the RFC libraries also use the conventional gateway portfor SNC-protected connections.

Creating the Access Control List Entries on the Application Server

Access control lists have to be created before configuring SNC between theapplication server and the AGate component. Make sure you have the ANC namefor the AGate before proceeding.

To maintain the SNC system access control list:

1. Use table SNCSYSACL, view VSNCSYSACL, type=E.

See Figure 13, Figure 14, and Figure 15 for reference.

Figure 13 Map the SNC Name to the User

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 318: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

296 | Working with Secure Network Communications (SNC)

Figure 14 Maintain ACL SM30

Figure 15 Work Entry Type

2. Enter the AGate's SNC name in the SNC name field. The System ID field isoptional.

3. Check the checkboxes for:

— Entry for RFC activated

— Entry for CPIC activated

— Entry for DIAG activated (if you use the webgui service)

— Entry for certificates activated (if users log on with X.509 client certificates)

— Entry for external ID (if users log on using an external identity, for example,when using Pluggable Authentication Services)

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 319: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 297

Figure 16 Details for the Access Control List

4. Save the data.

Setup SNC Parameters Specific to Outbound Scenarios

RFC: TCP/IP Connection - Registered Program

For an RFC call that uses a TCP/IP connection to call a registered program, theSAP System is the initiator of the communication and the registered program isthe acceptor. In order to use ISNC protection, a registered program must be linkedwith an rfclib of at least Release 4.5A. It can, however, communicate with a SAPSystem Release 4.0A/B via a 4.0A/B gateway.

Initiator (SAP System)

Use transaction SM59 to maintain RFC destinations and their SNC options.

The following description is only applicable as of Release 4.0.

When maintaining the SNC options for RFC destinations using transaction SM59,you specify the following SNC information:

• SNC mode for the connection (active or inactive)

• Quality of protection (QoP)

• SNC partner name

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 320: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

298 | Working with Secure Network Communications (SNC)

The other settings relevant to SNC (the application server's SNC name, thelocation of the external library, the maximum quality of protection, and thedefault quality of protection) are applied as defined in the application server'sinstance profile.

If the RFC destination is an external RFC server program (Activation type = Start),then note the following:

• If you specify the external server program to start on an explicit host, then youneed to specify the SNC name of the partner host in the SNC options to useSNC for the connection.

• If you specify the external server program to start on the application server oron the front end workstation, then the SNC name of the partner isautomatically derived from an existing secure path and you do not need tospecify the SNC name of the partner in the SNC options. (In this case, the fieldfor the SNC name is not activated.)

Configuring the Communication Partners for Use with SNC

Before configuring the communication parameters make sure the RFC destinationis defined and the SNC activated on the application server.

From the Display and maintain RFC destinations screen (transaction SM59):

1. Place the cursor on the destination application server and choose Change.

2. To enable SNC, select the SNC Activ indicator.

3. Choose Destination SNC Options.

The Change View "SNC extension: Details" screen appears.

4. Enter the quality of protection in the QOP field.

5. Unless the destination is an external program that starts on the front endworkstation (see the note above), enter the SNC name of the communicationpartner in the SNC names group.

6. Save the data.

Quality of Protection (QoP)

The following rules apply to the relationship between the QoP specified whenconfiguring the communication partners and the QoP configured in theapplication server's profile parameter:

• The RFC destination's QoP can be smaller than the application server'ssnc/data_protection/min or larger than the application server'ssnc/data_protection/max.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 321: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 299

• If the RFC destination's QoP is larger than the level provided by the externalsecurity product, then the largest possible QoP is used.

• If the RFC destination's QoP = 8 (default), then the QoP value from theapplication server's snc/data_protection/use is used.

• If the RFC destination's QoP = 9 (maximum), then the QoP value from theapplication server's snc/data_protection/max is used.

For any modifications to these rules refer to the SAP documentation.

Acceptor (registered program)

To apply SNC protection to registered programs that communicate with SAPSystems using RFC, you need to specify the SNC options in either thesaprfc.ini file or use the program interface inrfclib. This section describeshow to specify the information in saprfc.ini. For more information about usingrfclib, see the SAP documentation.

Make sure you provide or install accepting credentials for the RFC serverprogram. The procedure for installing credentials depends on the securityproduct that you use.

Set the SNC parameters in saprfc.ini using values shown in Table 13:Table 13 SNC Parameters for RFC

Parameter Description Required? Valid values DefaultValue

SNC_LIB Path and file nameof the gssapi library

Y String None

SNC_MODE SNC Activationindicator

Y 0, 1

0=SNC disabled

1=SNC activated

None

SNC_QOPOptional Quality ofprotection

(protection level)

N 1,2,3,8,9 3

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 322: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

300 | Working with Secure Network Communications (SNC)

Sample destination in the saprfc.ini file:

DEST=SNCOUTBOUNDTYPE=RPROGID=sapusrpidGWHOST=adsapGWSERV=sapgw00SNC_MODE=1SNC_MYNAME=p:CN=BAM, OU=ENGG, O=TIBCO, C=USSNC_LIB=C:\SAPUsr\Dev\Ongoing\SNC\sapcrypto.dll

SNC_MYNAME Name of the RFCserver program

You can use theparameterSNC_MYNAME tolocally define thename thatcorresponds to thecredentials for theRFC serverprogram. If you do,then make sure thatthis SNC namecorresponds to theSNC name asdefined in the SNCoptions (SNCpartner name) forthe RFC destinationfor this serverprogram. If you donot locally defineSNC_MYNAME,then the registeredprogram uses theSNC name definedin the RFCdestination.

N String The SNCnamecontained inthe RFCdestination'sSNC options.

Parameter Description Required? Valid values DefaultValue

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 323: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Procedure for SNC Setup | 301

Using SNC with Registered Programs

You can only enter one SNC partner name when you enter the SNC options forRFC destinations.

If more than one program has the same registered program ID, they must also usethe same credentials. This is generally not a problem if the programs are startedon the same computer.

However, starting registered programs on different computers is possible only ifthe same credentials can be used on the different computers. This largely dependson the security product used.

SNC INI File Example for the AdapterSetup the following connection parameters in the SAP INI File

• INBOUND Connection INI File Example

DEST=SNCINBOUNDTYPE=AASHOST=adsapSYSNR=00SNC_MODE=1SNC_PARTNERNAME=p:CN=BAM, OU=ENGG, O=myCompany, C=USSNC_LIB=C:\Adapter\Dev\Ongoing\SNC\sapcrypto.dllSNC_QOP=9SNC_MYNAME=p:CN=BAM, OU=ENGG, O=TIBCO, C=US

• OUTBOUND Connection INI File Example

DEST=SNCOUTBOUNDTYPE=R

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 324: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

302 | Working with Secure Network Communications (SNC)

PROGID=adapterpidGWHOST=adsapGWSERV=sapgw00SNC_MODE=1SNC_MYNAME=p:CN=BAM, OU=ENGG, O=myCompany, C=USSNC_LIB=C:\SAPUsr\Dev\Ongoing\SNC\sapcrypto.dll

Transaction CodesThe following Transaction codes are used for the SNC Setup:

• STRUST

• RZ10

• SU01

• SM59

• SM30

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 325: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 303

Appendix A Trace Messages

This appendix explains the trace messages that are logged to a location specifiedat configuration time.

Topics

• Overview

• Trace Message Fields

• Status Messages

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 326: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

304 | Trace Messages

Overview

Trace messages provide information about adapter activities. The messages arelogged to the console where the runtime adapter was started and to a log file.Trace messages can also be redirected to the TIBCO Hawk Display application, orsent to other applications using the TIBCO Rendezvous transport.

Each trace message can include the following fields:

<Timestamp> <Adapter Identifier> <Role> <Category> <Status Code><Tracking Identifier>

The above fields are explained in Trace Message Fields on page 305. Thefollowing diagram shows an example trace message and calls out the fields.

Example Trace Messages

The following trace messages were written during a session where the adapterreceived a message from the SAP system.

The first message indicates that the adapter has started. The timestamp indicateswhen the adapter started, and the role indicates that the trace message isinformational, which means the activity is normal for the adapter. The category isidentified, and the corresponding status code is displayed. The status codeindicates that the adapter started successfully.

2010 Jan 24 10:46:10:486 GMT 5 SAPAdapter.SALESORDER-OUT Info[Adapter] AER3-000082 Successful initialization of Adapter

The next set of trace messages indicates the adapter received a message from theSAP system. The #-0Y--C--DX1ALUbc--4zzzw-TEzzw# tracking identifierincluded in the trace message uniquely identifies the message.2010 Jan 24 10:47:18:644 GMT 5 SAPAdapter.SALESORDER-OUT Info[Adapter] AER3-000114 Received invocation request forBAPI_SALESORDER_CREATEFROMDAT1 from SAP R/3 Systemtracking=#-0Y--C--DX1ALUbc--4zzzw-TEzzw#

2010 Feb 22 20:15:12:937 GMT -8

SAP Adapter.SAP AdapterConfiguration Info [Adapter]

tracking=#MU3oTJ/WWCV1MU96J0zzwA9kzzw#

Timestamp

Adapter Identifier Role Category

Status Code

Tracking Identifier

AER3-000114 Received invocation request for.....

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 327: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Trace Message Fields | 305

Trace Message Fields

Each trace message includes the following fields:

Table 14 Tracing Fields

Field Name Description

Timestamp Timestamp of occurrence. For example, 2010 Feb 22 20:14:51:718 GMT -8.

AdapterIdentifier

Name of the adapter that wrote the trace message. This is a combination of theadapter acronym and adapter configuration name. For example, theapplication identifier, ADB.publisher1 identifies a TIBCO ActiveMatrixAdapter for Database service named publisher1.

Role A role can be:

• Info. Indicates normal adapter operation. No action is necessary. A tracingmessage tagged with Info indicates that a significant processing step wasreached and has been logged for tracking or auditing purposes. Only infomessages preceding a tracking identifier are considered significant steps.

• Warn. An abnormal condition was found. Processing will continue, butspecial attention from an administrator is recommended.

• Error. An unrecoverable error occurred. Depending on the error severity,the adapter may continue with the next operation or may stop altogether.

• Debug. A developer-defined tracing message. In normal operatingconditions, debug messages should not display.

When configuring the adapter you define what roles should or should not belogged. For example, you may decide not to log Info roles to increaseperformance.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 328: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

306 | Trace Messages

Category One of the following:

• Adapter. The adapter is processing an event.

• Application. The adapter is interacting with the SAP system.

• Configuration. The adapter is reading configuration information.

• Database. The adapter is interacting with a database.

• Schema. The adapter is retrieving metadata from the SAP system.

• Palette. The adapter is interacting with the palette.

• Publication. The publication service is reporting this trace message.

• RequestResponseInvocation. The Request-Response invocation service isreporting this trace message.

• RequestResponse. The Request-Response service is reporting this tracemessage.

• Shutdown. The adapter is shutting down.

• Startup. The adapter is starting.

• Subscription. The subscription service is reporting this trace message.

• Connection. This is an application connection related trace message.

• System. This category is not linked to a specific event process. The tracemessage may be related to a Windows service related messages, memoryallocation, file system error, and so on.

• TibRvComm. The adapter is communicating with TIBCO Rendezvous.

• XML. The adapter is parsing XML documents.

Status Code Unique code for the message and description. Status codes are identified by aunique number and description. If a trace message includes an error or warnrole, the status code documentation includes a resolution. See Status Messageson page 308 for details.

Table 14 Tracing Fields

Field Name Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 329: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Trace Message Fields | 307

TrackingIdentifier

A unique identifier that is "stamped" on each message by the originatingadapter. The tracking identifier remains in effect from a message’s beginningto its completion as it is exchanged by TIBCO applications. If the adapter isthe termination point of the message, the tracking identifier is not displayedin the trace message.

You cannot modify the tracking identifier format or configure whatinformation is displayed.

ApplicationInformation

Application-specific information added to the tracking info to trace themessage back to its source. Set initially by the originating adapter and carriedforward. It is augmented by each intermediate component.

Table 14 Tracing Fields

Field Name Description

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 330: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

308 | Trace Messages

Status Messages

The following table lists all the new error messages introduced in this release.

Status Code Role Category Resolution

AER3-000486 Invalid Destination %1 specified

Error Adapter Specify a valid destination.

AER3-910003 Startup Error. The command-line parameter(s): configurl, repourl have notbeen specified

Error Startup Specify the command-line parametersconfigURL and repoURL.

AER3-910005 Startup Error. SDK Error %1 received during initialization. The RepositoryURL is %2 and the Configuration URL is %3

Error Startup Verify your repository settings.

AER3-910006 Startup Error. SDK Exception %1 occurred while creating a shutdownlistener with parameters %2. The Repository URL is %3 and theConfiguration URL is %4

Error Startup Verify your repository settings for validityof configuration for the shut down listener.

AER3-910007 Startup Error. Unable to create a connection with the target application %1using connection parameters %2 and the target application error is %3

Error Startup Verify your repository settings for validityof connection parameters.

AER3-9100012 Startup Error. Unable to create a Custom Hawk Micro Agent Named %1 usedfor %2

Error Startup Verify your repository settings for validityof the stop-subscriber session parameters.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 331: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 309

AER3-940001 Request Response error. Request Response service %1 listening on %2received unexpected null data in incoming request. Expects event %3. TheRepository URL is %4 and the Configuration URL is %5

Error RequestResponse Check the configuration of the applicationthat is requesting the event and make surethat it matches the inbound eventdefinition for the above Request-Responseservice. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofRequest-Response Service.

AER3-940005 Request Response error. Request Response service %1 failed to deserializethe received Request to MInstance: Received event on subject %2, event =%3, SDK exception = %4. The Repository URL is %5 and the ConfigurationURL is %6

Error RequestResponse Check the configuration of the applicationthat is requesting the event and make surethat it matches the inbound eventdefinition for the above Request-Responseservice. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofRequest-Response Service.

AER3-940008 Request Response error. Connection error in invocation of RequestResponse service %1 listening on subject %2. Connection Parameters are %3

Error RequestResponse Check if the end application is up andrunning. Also verify the connectionparameters are specified in the repository.

AER3-940009 Request Response error. Request Response service %1 listening on subject%2 failed due to target application invocation error %3. Target application is%4 and inbound event is %5

Error RequestResponse Check the validity of the incomingrequest-data to the Request-ResponseService.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 332: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

310 | Trace Messages

AER3-940010 Request Response error. Request Response service %1 listening on subject%2 failed to create reply. Error : %3

Error RequestResponse Verify the data received from the SAPsystem and make sure it matches theschema associated to theRequest-Response Service.

AER3-940020 Server Timeout

Error Request-Response

Check if the end application is up andrunning.

AER3-920001 Subscription error. Subscription service %1 listening on %2 received anunexpected event of type = %3, Expects event %4. The Repository URL is %5and the Configuration URL is %6

Error Subscription Check the configuration of the applicationthat is publishing the event and make surethat it matches the inbound eventdefinition for the above subscriptionservice. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofSubscription Service.

If the error message is of the formatSubscription error. Subscription

service %1 listening on %2 received

an unexpected event of type = %3,

Expects event IDOC. The Repository

URL is %5 and the Configuration URL

is %6

and if using the unicode version of theadapter or the non-unicode version of theadapter with UTF-8 message encoding, theproperty adr3.preserveFieldBlanks iseither set to OFF or commented outcausing the subscriber to not successfullyprocess the IDoc.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 333: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 311

AER3-920002 Subscription error. Subscription service %1 failed to deserialize the eventreceived on subject %2 and SDK exception thrown is %3. The RepositoryURL is %4 and the Configuration URL is %5

Error Subscription Check the configuration of the applicationthat is publishing the event and make surethat it matches the inbound eventdefinition for the above subscriptionservice. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofSubscription Service.

AER3-920003 Subscription error. Subscription service %1 listening on subject %2 receivedinbound event with null data. The Repository URL is %3 and theConfiguration URL is %4

Error Subscription Check the configuration of the applicationthat is publishing the event and make surethat it matches the inbound eventdefinition for the above SubscriptionService.

AER3-920007 Subscription error. Subscription service %1 listening on subject %2 couldnot get the class description of %3. The Repository URL is %4 and theConfiguration URL is %5

Error Subscription Check the repository configuration for thisservice. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofSubscription Service.

AER3-920008 Subscription error. Subscription service %1 listening on subject %2 couldnot find the mandatory property %3 in class %4. The Repository URL is %5and the Configuration URL is %6

Error Subscription Check the configuration of the applicationthat is publishing the event and make surethat it matches the inbound eventdefinition for the above SubscriptionService. Refer Chapter 2, Getting Started,on page 15 for details on configuration ofSubscription Service.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 334: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

312 | Trace Messages

AER3-9200015 Subscription error. Subscription service %1 listening on subject %2 faileddue to target application invocation error %3. Target application is %4

Error Subscription Verify the structure of the incomingmessage. Check in the SAP system formore detailed information on the cause ofthe error.

AER3-950001 Request Response Invocation error. Request Response Invocation service %1with subject as %2 received event from target application %3. It failed whileconverting event to request, as it could not get the class description for %4.Repository URL is %5 and the Configuration URL is %6

Error RequestResponseInvocation

Verify the configuration of theRequest-Response Invocation Service andcheck that the schema/class definitions arepresent in the repository. Refer Chapter 2,Getting Started, on page 15 for details onconfiguration of Request-ResponseInvocation Service.

AER3-950003 Request Response Invocation error. Request Response Invocation service %1with subject as %2 received event from target application %3. It failed whileconverting event to request. Repository URL is %5 and the ConfigurationURL is %6

Error RequestResponseInvocation

Verify the configuration of theRequest-Response Invocation Service andcheck that the schema/class definitions arepresent in the repository. Refer Chapter 2,Getting Started, on page 15 for details onconfiguration of Request-ResponseInvocation Service.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 335: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 313

AER3-950008 Request Response Invocation error. Request Response Invocation service %1with subject %2 received error while requesting event over the wire. Error%3

Error RequestResponseInvocation

Check repository settings for validconfiguration of the Request-ResponseInvocation endpoint for this service. ReferChapter 2, Getting Started, on page 15 fordetails on setting up a Request-ResponseInvocation end point and aRequest-Response Invocation Service.

AER3-950009 Request Response Invocation error. Request Response Invocation service %1with subject %2 received error while requesting event over the wire. Error%3

Error RequestResponseInvocation

Check repository settings for validconfiguration of the Request-ResponseInvocation endpoint for this service. ReferChapter 2, Getting Started, on page 15 offor details on setting up aRequest-Response Invocation end pointand a Request-Response InvocationService.

AER3-9500010 Request Response Invocation error. Request Response Invocation service %1with subject %2 received null reply while requesting event over the wire

Error RequestResponseInvocation

Check the target application, if it isrunning or not. Check the configuration ofRequest-Response Invocation Service.

AER3-9500011 Request Response Invocation error. Request Response Invocation service %1with subject %2 received timeout error while requesting event over the wire

Error RequestResponseInvocation

Check repository settings for validconfiguration of the Request-ResponseInvocation endpoint for this service. ReferChapter 2, Getting Started, on page 15 fordetails on setting up a Request-ResponseInvocation end point and aRequest-Response Invocation Service.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 336: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

314 | Trace Messages

AER3-9500012 Request Response Invocation error. Request Response Invocation service %1with subject %2 received error while processing reply message. Error %3

Error RequestResponseInvocation

Check repository settings for validconfiguration of the Request-ResponseInvocation endpoint for this service. ReferChapter 2, Getting Started for details onsetting up a Request-Response Invocationend point and a Request-ResponseInvocation Service.

AER3-930003 Publication error. Publication service %1 with publishing subject as %2received event from target application %3. It failed while converting event toMInstance as it could not get the class description for %4. Repository URL is%5 and the Configuration URL is %6'

Error Publication Verify the configuration of the publicationservice and check that the schema/classdefinitions are present in the repository.Refer Chapter 2, Getting Started for detailson configuration of Publication Service.

AER3-930006 Publication error. Publication service %1 with publishing subject %2received the event from target application %3. It failed while convertingevent to MInstance attribute %4 of class %5 is missing. RepositoryURL is %6and the ConfigurationURL is %'

Error Publication Verify the configuration of the publicationservice and check that the schemadefinitions are present in the repository.Refer Chapter 2, Getting Started for detailson configuration of Publication Service.

AER3-9300014 Publication error. Publication service %1 with publication subject %2received error while sending event over the wire. Error : %3

Error Publication Check repository settings for validconfiguration of the publish endpoint forthis service. Refer Chapter 2, GettingStarted for details on setting up a publishend point and a Publication Service.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 337: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 315

AER3-930015 Property: adr3.preserveFieldBlanks must be set to ON when using messageencoding UTF-8 for publisher: %1 in mode: %2

Error RequestResponse Verify that the propertyadr3.preserveFieldBlanks is set to ON.

AER3-890006 Connection Error. Adapter stopping due to persistent connection errors tothe SAP system(s)

Error Connection Check the SAP system(s) connected to,and restart the adapter.

AEADR3-600001 JMS Service Configured. This adapter version does not support JMSservices, but one was found. Use the Go To button to select it.

Warning Configuration You have configured a service withtransport type as JMS. But the AE Versionof this adapter instance does not supportJMS. You may change the AE Version ormake sure that the runtime version ishigher than this version.

AEADR3-600002 XML Wire Format found. This adapter version does not support XML WireFormat.

Warning Configuration You have configured a service with XMLWire Format. But the AE Version of thisadapter instance does not support XMLformat. You may change the AE Version ormake sure that the runtime version ishigher than this version.

AEADR3-600003 Subscriber in exploded batch mode found. This adapter version does notsupport Subscriber in Explode Batch Mode.

Warning Configuration You have configured a Subscriptionservice with Exploded Batch Mode. Butthe AE Version of this adapter instancedoes not support Subscriber in ExplodedBatch Mode. You may change the AEVersion or make sure that the runtimeversion is higher than this version.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 338: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

316 | Trace Messages

AEADR3-600004 Connection Retry Mechanism Warning. This adapter version does notsuspend services on connection failure. The configured value 'AdapterTermination Criteria' will be ignored.

Warning Configuration You have configured a service withConnection Retry. But the AE Version ofthis adapter instance does not suspendservices on connection failure. You maychange the AE Version or the value of'Adapter Termination Criteria' will beignored.

AEADR3-600005 Connection Retry Mechanism Warning. This adapter version does notsuspend services on connection failure. The configured values 'Number ofReconnect Attempts Before Suspending Impacted Service(s)' and 'AdapterTermination Criteria' will be ignored.

Warning Configuration You have configured a service withConnection Retry. But the AE Version ofthis adapter instance does not suspendservices on connection failure. You maychange the AE Version or the value of'Adapter Termination Criteria' will beignored.

AEADR3-600006 Empty Service Found. The Service is not Configured Or Class Reference orEndpoint Reference is Empty.

Warning Configuration You have configured an adapter instancewith a service which has no schemaassociated with it. Such an adapterinstance cannot be used at run-time. Makesure that you do not have an empty servicebefore deploying the adapter instance.

AEADR3-600007 Absolute Path not Found. Field %1, Palette error. Unable to find specifiedabsolute path. Make sure that you have specified the absolute path correctly.

Error Configuration Absolute path of the Plugin Directory notfound. Check the path.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 339: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 317

AEADR3-600008 Connection Failure. Test Connection Failed

Information DTA Test Connection to SAP R3 System failed.Check your connection parameters.

AEADR3-600009 Connection Failure. %1

Information DTA Test Connection to SAP R3 System failed.Check your connection parameters.

AEADR3-600010 Connection Success. Hostname - %1, System Name - %2, R-3 Release - %3

Information DTA Indicates normal adapter operation. Noaction necessary.

AEADR3-600011 Error copying Configuration information/Inbound Connection Type doesnot support copying of connection information from Configuration view.

Error Configuration You are trying to copy Design-Timeparameters to Run-Time InboundConnection which is not of type’Dedicated.’ If you want to copy, makesure that the default inbound connectiontype is ’Dedicated’.

AEADR3-600012 Illegal Adapter Instance Name. Adapter Configuration names must haveonly alphanumeric characters with no embedded spaces and can be up to 80characters long. Type in a valid name.

Error Configuration Cannot rename the adapter instance.Provide a valid name. Make sure you haveentered alphanumeric characters, no blankspaces, and the name is not more than 80characters.

AEADR3-600013 Subject Names. Do you wish to regenerate subjects set to previous defaults?

Error Configuration Click YES to regenerate.

AEADR3-600014 Regenerate Names?. Do you wish to regenerate Subject Names, ConnectionNames and Session Parameters?

Warning Configuration Click YES to regenerate.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 340: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

318 | Trace Messages

AEADR3-600015 Replace Resource. The resource %1 is already defined as a type. Do you wantto replace it?

Warning Configuration Click OK to continue.

AEADR3-600016 Illegal Operation/The new nested name is in conflict with the name of theresource you are editing. Rename the existing resource or choose a differentname.

Error Configuration Conflicting resource names. Try using adifferent name.

AEADR3-600017 Select an IDoc. You did not make a selection.

Error DTA Select an IDoc.

AEADR3-600018 Select an RFC Function. You did not make a selection.

Error DTA Select an RFC function.

AEADR3-600019 IDoc Fetch Failed. %1

Error DTA No IDocs were retrieved. Check yourconnection parameters and your IDocfilter criteria.

AEADR3-600020 RFC Fetch Failed. %1

Error DTA No RFCs were retrieved. Check yourconnection parameters and your RFC filtercriteria.

AEADR3-600021 Reuse Schema Type. Schema for %1 already exists. Do you want to reuseexisting schema?

Warning Schema This is a Yes/No option. Select Yes if youwant to use the existing schema. Select Noif you want to re-download the schema forthe SAP R3 system.

AEADR3-600022 Deleting Operation Type. Do you want to delete %1 ?

Warning Configuration Delete confirmation. Select Yes to delete.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 341: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 319

AEADR3-600023 Invalid Value. Field %1, Palette error. This is not a valid value.

Error Configuration You tried to enter an invalid value in theconnection parameters.

AEADR3-600024 Invalid Value. Palette error. Endpoint Reference cannot have null value.

Error Configuration Endpoint Reference is empty. Select a validend-point reference.

AEADR3-600026 Filter Length Exceeded. Palette error. The RFC Filter cannot be more than 30characters in Length. Enter a filter value less than 30 characters in length.

Error DTA You have exceeded the filter length. Entera filter value less than 30 characters inlength.

AEADR3-600027 Filter Length Exceeded. Palette error. The RFC Group Filter cannot be morethan 26 characters in Length. Enter a filter value less than 26 characters inlength.

Error DTA You have exceeded the filter length. Entera filter value less than 26 characters inlength.

AEADR3-600028 Illegal Operation. Selected Resource Can Not Be Moved

Error Configuration No resolution.

AEADR3-600029 Filter Applied to mandatory segments. You have applied the filter on thefollowing mandatory segment(s)

Warning Schema You have applied a filter on mandatorysegments. Uncheck the filter on thesesegments.

AEADR3-600030 Error Occurred. Error Creating Global Variables.

Error Repository TIBCO Designer encountered an errorwhile creating global variables. You mayhave to manually create global variables inthe Global Variables pane.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 342: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

320 | Trace Messages

AEADR3-600031 Not Found. No IDocs Retrieved. Check the filter.

Information DTA Check IDoc Filter.

AEADR3-600032 Not Found. No RFCs Retrieved. Check the filter.

Information DTA Check RFC Filter.

AEADR3-600033 No List. IDoc List could not be retreived-%1'

Information DTA Check IDoc Filter.

AEADR3-600034 No List. RFC - BAPI List could not beretreived-%1'

Information DTA Check RFC/BAPI Filter.

AEADR3-600035 Error Occurred. Conflicting Services. A Publication Service, having the sameSchema, is already configured.

Error Schema You already have a Publication servicewith the same schema. You cannotconfigure another service in the sameadapter instance.

AEADR3-600036 Error Occurred. Conflicting Services. A Subscription Service, having thesame Schema, is already configured.

Error Schema You already have a Subscription servicewith the same schema. You cannotconfigure another service in the sameadapter instance.

AEADR3-600037 Error Occurred. Conflicting Services. A Request-Response Service, havingthe same Schema, is already configured.

Error Schema You already have a Request-Responseservice with the same schema. You cannotconfigure another service in the sameadapter instance.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 343: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 321

AEADR3-600038 Error Occurred. Conflicting Services. A Request-Response InvocationService, having the same Schema, is already configured.

Error Schema You already have a Request-ResponseInvocation service with the same schema.You cannot configure another service inthe same adapter instance.

AEADR3-600039 Download Operation Schema. Schema for operation %1 is already available,Use existing schema?

Warning Schema Click YES to reuse existing schema. ClickNO to re-download schema from SAP R3system.

AEADR3-600040 Regenerate Resources ? Do you want to regenerate endpoint and subjectinformation?

Warning Configuration Click YES to regenerate.

AEADR3-600041 Regenerate Resources? Do You want to regenerate Subject Names andSession Parameters?

Warning Configuration Click YES to regenerate.

AEADR3-600042 Regenerate Connections. Do You want to regenerate Connection Names?

Warning Configuration Click YES to regenerate ConnectionNames.

AEADR3-600043 Error while pasting. Deserialization of Schema Failed.

Error Schema Copy/Paste of schemas failed. Tryconfiguring again.

AEADR3-600044 Error while pasting. Deserialization of R3 Connections Failed.

Error Configuration Copy/Paste of connections failed. Tryconfiguring again.

AEADR3-600045 Error while writing the Meta Url.

Error Configuration Error in Meta URL. Try configuring again.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 344: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

322 | Trace Messages

AEADR3-600046 Inbound Management Warning. This adapter version does not supportInbound Management.

Warning Configuration You have configured an adapter instancewith Inbound Management. But the AEVersion of this adapter instance does notsupport Inbound Management. You maychange the AE Version or make sure thatthe runtime version is higher than thisversion.

AEADR3-600047 Advanced Logging Warning. This adapter version does not supportadvanced logging to a file.

Warning Configuration You have configured an adapter instancewith advanced logging. But the AEVersion of this adapter instance does notsupport advanced logging to a file. Youmay change the AE Version or make surethat the runtime version is higher than thisversion.

AEADR3-600048 Confirm Publisher Warning. This adapter version does not support confirmpublisher on the inbound side.

Warning Configuration You have configured an adapter instancewith advanced logging. But the AEVersion of this adapter instance does notsupport advanced logging to a file. Youmay change the AE Version or make surethat the runtime version is higher than thisversion.

AEADR3-600049 Valid destination Warning. This adapter version does not support Validatingdestination on the inbound side

Warning Configuration You have configured an adapter instanceto validate destination on the inboundside. But the AE Version of this adapterinstance does not support validatingdestination on the inbound side. You maychange the AE Version or make sure thatthe runtime version is higher than thisversion.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 345: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 323

AEADR3-600050 Not Checked out. Failed to update Schema. The associated Schema files arenot checked out from source control.

Error Configuration Check out schema files from the sourcecontrol.

AEADR3-600051 Illegal child error occurred while processing connection - %1

Error Configuration Error while processing R3 Connection. Tryconfiguring again.

AEADR3-600052 Name conflict error occurred while processing connection - %1

Error Configuration Error while processing R3 Connection. Tryconfiguring again.

AEADR3-600053 Error occurred while applying changes to connection - %1

Error Configuration Error while applying changes to R3Connection. Try configuring again.

AEADR3-600054 Not Checked out. Failed to update R3Connections. The connection file is notchecked out from source control

Error Configuration Check out the connection file from sourcecontrol.

AEADR3-600055 Error Renaming Service. Service name must only have alphanumericcharacters and must be at most 80 characters long.

Error Configuration Cannot rename the service. Provide a validname. Make sure you have enteredalphanumeric characters, no blank spaces,and the name is not more than 80characters.

AEADR3-600056 Global Variables File:Read-Only. Global Variable files needs to be checkedout in order to successfully create the adapter.

Error Configuration Check out Global Variables file fromsource control.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 346: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

324 | Trace Messages

AEADR3-600057 Error During Rename : Read-Only File. The resource %1 could not berenamed. Rename requires the %2 should be checked out. Check out theresource and try renaming again. You can select the resource to be checkedout by clicking on the Go To Resource button.

Error Configuration Check out the resource and try renamingagain.

AEADR3-600058 Error During Delete : Read-Only File/The resource %1 could not be deleted.Delete requires the %2 should be checked out. Check out the resource andtry deleting again. You can select the resource to be checked out by clickingon the Go To Resource button.

Error Configuration Check out the resource and try deletingagain.

AEADR3-600059 Error During Creation of Service : Read-Only File. The service can not becreated. Creation requires the %1 should be checked out. Check out theresource and try creating the service again. You can select the resource to bechecked out by clicking on the Go To Resource button.

Error Configuration Check out the resource and try creating theservice again.

AEADR3-600060 Need to Add File to RCS: %1 was created during schema generation. Ensurethat this resource is added to RCS and checked in. Click on the Go ToResource button to select the resource.

Warning Configuration Ensure that this resource is added to RCSand checked in.

AEADR3-600061 RFC/BAPI: %1: Import/Export parameters referencing String data type areignored.

Warning Configuration The schema for the RFC/BAPI includingimport or export referencing String datatypes can be downloaded. But anyreferences to String data types are ignoredat runtime.

If parameters referring to String data typesare required, create a custom module andchange any references of String data typeto fixed character types.

Status Code Role Category Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 347: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 325

The following table lists error messages for which codes have been changed.

AEADR3-600062 RFC/BAPI: %1: Invalid parameter: %2, (%3) data type not allowed. Removeselection.

Error Configuration When downloading a RFC/BAPIcontaining parameters referring to a tabletype or complex or nested type removeselection by unchecking the selection. Ifthis RFC/BAPI is required, create acustom module and use the internal tablesand flat structures.

Status Code Role Category Resolution

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

AER3-000000 R3-CORE-APP-8000

INFO AD The request doesnot containclosure data foroperation %1

Indicates normaladapter operation. Noaction necessary.

AER3-000001 R3-CORE-APP-8001

Error AD Invalid closuredata for operation%1

Create a correctinstance ofRFC_CLOSUREdefined inSAPAdapterSchema.x

ml and set it as closuredata in the request tobe sent to the inboundadapter. To find outmore about closure,refer to TIB AdapterSDK documentationand TIBCO 2.0ActiveEnterprise wireformat.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 348: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

326 | Trace Messages

AER3-000002 R3-CORE-APP-8002

Error AP Invalid value forattribute %1 foroperation %2

Verify if you are usingthe correct classdescriptions and valuespecified is valid andno mandatory valuesare omitted.

AER3-000003 R3-CORE-APP-8003

Error AD Function call istransactional butno provided

When you setbTransactional inclosure, you must alsosupply a value for .

AER3-000004 R3-CORE-APP-8004

INFO S Adapterapplication %1 isstopped

Indicates normaladapter operation. Noaction necessary.

AER3-000005 R3-CORE-CFG-1000

Error C Could not findinterfacedescriptionelement

This problem mightalso occur if theconfiguration file isedited manually and isinvalidated in theprocess. After makingany changes to the filemake sure that theXML file is wellformed. The SML filecan be validated byopening it in an XMLenabled browser.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 349: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 327

AER3-000006 R3-CORE-CFG-1001

Error C %1 not specifiedfor %2

This problem mightalso occur if theconfiguration file isedited manually and isinvalidated in theprocess. After makingany changes to the filemake sure that theXML file is wellformed. The file can bevalidated by openingit in an XML enabledbrowser.

AER3-000007 R3-CORE-CFG-1003

INFO C management islocal

It is advisable to use aremote Manager ifmore than multipleadapters are runningin a load balancedmanner. This is toensure that the failedtransactions are notexecuted twice amongthe load balancedgroup. This means thatit is possible to getduplicate messages ifmore than oneadapters are being runin a load balancedconfiguration and aresetup to do localmanagement.

AER3-000008 R3-CORE-CFG-1004

Error C file is notspecified

Specify the file name,attribute"tidFileName" in theadapter instance levelAdapter Services

tab.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 350: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

328 | Trace Messages

AER3-000009 R3-CORE-CFG-1005

Error C Timer %1 does notexist

Provide a correctreference to the TIBAdapter SDK timer inthe server connectionsection of theconnection manager.

AER3-000010 R3-CORE-CFG-1006

Error C The interface %1does not specifyattribute'classRef'

Provide a correctreference to the TIBCOAdapter SDK timer inthe server connectionsection of theconnection manager

AER3-000011 R3-CORE-CFG-1007

Error C Invalid producer%1

Provide a correctreference to an TIBCOAdapter SDKproducer (publisher).

AER3-000013 R3-CORE-CFG-1009

Error C No RpcClientspecified foroperation %1

Provide a validreference to an TIBAdapter SDK RPCClient through"mbRpcClientRef"element inDeploymentDescriptions of IDocs.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 351: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 329

AER3-000014 R3-CORE-CFG-1010

WARN C Interface %1 doesnot containdeploymentdescription forIDocs...continuing...

Provide a validreference to anMBOperation. Alsoadd a reference to theXML document thatcontains thedescriptions for thisoperation. This is doneusing the modeldocument tag at thebeginning of theconfiguration file inthe document section.

The default classdescriptions for MBoperations, i.e.UserExitSchema.xml,can also be extendedwith class descriptionfor additionaloperations.

AER3-000015 R3-CORE-CFG-1011

INFO C Invalid producer%1; using defaultproducer %2

Indicates normaladapter operation. Noaction necessary.

AER3-000016 R3-CORE-CFG-1012

Error C Invalid consumercomponent %1

Modify yourconfiguration bydefining a consumername as suggested bythe error description.

AER3-000017 R3-CORE-CFG-1013

Error C No componentsdefined in theconfigurationdocument

Modify yourconfiguration so that ithas at least onecomponent under the'components' section.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 352: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

330 | Trace Messages

AER3-000018 R3-CORE-CFG-1014

Error C No connectionmanager defined inthe configurationdocument

Modify yourconfiguration so that ithas a'connectionManager'under the'connectionManagers'section.

AER3-000019 R3-CORE-CFG-1015

Error C Invalid rpcServer%1 specified forinterface %2

Modify yourconfiguration so that ithas a'connectionManager'under the'connectionManagers'section.

AER3-000020 R3-CORE-CFG-1016

Error C The SubscriberDescription doesnot specifyconsumerreference,skipping ...

Add consumerRefattribute in theconfiguration.

AER3-000021 R3-CORE-CFG-1017

Error C Consumer %1 fordeploymentdescription %2does not exist

ConsumerRef mustpoint to a validsubscriber.

AER3-000022 R3-CORE-CFG-1018

WARN C No instancedefined for %1;control fieldswill not bereplaced

You must have aninstance defined underclass instances.

AER3-000023 R3-CORE-CFG-1019

WARN C Invalid referencefor attributeconsumerRef

ConsumerRef mustpoint to a validsubscriber.

AER3-000024 R3-CORE-FIL-3000

Error S Error whilereadingdirectory=%1,filename=%2; %3

Determine the causefrom the errordescription.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 353: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 331

AER3-000025 R3-CORE-FIL-3001

WARN S directory=%1,filename=%2; Nomatching filesfound

There were nomatching files. Checkyour filenames.

AER3-000026 R3-CORE-FIL-3002

Error S Could not open %1for reading

The specific file couldnot be opened. Checkpermissions.

AER3-000027 R3-CORE-FIL-3003

Error S %1 is unreadable Check whether the filecan be opened using atext editor.

AER3-000028 R3-CORE-FIL-3004

WARN S %1 is empty File is empty.

AER3-000029 R3-CORE-FIL-3005

Error S %1 does notcontain newline.Perhaps not a textfile

The file is not a textfile, because it doesnot contain a new line.

AER3-000030 R3-CORE-FIL-3006

INFO AD IDoc from file %1sent in %2 mode

Indicates normaladapter operation. Noaction necessary.

AER3-000031 R3-CORE-IDC-7000

Error AD Unsupporteddatatype %1

The datatype isunsupported by SDKor SAP or both.

AER3-000032 R3-CORE-IDC-7001

WARN AD Cannot get controlrecord for IDoc

The IDoc does nothave a control record.If it’s not intentional,add a control record.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 354: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

332 | Trace Messages

AER3-000033 R3-CORE-IDC-7002

Error AD class name invalidfor IDoc

The adapter receivedan IDoc but could notdetermine its class. Ifyou are creating theIDoc meant to beconsumed by theadapter, ensure thatyou are creating itcorrectly.

AER3-000034 R3-CORE-LIB-6000

WARN AD False call to %1 See the errordescription for moredetails.

AER3-000035 R3-CORE-LIB-6001

WARN AD Could not generateGUID

Even though awarning, this messageis often indicative of amemory-low situationthat could severelyaffect the adapterperformance.

AER3-000036 R3-CORE-LIB-6002

Error AD No connection for%1

The namedcomponent does nothave a validconnection Manager.Refer also to thedescription for'R3-CORE-CFG-1014'.

AER3-000037 R3-CORE-LIB-6003

Error AD Could not createManager

If the problem persists,repeat with remoteManagement.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 355: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 333

AER3-000038 R3-CORE-LIB-6004

Error C Could not finddefault clientconnection

Modify yourconfiguration so thatthe login parametersthat you specify for'defaultClient' arevalid and that theAdapter can establisha valid connection tothe SAP System.

AER3-000039 R3-CORE-LIB-6005

Error AD No proxy definedto process requestfor RFC function%1

The Adapter could notcreate a proxy for thenamed RFC function.Look at the earliererror messages in thelog file(s) for possiblecauses.

AER3-000040 R3-CORE-LIB-6006

INFO AD Adding RFCfunction %1

For an inboundconfiguration, themessage means thatthe Adapter can serveas an RFC Client; foran outboundconfiguration, themessage means thatthe Adapter can serveas an RFC Server.

AER3-000041 R3-CORE-LIB-6007

Error AD Unable to createRFC serverfunction %1

Look at earlier errormessages in the logfile(s) for possiblecauses.

AER3-000042 R3-CORE-LIB-6008

Error AD Unable to createrequest proxy for%1

Look at earlier errormessages in the logfile(s) for possiblecauses.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 356: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

334 | Trace Messages

AER3-000043 R3-CORE-LIB-6009

Error AD Unable to createRFC client for %1

Look at earlier errormessages in the logfile(s) for possiblecauses.

AER3-000044 R3-CORE-LIB-6010

Error AD Unable to createfunction impl for%1

Look at earlier errormessages in the logfile(s) for possiblecauses.

AER3-000045 R3-CORE-LIB-6011

Error AD RFC functioninitializationfailure : %1;function name : %2

Look at the errordescription for thecause of the failure.

AER3-000046 R3-CORE-LIB-6012

Error AD Cannot createpublisher proxyfor %1

Look at earlier errormessages in the logfile(s) for possiblecauses.

AER3-000047 R3-CORE-LIB-6014

Error AP %1 is not a validstructure or table

If the name representsa valid SAP structure(or table), ensure thatthe repository containsthe class definition forthis structure (ortable). If you aresending data fromyour customprogram(s) to the SAPAdapter, make surethat you'reconstructing the datacorrectly and thatyou're using validclasses.

AER3-000048 R3-CORE-LIB-6015

Error AD Unpacking error:Invalid class typefor structure %1

Data inappropriate forthe named structure.See alsoR3-CORE-LIB-6014.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 357: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 335

AER3-000049 R3-CORE-LIB-6016

Error AD Unpacking error:Invalid class typefor table %1

Data inappropriate forthe named table. SeealsoR3-CORE-LIB-6014.

AER3-000050 R3-CORE-LIB-6017

Error AP Unpacking error:Row of table %1 isnot a structure

Data inappropriate forthe named table. SeealsoR3-CORE-LIB-6014.

AER3-000051 R3-CORE-LIB-6018

INFO AD User-definedoperation calledsuccessfully

The Adapter invokedthe user-definedoperation successfully.

AER3-000052 R3-CORE-LIB-6019

Error AD Invalid or no datareceived fromuser-definedoperation

Check the programthat implements theuser-defined operationand make sure that itreturns data.

AER3-000053 R3-CORE-LIB-6020

Error AD User-definedoperationinvocationexception; name :%1, data : %2

Ensure that youroperation executeswithout any exceptionand that it returnsvalid data to theAdapter.

AER3-000054 R3-CORE-LIB-6021

Error AD User-definedoperationinvocation timeout

Ensure that the RpcServer thatimplements youroperation is runningand that it is reachablefrom the Adapter.

AER3-000055 R3-CORE-LIB-6022

Error AD User-definedoperationinvocation : badreply received

Ensure that youroperation returnsvalid data to theAdapter.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 358: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

336 | Trace Messages

AER3-000056 R3-CORE-LIB-6023

Error AD User-definedoperationinvocationexception; name :%1

Ensure that youroperation executeswithout any exceptionand that it returnsvalid data to theAdapter.

AER3-000057 R3-CORE-LIB-6024

Error AD The request sentto user-definedoperation containsinvalid data

If you're constructingthe data to be sent tothe user-definedoperation, ensure thatit's being constructedcorrectly.

AER3-000058 R3-CORE-LIB-6025

Error AD Invalid operationname for IDoc %1

The Adapter foundthat the IDoc data isarriving from afunction other than'IDOC_INBOUND_ASYNCHRONOUS' or'INBOUND_IDOC_PROCESS'.

AER3-000059 R3-CORE-LIB-6026

Error AD Cannot create IDocparser instance

The error indicatesthat it could not createa parser, eitherbecause of amemory-low problemor because of an earliererror during Adapterinitialization.

AER3-000060 R3-CORE-LIB-6027

Error AP Invalid RFCfunction %1

Look at earlier errormessages in the logfile(s) for possiblecauses.

AER3-000061 R3-CORE-LIB-6028

WARN AD The IDoc %1 couldnot be exploded

SeeR3-CORE-LIB-6026.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 359: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 337

AER3-000062 R3-CORE-LIB-6029

Error AD Unable to createreply listener foroperation %1

See earlier messages inthe log file(s) forpossible causes.

AER3-000063 R3-CORE-LIB-6030

Error AD RFC invocationtimeout forfunction %1;description : %2

The named RFCfunction invocationtimed out. See errordescription for moredetails.

AER3-000064 R3-CORE-LIB-6031

Error AD RFC invocation badreply for function%1; description :%2

The named RFCfunction returned abad reply. See errordescription for moredetails.

AER3-000065 R3-CORE-LIB-6032

Error AD RFC invocationremote exception;name : %1,description : %2

The named RFCfunction caused aremote exception. Seeerror description formore details.

AER3-000066 R3-CORE-LIB-6033

Error AD Cannot create IDocparser instancefor subscriber %1

The error indicatesthat it could not createa parser, eitherbecause of amemory-low problemor because of an earliererror during Adapterinitialization.

AER3-000067 R3-CORE-LIB-6034

WARN AD Invalid MTree datareceived forsubscriber

See earlier errormessages in the logfile(s) for possiblecauses.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 360: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

338 | Trace Messages

AER3-000068 R3-CORE-LIB-6035

Error AD Cannot create IDocdata instance fromreceived IDoc tree

The adapter subscriberreceived MTree databut the received datacould not be convertedto an MInstance.Because an MInstanceis an MTree boundedby a class, the errorimplies that thereceived MTree isincorrect. If it is yourapplication that issending the offendingdata to the adaptersubscriber, make surethat your data is valid.

AER3-000069 R3-CORE-LIB-6036

Error AD Cannot implodeIDoc %1

Either the adapterencountered alow-memorycondition or thereceived data isincorrect. If it is yourapplication that issending the offendingdata to the adaptersubscriber, make surethat your data is valid.

AER3-000070 R3-CORE-LIB-6037

Error AD Cannot get RFCclient function %1

Make sure that SAPlogin parameters arecorrect and that thesubscriber adapter canreach the SAP system.Also check earliererror messages in thelog file(s) for possiblecauses.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 361: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 339

AER3-000071 R3-CORE-LIB-6038

Error AD Cannot getmarshaller for RFCclient function %1

The subscriber adaptercould not getmarshaller to convertbetween adapter dataand SAP data, perhapsbecause of alow-memory problemor because of an errorencountered earlierduring initialization.Check the earlier errormessages in the logfile(s) for possiblecauses.

AER3-000072 R3-CORE-LIB-6039

Error AP Client connection%1 is invalid

Ensure that the loginparameters are correctand that the Adaptercan reach the SAPsystem.

AER3-000073 R3-CORE-LIB-6040

Error AP Cannot get RFCconnection forclient %1

See R3-CORE-LIB-60.

AER3-000074 R3-CORE-LIB-6041

Error AD Operation %1 timedout

Make sure that theRPC Server thatcorresponds to thenamed operation isexecuting and isaccessible from theAdapter.

AER3-000075 R3-CORE-LIB-6042

WARN AD Operation %1returned a badreply %2

The named operationreturned a bad reply.Look at the errormessage descriptionfor more details.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 362: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

340 | Trace Messages

AER3-000076 R3-CORE-LIB-6043

Error AD Initializationexception type :%1, operation :%2, description :%3

The named operationreturned the namedexception. Look at theerror messagedescription for moredetails.

AER3-000078 R3-CORE-LIB-6045

INFO AD Successfully addedRFC function %1

The Adaptersuccessfully added thenamed RFC function.Depending on theconfiguration, theadapter can functionas an RFC client, RFCServer, or both.

AER3-000079 R3-CORE-LIB-6046

Error AD Unpacking error The Adapterencountered an erroreither because oflow-memorycondition or becauseof an error earlierduring theinitialization. Checkthe earlier errormessages in the logfile(s) for possiblecauses.

AER3-000080 R3-CORE-LIB-6047

WARN AD Could not createTIBCO RV advisoryhandlers;exception type :%1, description :%2

The Adapter could notcreate the licenseexpiry advisories.Look at the errordescription for moredetails.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 363: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 341

AER3-000081 R3-CORE-LIB-6048

WARN AD Could not createTIBCO Hawkimplants;exception type :%1, description :%2

The adapter could notcreate TIBCO Hawkimplants. Look at theerror description formore details.

AER3-000082 R3-CORE-LIB-6049

INFO AD Successfulinitialization ofAdapter

Indicates normaladapter operation. Noaction necessary.

AER3-000083 R3-CORE-LIB-6050

Error AD Unable to createoperation requestfor function : %1,class : %2,rpcClient : %3

The Adapter could notcreate Operationrequest for the namedfunction. Look at theerror description formore details.

AER3-000084 R3-CORE-LIB-6051

INFO AP Received IDocName/Number/Receiving Partner: %1,Count: %2

Indicates normaladapter operation. Noaction necessary.

AER3-000085 R3-CORE-LIB-6052

INFO AD IDoc sent in %1mode

Indicates normaladapter operation. Noaction necessary.

AER3-000086 R3-CORE-LIB-6053

INFO AD IDoc received in%1 mode

Indicates normaladapter operation. Noaction necessary.

AER3-000087 R3-CORE-LIB-6054

INFO AD IDoc Sent to SAPSystem

Indicates normaladapter operation. Noaction necessary.

AER3-000088 R3-CORE-LIB-6055

INFO AD IDoc sent as aBusiness Document

Indicates normaladapter operation. Noaction necessary.

AER3-000089 R3-CORE-LIB-6056

INFO AD IDoc received as aBusiness Document

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 364: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

342 | Trace Messages

AER3-000090 R3-CORE-LIB-6057

INFO C The Destination %1in not defined,IDoc is logged tofile %2

Indicates normaladapter operation. Noaction necessary.

AER3-000091 R3-CORE-LIB-6058

INFO AD Total IDocsprocessed: %1

Indicates normaladapter operation. Noaction necessary.

AER3-000092 R3-CORE-LIB-6059

INFO AD The subscriber forthis IDoc messagecould not bedetermined

Indicates normaladapter operation. Noaction necessary.

AER3-000093 R3-CORE-LIB-6060

INFO AD IDoc Messagesequence number %1confirmed to %2

Indicates normaladapter operation. Noaction necessary.

AER3-000094 R3-CORE-LIB-6061

INFO AD Preparing to sendIDoc to client %1

Indicates normaladapter operation. Noaction necessary.

AER3-000095 R3-CORE-LIB-6062

INFO AD IDoc sent toclient %1

Indicates normaladapter operation. Noaction necessary.

AER3-000096 R3-CORE-LIB-6064

INFO AD IDoc Messagesequence number %1could not beconfirmed to %2,Usepre-registrationof subscribers

Indicates normaladapter operation. Noaction necessary.

AER3-000097 R3-CORE-LIB-6065

INFO C IDoc Message couldnot be confirmed,validation must beturned off, if 10XPublishers used

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 365: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 343

AER3-000098 R3-CORE-LIB-6066

INFO AP IDoc RFC Functioninvoked: %1

Indicates normaladapter operation. Noaction necessary.

AER3-000099 R3-CORE-LIB-6067

INFO AD RFC Functioninvoked: %1

Indicates normaladapter operation. Noaction necessary.

AER3-000100 R3-CORE-LIB-6068

WARN C User-definedoperation:operation notspecified,assuming'transform'

If the default transferis not desired, nameyour operationexplicitly.

AER3-000101 R3-CORE-LIB-6069

WARN C User-definedoperationreference:operationRpcClientRef not specified,operation will notbe invoked

The operation requiresan rpcClient, specificthroughoperationRpcClientRef. Specify this client.

AER3-000102 R3-CORE-LIB-6070

Error AD operation timedout. Make surethat Manager isrunning

Make sure Manager isrunning and isaccessible from theAdapter. Also, ensurethat subject namesmatch.

AER3-000103 R3-CORE-LIB-6071

INFO AD Adding %1parameter %2, Type%3

Indicates normaladapter operation. Noaction necessary.

AER3-000104 R3-CORE-LIB-6072

INFO AD Setting up Importsand Exports forRFC function %1

Indicates normaladapter operation. Noaction necessary.

AER3-000105 R3-CORE-LIB-6073

INFO AD RFC function has%1 imports, %2exports

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 366: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

344 | Trace Messages

AER3-000106 R3-CORE-LIB-6074

INFO AD %1 = { %2 } Indicates normaladapter operation. Noaction necessary.

AER3-000107 R3-CORE-LIB-6075

INFO AD Number of recordsin table %1 = %2

Indicates normaladapter operation. Noaction necessary.

AER3-000108 R3-CORE-LIB-6076

INFO AD Invoking function:%1 ...

Indicates normaladapter operation. Noaction necessary.

AER3-000109 R3-CORE-LIB-6077

INFO AD Successfullyinvoked function:%1

Indicates normaladapter operation. Noaction necessary.

AER3-000110 R3-CORE-LIB-6078

INFO AD Reply sent forfunction: %1

Indicates normaladapter operation. Noaction necessary.

AER3-000111 R3-CORE-LIB-6079

INFO AD Received replyfor: %1 ...

Indicates normaladapter operation. Noaction necessary.

AER3-000112 R3-CORE-LIB-6080

INFO AD Data sent back toSAP System

Indicates normaladapter operation. Noaction necessary.

AER3-000113 R3-CORE-LIB-6081

INFO AD Performing one wayinvocation on theserver

Indicates normaladapter operation. Noaction necessary.

AER3-000114 R3-CORE-LIB-6082

INFO AD Receivedinvocation requestfor %1 from SAPSystem

Indicates normaladapter operation. Noaction necessary.

AER3-000115 R3-CORE-LIB-6083

INFO AD Performinginvocation on theserver

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 367: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 345

AER3-000116 R3-CORE-LIB-6084

INFO AD Function call istransactional, :%1

Indicates normaladapter operation. Noaction necessary.

AER3-000117 R3-CORE-LIB-6085

INFO AD Receivedinvocation requestfor %1

Indicates normaladapter operation. Noaction necessary.

AER3-000118 R3-CORE-LIB-6086

INFO AD Invoking RFCfunction %1 in SAPSystem

Indicates normaladapter operation. Noaction necessary.

AER3-000119 R3-CORE-LIB-6087

INFO AD Received one wayinvocation requestfor %1

Indicates normaladapter operation. Noaction necessary.

AER3-000120 R3-CORE-LIB-6088

INFO AD Invokingtransactional RFCfunction %1 in SAPSystem

Indicates normaladapter operation. Noaction necessary.

AER3-000121 R3-CORE-LIB-6089

INFO C Cannot get classdescriptions forcontrol record ofIDoc class %1

Indicates normaladapter operation. Noaction necessary.

AER3-000122 R3-CORE-LIB-6090

Error AP The IDoc %1 doesnot contain acontrol record

Make sure that theIDoc contains a controlrecord.

AER3-000123 R3-CORE-LIB-6091

Error C Cannot get classdescriptions fordata record ofIDoc class %1

During configurationensure that you aredownloading the classdescriptions.

AER3-000124 R3-CORE-LIB-6092

Error AD The received IDoctree in explodedform is null

Make sure that theTree (MTree in SDK) iscreated correctly andcorresponds to anIDoc.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 368: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

346 | Trace Messages

AER3-000125 R3-CORE-LIB-6093

Error C Class descriptionscannot be obtainedfor received IDoctree

During configurationensure that you aredownloading the classdescriptions.

AER3-000126 R3-CORE-LIB-6094

Error C %1 is not of asequence type

The named sequencedoes not have a validdefinition. Check theconfiguration.

AER3-000127 R3-CORE-LIB-6095

Error C Sequence %1 doesnot have acontained classdescription

A sequence is asequence of objects oftype T. The adaptercould not determine T,probably because thedefinitions don’t existin the configuration.

AER3-000128 R3-CORE-LIB-6096

Error C Sequence %1 forthe segment holdercould not beobtained

Check configurationand make sure that avalid definition existsfor the namedsequence.

AER3-000129 R3-CORE-LIB-6097

Error C Segment %1 doesnot haveattribute: %2

The data mentionedcontains the namedattribute, but the classdefinition does not.Check theconfiguration and howthe IDoc is beingcreated.

AER3-000130 R3-CORE-LIB-6098

Error C Cannot obtainfield classdescription forIDoc Segment

Check configuration.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 369: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 347

AER3-000131 R3-CORE-LIB-6099

Error AD Cannot get EDIDDheader attributefrom the fieldsfor segment %1

Check the data. It mustinclude the EDIDDheader.

AER3-000132 R3-CORE-LIB-6100

Error C Cannot obtainclass descriptionfor segment %1attribute %2

Check the segmentname as well as theattribute and makesure that a definitionexists in theconfiguration.

AER3-000133 R3-CORE-LIB-6101

INFO AD The segmentinstance %1 doesnot containattribute %2

Indicates normaladapter operation. Noaction necessary.

AER3-000134 R3-CORE-LIB-6102

INFO AD The default valueswill be used

Indicates normaladapter operation. Noaction necessary.

AER3-000135 R3-CORE-LIB-6103

INFO AD Segment name: %1added

Indicates normaladapter operation. Noaction necessary.

AER3-000136 R3-CORE-LIB-6104

Error AD The %1 recordsequence does notcontain a validcontrol record

Check the data first.Make any changes.Check theconfiguration for anappropriate definition.

AER3-000137 R3-CORE-LIB-6105

Error C The %1 record ofthe IDoc does nothave a valid classdescription

Check the data first.Make any changes.Check theconfiguration for anappropriate definition.

AER3-000138 R3-CORE-LIB-6106

INFO AD The %1 record doesnot containattribute %2

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 370: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

348 | Trace Messages

AER3-000139 R3-CORE-LIB-6107

INFO AD trying to recoverthe receivedmessage ...

Indicates normaladapter operation. Noaction necessary.

AER3-000140 R3-CORE-LIB-6108

INFO AD Subscriber: %1,Exception occurredon receiving themessage

Indicates normaladapter operation. Noaction necessary.

AER3-000141 R3-CORE-LIB-6109

Error AD Subscriber: %1,the message couldnot be recovered

Indicates normaladapter operation. Noaction necessary.

AER3-000142 R3-CORE-LIB-6110

INFO AD Subscriber: %1,The 10X Opaquemessage type isnot supported

Indicates normaladapter operation. Noaction necessary.

AER3-000143 R3-CORE-LIB-6111

INFO AD the receivedmessage wasrecovered

Indicates normaladapter operation. Noaction necessary.

AER3-000144 R3-CORE-LIB-6112

INFO AD The IDoc messagereceived in 10Xformat does notcontain %1field

Indicates normaladapter operation. Noaction necessary.

AER3-000145 R3-CORE-LIB-6113

Error C The classdescriptions forIDoc base classescannot be obtainedfrom the registry

During configurationensure that you’vedownloaded the classdefinition.

AER3-000146 R3-CORE-LIB-6114

INFO AD Function calledtransactionallybut TransactionIdentifier () notsupplied

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 371: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 349

AER3-000147 R3-CORE-LIB-6115

Error S Could not openfile %1 forwriting

File could not beopened. Checkpermissions andwhether you’veadequate space onyour disk.

AER3-000148 R3-CORE-LIB-6116

Error AD CIDocIterator: TheIDoc containerdoes not containany IDocs

Check the log file forany previous errorsthat may have led tothis situation.

AER3-000149 R3-CORE-LIB-6117

Error AD The IDoc %1 doesnot contain %2

The IDoc does notcontain a data recordsection. Check theIDoc data.

AER3-000150 R3-CORE-LIB-6118

Error AD No control recordinstance for the%1 IDoc in thepacket

The named IDoc doesnot have a controlrecord. Check the data.

AER3-000151 R3-CORE-LIB-6119

Error AD No data recordinstance for the%1 IDoc in thepacket

The IDoc does notcontain a data recordsection. Check thedata.

AER3-000152 R3-CORE-LIB-6120

Error AD %1 record of thedata recordinstance does notcontain mandatoryattribute DOCNUM

DOCNUM is amandatory attributefor data record. Checkthe data and modify itto include DOCNUM.

AER3-000153 R3-CORE-LIB-6121

INFO AD %1 row of the datarecord instance ofthe %2 IDocinstance of type%3 could not beobtained

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 372: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

350 | Trace Messages

AER3-000154 R3-CORE-LIB-6122

Error S The IDoc instancecould not bewritten to file,the instance isinvalid

The Instance could notbe written because itwas empty. Check theIDoc data.

AER3-000155 R3-CORE-LIB-6123

Error AD The IDoc does notcontain a datarecord

The IDoc does notcontain a data recordsection. Check theIDoc data.

AER3-000156 R3-CORE-LIB-6124

INFO AD Writing IDoc %1,Number %2 to file:%3, ServiceName %4SubjectName %5

Indicates normaladapter operation. Noaction necessary.

AER3-000157 R3-CORE-LIB-6125

INFO AD Invocation for RFCfunction %1 stillpending

Indicates normaladapter operation. Noaction necessary.

AER3-000158 R3-CORE-LIB-6126

INFO AD Adaptersinitializationmode:%1

Indicates normaladapter operation. Noaction necessary.

AER3-000159 R3-CORE-LIB-6127

WARN AD Cannot findcommunicationclient forManager,Management will belocal

The configurationdoes not specify therpcClient for Manager,hence themanagement will belocal.

AER3-000160 R3-CORE-LIB-6128

INFO AD Connection:waiting for replyfrom server ...

Indicates normaladapter operation. Noaction necessary.

AER3-000161 R3-CORE-LIB-6129

INFO AD No component forthe RFC call;Exception=%1

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 373: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 351

AER3-000162 R3-CORE-LIB-6130

INFO AD Active connectionis null

Indicates normaladapter operation. Noaction necessary.

AER3-000163 R3-CORE-LIB-6131

INFO AD Checking forconnections

Indicates normaladapter operation. Noaction necessary.

AER3-000164 R3-CORE-LIB-6132

INFO AD Connectiondisconnected

Indicates normaladapter operation. Noaction necessary.

AER3-000165 R3-CORE-LIB-6133

INFO AD Connectionre-established

Indicates normaladapter operation. Noaction necessary.

AER3-000166 R3-CORE-LIB-6134

INFO AD Connection State:Available

Indicates normaladapter operation. Noaction necessary.

AER3-000167 R3-CORE-LIB-6135

INFO AD Connection State:Pending invocation

Indicates normaladapter operation. Noaction necessary.

AER3-000168 --NEW-- INFO AD %1 connectioncould not beremoved

Indicates normaladapter operation. Noaction necessary.

AER3-000169 R3-CORE-LIB-6136

WARN AD Subscriber %1could not besuspended

The named subscribercould not besuspended. No actionnecessary.

AER3-000170 R3-CORE-LIB-6137

WARN AD Stop Adapter:Correct consumerreference couldnot be obtainedfrom deploymentdescription %1,skipping...

The configuration didnot specifyconsumerRef. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 374: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

352 | Trace Messages

AER3-000171 R3-CORE-LIB-6138

INFO AD Adapter is waitingfor invocationresponse beforeshutdown canproceed...

Indicates normaladapter operation. Noaction necessary.

AER3-000172 R3-CORE-LIB-6139

INFO AD Adapter stopmethod called

Indicates normaladapter operation. Noaction necessary.

AER3-000173 R3-CORE-LIB-6141

INFO AD Subscriber %1suspended

Indicates normaladapter operation. Noaction necessary.

AER3-000174 R3-CORE-LIB-6142

INFO AD Connection Manager%1 stopped

Indicates normaladapter operation. Noaction necessary.

AER3-000175 R3-CORE-LIB-6143

INFO AD Component %1stopped

Indicates normaladapter operation. Noaction necessary.

AER3-000176 R3-CORE-LIB-6144

INFO AD Deactivating stopscheduler

Indicates normaladapter operation. Noaction necessary.

AER3-000177 R3-CORE-LIB-6145

INFO AD Stopping Adapter%1 instance onhost %2

Indicates normaladapter operation. Noaction necessary.

AER3-000178 R3-CORE-LIB-6146

INFO AD Stop notificationreceived via TIBCORV

Indicates normaladapter operation. Noaction necessary.

AER3-000179 R3-CORE-LIB-6147

Error AD Remote Exception:Exception Name:%1, ExceptionData: %2

See the errordescription for details.

AER3-000180 R3-CORE-RVD-9000

WARN AD ADV_CLASS/ADV_SOURCE/ADV_NAME: %1,ADV_DESC : %2 %3

See the errordescription for moredetails.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 375: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 353

AER3-000181 R3-CORE-RVD-9001

Error AD ADV_CLASS/ADV_SOURCE/ADV_NAME: %1,ADV_DESC : %2 %3

The adapter responds'license expiry'warning from thedaemon with thismessage.

AER3-000182 R3-CORE-RVD-9002

Error AD ADV_CLASS : %1,ADV_SOURCE : %2,ADV_NAME : %3

The adapter responds'registration collision'error from the daemonwith this message.

AER3-000183 R3-CORE-SAP-4000

Error AP RFC error; Group :%1, Key : %2,Message : %3

Look at the errordescription for detailsabout the SAPException. Also checkyour connectionparameters.

AER3-000184 R3-CORE-SAP-4001

Error AP RFC connectioninvalid for %1

The adapter could notget a valid connectionto the SAP system.Check your loginparameters. Also makesure that the adaptercan reach the SAPsystem.

AER3-000185 R3-CORE-SAP-4002

Error AP CallReceive failedfor operation %1;exception : %2,RFC error;Group/Key/Message:%3

Look at the errordescription for detailsabout the SAPException.

AER3-000186 R3-CORE-SAP-4003

INFO AP Transaction %1skipped

The Adapter did notexecute thistransaction because itwas already executed.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 376: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

354 | Trace Messages

AER3-000187 R3-CORE-SAP-4004

WARN AP Invalidtransaction statereceived fromManager fortransaction %1

The Adapter receivedan invalid stated fromManager. Check thetidmanager display forpossible causes.

AER3-000188 R3-CORE-SAP-4005

WARN AD Failed to %1 Tid The Adapter could notperform the named/Manager function.Check the /Managerdisplay for possiblecauses.

AER3-000189 R3-CORE-SAP-4007

Error AP RFC functioninitializationerror for function%1; RFC Error;Group/Key/Message: %2

Look at the errordescription for detailsabout the SAPException.

AER3-000190 R3-CORE-SAP-4008

WARN AD RFC remotefunction %1implementationexception %2

Look at the errordescription for detailsabout the SAPException.

AER3-000191 R3-CORE-SAP-4009

Error AP Indirect callerror whilesending IDoc; RFCError; Group : %1,Key : %2, Message: %3

Look at the errordescription for detailsabout the SAPException.

AER3-000192 R3-CORE-SAP-4010

Error AP RFC error; Group :%1, Key : %2,Message : %3,Attempt to connecttimed out

See the errordescription for details.

AER3-000193 R3-CORE-SAP-4011

Error AD Connection notavailable forclient %1,retrying ...

See the errordescription for details.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 377: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 355

AER3-000194 R3-CORE-SAP-4012

INFO AD Invalid RFC clientconnection objectfor client %1

Indicates normaladapter operation. Noaction necessary.

AER3-000195 R3-CORE-SAP-4013

INFO AD Transactioncreated %1

Indicates normaladapter operation. Noaction necessary.

AER3-000196 R3-CORE-SAP-4014

INFO AD Transactionskipped %1

Indicates normaladapter operation. Noaction necessary.

AER3-000197 R3-CORE-SAP-4015

INFO AD Transactioncommitted %1

Indicates normaladapter operation. Noaction necessary.

AER3-000198 R3-CORE-SAP-4016

INFO AD Transactionconfirmed %1

Indicates normaladapter operation. Noaction necessary.

AER3-000199 R3-CORE-SAP-4017

INFO AD Transaction rolledback %1

Indicates normaladapter operation. Noaction necessary.

AER3-000200 R3-CORE-SAP-4018

Error AD Failed to updatestate fortransaction %1.Ensure that theuser has writepermissions fortidFile.tid

Look at the earliererror messages in thelog-file(s) for possiblecauses. One of thereasons for this errorcould be that, you donot have writepermissions for thetidFile.tid.

AER3-000201 R3-CORE-SAP-4019

INFO AD Starting Inboundtransaction %1

Indicates normaladapter operation. Noaction necessary.

AER3-000202 R3-CORE-SAP-4020

INFO AD Inboundtransaction %1completed

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 378: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

356 | Trace Messages

AER3-000203 R3-CORE-SCH-5000

Error C No classdefinition existsfor %1

The named class isinvalid or does notexist. Check therepository to makesure that a valid classexists with that name.

AER3-000204 R3-CORE-SCH-5001

Error C %1 is not amodeled class

The named class isinvalid, non-existent,or does not represent amodeled class. Checkthe repository to makesure that a valid classexists with that name.

AER3-000205 R3-CORE-SCH-5002

Error C No operationsdefined in class%1

Modify the classdefinition to includeoperations.

AER3-000206 R3-CORE-SCH-5003

Error C The operation %1does not have anyparameters

Modify the classdefinition to includeparameters.

AER3-000207 R3-CORE-SCH-5004

Error C The class %1 doesnot specifyattribute %2

The attribute is invalidfor the named class.Check the repository.Re-create the classdefinition (if yoususpect it has beenincorrectly created) ormodify the classdefinition to includethe named attribute.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 379: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 357

AER3-000208 R3-CORE-SCH-5005

Error C Operationdescription notavailable for %1

The named operationis invalid ornon-existent. Checkthe repository to makesure that an operationexists with thespecified name.

AER3-000209 R3-CORE-SCH-5006

Error C No IDoc operationsdefined in class%1

The named class doesnot have IDocoperations defined.Check the repositoryto make sure that theclass definition iscorrect.

AER3-000210 R3-CORE-SCH-5008

Error C Attribute %1 inclass %2 isinvalid

Check theconfiguration.

AER3-000211 R3-CORE-SCH-5009

Error AD Unsupported type%1 for attribute%2 in class %3

The named type isunsupported by SDKor SAP or both.

AER3-000212 R3-CORE-SCH-5010

Error AD Unexpected %1 :%2; informtechnical support

Unexpected error. Youcannot determine thecause from thedescription. Contacttechnical support:[email protected].

AER3-000213 R3-CORE-SCH-5011

WARN C Control fieldreplacementsspecify anattribute %1 whichdoes not exist inthe control record

Control fieldreplacements inclassInstances specifyan attribute that doesnot exist in controlrecord. Check spelling.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 380: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

358 | Trace Messages

AER3-000214 R3-CORE-SDK-2000

Error AD Cannot accessclass registry

You specified anattribute that does notexist in the controlrecord. Either omitthat attribute orreplace it with anattribute that exists.

AER3-000215 R3-CORE-SDK-2001

Error AD Subscriber %1received a messagethat has invalidwire format

There was anexception in theAdapter upon receiveof this message. Whenyou are using 10xstyle, follow theconfigurationrequirements given inChapter 3, AdapterInstance Options, onpage 37.

AER3-000261 --NEW-- INFO AD Using ini file %1 Indicates normaladapter operation. Noaction necessary.

AER3-000262 --NEW-- INFO AD No program IDdefined in the inifile, usingdestination %1 asprogram ID

Indicates normaladapter operation. Noaction necessary.

AER3-000263 --NEW-- INFO AD Using Logon Groups Indicates normaladapter operation. Noaction necessary.

AER3-000264 --NEW-- INFO AD Using a dedicatedconnection

Indicates normaladapter operation. Noaction necessary.

AER3-000265 --NEW-- INFO AD Creating a Serverconnection

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 381: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 359

AER3-000266 --NEW-- INFO AD Initializedsuccessfully

Indicates normaladapter operation. Noaction necessary.

AER3-000267 --NEW-- INFO AD CREATED %1 Indicates normaladapter operation. Noaction necessary.

AER3-000268 --NEW-- INFO AD EXECUTED %1 Indicates normaladapter operation. Noaction necessary.

AER3-000269 --NEW-- INFO AD CONFIRMED %1 Indicates normaladapter operation. Noaction necessary.

AER3-000270 --NEW-- Error AD Invalid clientfunction specifiedin removeClientcall

Because this messageappears duringshutdown, no action isnecessary.

AER3-000271 --NEW-- Error C Invalid poolRefname %1

poolRef must point toa valid pool definition.

AER3-000272 --NEW-- Error C Pool reference notprovided in ServerComponent

Provide a value thatcorresponds to a validdefinition.

AER3-000273 --NEW-- Error AD Invalid Connectionfor pool %1

Check the pooldefinitions to ensurethat they are valid.

AER3-000274 --NEW-- Error AD Invalid defaultConnection forpool %1

Check the pooldefinitions to ensurethat they are valid.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 382: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

360 | Trace Messages

AER3-000275 --NEW-- Error C No default sessiondefined

The configurationmust either specify avalid value for startup/default session ordefine at least onervSession/rvCmSession.

AER3-000276 --NEW-- Error AD Duplicate DESTparameter definedin %1 : %2

Remove duplicatedefinition.

AER3-000277 --NEW-- Error AD Destination %1 notdefined in %2

Define destinationgiven in message.

AER3-000278 --NEW-- INFO AD Received messageis written to file%1

Indicates normaladapter operation. Noaction necessary.

AER3-000279 --NEW-- Error AD Exception whileinitializingadapter; exceptiontype : %1,description : %2

Refer to thedescription and takethe required action.

AER3-000280 --NEW-- Error AD Error: Could notsend reply forfunction: %1

Refer to theaccompanying errormessages foradditional details.

AER3-000281 --NEW-- Error AD Error whileinvokingUser-definedoperation: %1

Refer to theaccompanying errormessages foradditional details.

AER3-000282 --NEW-- Error AD Receive replyfailed for: %1

Refer to theaccompanying errormessages foradditional details.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 383: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 361

AER3-000283 --NEW-- Error AD Exception duringone way invocationof function: %1,Type: %2,Description: %3

Refer to theaccompanying errormessages foradditional details.

AER3-000284 --NEW-- INFO AD Request written tofile: %1 foroperation: %2

Indicates normaladapter operation. Noaction necessary.

AER3-000285 --NEW-- Error AD Error code: %1,Message: %2

Refer to thedescription and takethe required action.

AER3-000286 --NEW-- INFO C 'userExit' classdoes not exist orit does notcontain operation%1, operation willnot be invoked

Indicates normaladapter operation. Noaction necessary.

AER3-000287 --NEW-- INFO C There is noRpcClient named:%1, operation willnot be invoked

Indicates normaladapter operation. Noaction necessary.

AER3-000288 --NEW-- INFO AD Untransformed IDocdata sent

Indicates normaladapter operation. Noaction necessary.

AER3-000289 --NEW-- INFO AD Performingasynchronousinvocation forUser-definedfunction: %1

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 384: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

362 | Trace Messages

AER3-000290 --NEW-- WARN C No R/3 clientconfigured for %1,usingdefault-client %2

There is nodeployment-description configured for theRFC. If not intentional,ensure that the client isspecified in thedeployment-descriptions for the RFC.

AER3-000291 --NEW-- INFO AD Received requestfor logon to SAPR/3 System

Indicates normaladapter operation. Noaction necessary.

AER3-000292 --NEW-- INFO AD Successfullylogged-on to SAPR/3 System

Indicates normaladapter operation. Noaction necessary.

AER3-000293 --NEW-- INFO AD Received requestfor logoff fromSAP R/3 System

Indicates normaladapter operation. Noaction necessary.

AER3-000294 --NEW-- INFO AD Successfullylogged-off fromSAP R/3 System

Indicates normaladapter operation. Noaction necessary.

AER3-000295 --NEW-- Error AD No session idexists in thelogoff request

The sessionIDobtained onlogging-on to SAPsystem throughdesign-time-adaptershould be passed inthe RFCCLOSUREalong with the logoffrequest to successfullylogoff from SAPsystem

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 385: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 363

AER3-000296 --NEW-- Error AD No logon sessionexists for thesession ID

The sessionIDobtained onlogging-on to SAPsystem throughdesign-time-adaptershould be passed inthe RFCCLOSUREalong with the logoffrequest to successfullylogoff from SAPsystem.

AER3-000300 --NEW-- INFO M Created discoverysubscribersuccessfully usingsubject %1

Indicates normaladapter operation. Noaction necessary.

AER3-000301 --NEW-- INFO M Attempting tocreate dynamicconnection to SAPR/3 system

Indicates normaladapter operation. Noaction necessary.

AER3-000302 --NEW-- INFO M Attempting toclose dynamicconnection fromSAP R/3 system

Indicates normaladapter operation. Noaction necessary.

AER3-000303 --NEW-- INFO M Retrieving list offunction modulesfrom SAP R/3system

Indicates normaladapter operation. Noaction necessary.

AER3-000304 --NEW-- INFO M Retrieving schemafor IDoc %1 FROMSAP R/3 system

Indicates normaladapter operation. Noaction necessary.

AER3-000305 --NEW-- INFO M Retrieving entriesfor table %1 FROMSAP R/3 system

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 386: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

364 | Trace Messages

AER3-000306 --NEW-- INFO M Retrieving schemaforstructure/table %1FROM SAP R/3system

Indicates normaladapter operation. Noaction necessary.

AER3-000307 -NEW-- INFO M Received unknownoperation %1

TIBCO Designer sentan invalid request tothe design-timeadapter. If problempersists contacttechnical support:[email protected]

AER3-000308 -NEW-- INFO M Metadata adapteroperationfailure:%1;operation name :%2

Refer to thesurrounding errormessages foradditional details.

AER3-000309 -NEW-- INFO M Retrieving schemafor RFC/BAPI %1from SAP R/3system

Indicates normaladapter operation. Noaction necessary.

AER3-000310 -NEW-- ERROR AD Received ErrorAdvisory Message:%1, Subject: %2

This is an erroradvisory thrown by aTIBCO Infrastructurecomponent. Themessage %1 iscontext-sensitive.Report the error toTIBCO Support.

AER3-000400 --NEW-- INFO AD Invalid connectiondetected. Message: %

Indicates normaladapter operation. Noaction necessary.

AER3-000401 --NEW-- INFO AD %1 RFCServersregistered withSAP R/3 systemwith program-id %2on GatewayHost %3

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 387: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 365

AER3-000402 --NEW-- Error AD No session id inrequest foroperation %1

If the request is for anRFC that requires anexplicit logon to SAPsystem, then thesessionID obtained onlogging-on to SAP /3system has to bepassed in theRFCCLOSURE alongwith the RFC request.

AER3-000403 --NEW-- Error AD Unable to obtaincontext forimplementation ofoperation %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000405 --NEW-- Error AD Invalid session idpassed in requestfor operation %1

The sessionID shouldbe a valid string.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 388: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

366 | Trace Messages

AER3-000406 --NEW-- Error AD Invalid session idpassed foroperation %1

If the sessionID wasobtained afterlogging-on to the SAPsystem, ensure that thesessionID passed inthe RFCCLOSUREwhile invoking arequest on theInboundRFC instanceis the same as the oneobtained. Instead, ifthe sessionID wasobtained for asubsequentBAPI_TRANSACTION_COMMIT call,ensure that the samesessionID was passedwithBAPI_TRANSACTION_COMMITinvocation. Also checkif the session createdfor commit/rollbackhas already timed-outas specified by the'commitExpiry'parameter.

AER3-000407 --NEW-- Error AD Invalid callreceived,connection closedfor thread

The adapter receivedan invalid call fromthe SAP system thatcaused a connection tobe closed. Ensure thatthe adapterconnections to SAPsystem are alive.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 389: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 367

AER3-000408 --NEW-- Error AD Server threadunable to dispatchcall, callskipped. message :%1

The adapter enteredan invalid statebecause of an invalidcall from the SAPsystem. See messagedescription for moredetails. Ensure that theadapter connections toSAP system are alive.

AER3-000409 --NEW-- Error AD Server threadunable to dispatchcall, connectioninvalidated

The adapter enteredan invalid statebecause of an invalidcall from the SAPsystem. See messagedescription for moredetails. Ensure that theadapter connectionswith SAP system arealive.

AER3-000410 --NEW-- WARN AD Server threadexited, message :%1

The adapterencountered anexception conditionthat caused the serverthread to exit. Look atearlier messages in thelog-file(s) for possiblecauses. No resolutionnecessary.

AER3-000411 --NEW-- Error C No poolRefspecified foroperation %1

The RFC does not havea 'poolRef' attribute inits deploymentdescription. Ensurethat a valid 'poolRef' isspecified for the RFC.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 390: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

368 | Trace Messages

AER3-000412 --NEW-- INFO AD Obtainingconnection for R/3client %1 for %2

Indicates normaladapter operation. Noaction necessary.

AER3-000413 --NEW-- Error AD The session forcommit/rollbacktimed out foroperation %1

Ensure that theBAPI_TRANSACTION_COMMIT call istriggered in the SAPsystem before thesession forcommit/rollbacktimes out as specifiedby the 'commitExpiry'parameter.

AER3-000414 --NEW-- INFO C No session timeoutspecified forcommit/rollbackfor operation %1,defaulting to %2seconds...

The 'commitExpiry'parameter defaults to60 seconds if it is notspecified. If this valueis insufficient, ensurethat a higher value isspecified for theparameter.

AER3-000415 --NEW-- INFO AD Session timeoutforcommit/rollbackfor operation %1set to %2 seconds

Indicates normaladapter operation. Noaction necessary.

AER3-000417 --NEW-- INFO AD Connection pendingcommit foroperation %1

Indicates normaladapter operation. Noaction necessary.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 391: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 369

AER3-000418 --NEW-- Error AD Invalid clientspecified : %1

Ensure that a validclient is specified forthe RFC/IDoc in theirrespective deploymentdescriptions, if any.Else ensure that the'defaultClient'attribute specified inclient connectionpoolis a valid client.

AER3-000419 --NEW-- INFO AD Created new threadfor RFCServer

Indicates normaladapter operation. Noaction necessary.

AER3-000420 --NEW-- INFO AD Server thread(s)stopped forComponent %1

Indicates normaladapter operation. Noaction necessary.

AER3-000421 --NEW-- Error AD No validconnection handleavailable forserver foroperation %1

The outbound adaptercould not get a validconnection handle tothe SAP system. Lookat earlier messages inthe log-file(s) forpossible causes

AER3-000422 --NEW-- Error C No clientspecified indeploymentdescription foroperation %1

Ensure that a client isconfigured for theoperation

AER3-000423 --NEW-- Error C No poolRefspecified foroperation %1

Ensure that a poolRefis specified for theoperation

AER3-000424 --NEW-- Error C No default clientspecified foroperation %1

Ensure that adefaultClient isspecified for theoperation

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 392: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

370 | Trace Messages

AER3-000425 --NEW-- Error C Invalid poolRefspecified indeployment : %1

Ensure that a validpoolRef is specified inthe deploymentdescription for theRFC/IDoc

AER3-000426 --NEW-- INFO AD Thread monitorstarted for %1server thread(s)

Indicates normaladapter operation. Noaction necessary.

AER3-000427 --NEW-- Error AD No activeconnectionsavailable inconfiguration,exiting...

This indicates that allthe SAP systems theadapter is connectedto, are down and noneof the connectionsestablished by theadapter with the SAPsystem are active.Ensure that the SAPsystems are up andrunning.

AER3-000428 --NEW-- WARN C Interface %1 doesnot containdeploymentdescription forRFCs...continuing...

The adapter could notfind deploymentdescriptions for anyRFC. If it is notintentional, ensurethat the RFCconfiguration iscorrect.

AER3-000429 --NEW-- WARN C No deploymentdescriptionavailable for idoc%1...usingdefault…

The adapter could notfind deploymentdescriptions for thespecified IDoc. If it isnot intentional, ensurethat the IDocconfiguration iscorrect.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 393: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 371

AER3-000430 --NEW-- INFO AD Total requestsprocessed : %1

Indicates normaladapter operation. Noaction necessary.

AER3-000431 --NEW-- Error AD Unable to createmarshaller foroperation %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000432 --NEW-- Error AD Unable to cloneproxy foroperation %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000433 --NEW-- Error AD Unable to cloneRFC client for %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000434 --NEW-- Error AD Unable to clonefunctionimplementation foroperation %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000435 --NEW-- Error AD Unable to createlistener forcall-operation

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000436 --NEW-- Error AD Unable to createreply listener foroperation %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000437 --NEW-- Error AD Unable to clonesubscriberimplementation

Look at earlier errormessages in thelog-file(s) for possiblecauses.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 394: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

372 | Trace Messages

AER3-000438 --NEW-- Error AD Unable to generatetransaction-id.message : %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000439 --NEW-- Error AD Unable to createimplementation forthread

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000440 --NEW-- Error AD Unable to createserver thread

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000441 --NEW-- INFO C management isremote

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000442 --NEW-- Error AD Connection contextlost. Operation %1failed

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000443 --NEW-- Error AD Logon to SAP R/3system failed.message : %1

Look at earlier errormessages in thelog-file(s) for possiblecauses.

AER3-000444 --NEW-- Error AD Error writing tofile fortransaction %1

Ensure that the filehas write permissions.

AER3-000446 --NEW-- Error AD No activeconnections inconnection-pool%1. All retryattemptsexhausted.Connections forthis pooldeactivated.

Ensure that the SAPsystem pointed to bythe connection-pool%1 is up and running.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 395: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 373

AER3-000447 --NEW-- Error AD No activeconnections inconnection-pool%1. All retryattemptsexhausted.Exiting...

This indicates that allthe SAP systems theadapter is connectedto, are down and noneof the connectionsestablished by theadapter with the SAPsystem are active.Ensure that the SAPsystems are up andrunning.

AER3-000448 --NEW-- INFO AD Suspended endpointcomponent %1

None.

AER3-000449 --NEW-- INFO AD The ApplicationManager has beenflagged to restarton re-establishingconnection to R/3.

None.

AER3-000450 --NEW-- INFO AD Created timer tocheck connectivityto R/3.

None.

AER3-000451 --NEW-- WARN AD Adapterapplication willrestart now

The adapter isrecovering missedmessages byperforming aninternal-restart.Ensure that theadapter has performeda restartedsuccessfully bychecking the adapterlog files.

AER3-000452 --NEW-- INFO AD Adapterapplication %1 isrestarting on host%2.

None.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 396: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

374 | Trace Messages

AER3-000453 --NEW-- WARN C Invalidcontrol-fieldreplacementattribute %1skipped.

A control-field name%1 not present in theIDoc's control recordwas specified forreplacement. Ensurethat the field name isone of those definedfor the IDoc's controlrecord.

AER3-000454 --NEW-- INFO AD Performing onewayinvocation forUser-definedfunction: %1

None.

AER3-000455 --NEW-- Error C No classdescriptionavailable forexplode sequence%1

Check the repositoryunder/tibco/public/adap

ter/SAPAdapter40/<

sap

version>/IDOCS/ forthe class descriptionfor class %1.

AER3-000456 --NEW-- Error C No attributedescription forexplode sequence%1

Check the repositoryfor attributedescription forexplode sequence %1.

AER3-000457 --NEW-- Error AD Operation %1requires externallogon. The requestdoes not containsessionID in theclosure data.

Supply the session-idparameter in theRFCCLOSURE data ofthe incoming request.

AER3-000500 --NEW-- WARN AD Unsupporteddatatype: class%1. Parameter: %2

This datatype is notsupported.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 397: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Status Messages | 375

AER3-000461 --NEW-- Error AD Connection Error.Unable to create aconnection with thetarget application %1using connectionparameters %2 andthe target applicationerror is %3

Ensure that validconnection parametershave been specifiedand that the SAPserver is not down.

Table 15 Error Messages with Changed Codes

NewMessageCode

OldMessageCode

Severity Cat. Description Resolution

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 398: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

376 | Trace Messages

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 399: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 377

Appendix B SAP Overview

This appendix gives an overview of the SAP system and a description of theinterfaces exposed by system.

Topics

• The SAP Business Application System

• Exchanging Business Information

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 400: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

378 | SAP Overview

The SAP Business Application System

SAP is a general purpose, transaction-based business application system. Eachtransaction represents an individual business process — usually seen as a series ofscreens. Flexibility is achieved using modular business components, which can inturn be combined to develop new modules and transactions. SAP has athree-layer, client-server-based architecture, as shown in the figure. These layersare explained in sections that follow.

SAP GUI Presentation Server

The top layer is the graphic user interface (GUI). This layer consists of a hierarchyof query-response screens that allow company staff to access, review, andcompare day-to-day and longer-term business information, and to control thebusiness through applications that process business data. The SAP GUIgraphically presents formatted business data retrieved from the application

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 401: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

The SAP Business Application System | 379

server, handles the user dialog, and communicates user entries to the ApplicationServer. Categories of business information include office administration, logistics,accounting, and others, as shown in one of the top-level SAP GUI screens, in thenext figure:

The SAP GUI program accesses the business database server by means of theApplication Server layer. Information on many business transactions can bedisplayed in a report such as the following:

The GUI also provides the interface to control communication of businessinformation between two SAP systems, and between an SAP system and anexternal application, such as the TIBCO ActiveMatrix Adapter for SAP.

Application Server

The Application Server layer processes the business logic (ABAP/4 programs)relying on data stored in the database and on user input. The programsthemselves are also stored in the database. The processes that make up anApplication Server run on dedicated, powerful, servers.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 402: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

380 | SAP Overview

The Application Server provides many services to support the user interfacelayer. In this layer, programs are available to create, capture, configure, andprocess business data and to present it in a logical and easily assimilated display.Custom business applications written for the specific business entity augmentstandard SAP programs.

Database Server

The Database Server holds the relational database and maintains:

• application data, for example SAP records

• customization data, for example ALE customizing

• ABAP/4 business program logic

Each SAP system has one database and one Database Server. Any of the mostwidely-used SQL database management applications can be used, includingOracle and Informix.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 403: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Exchanging Business Information | 381

Exchanging Business Information

SAP provides many interfaces to extract and import data to facilitateenterprise-wide integration. The following interfaces are the standard means forexchanging business information between SAP and other business applicationsystems.

Summary of SAP Interfaces

• ALE: Application Link Enabling.

This is SAP's middleware to integrate different SAP systems together toachieve cross-business functionality. ALE facilitates the event driven,asynchronous exchange of information directly out of business transactions oradministrative transactions. It provides tools to customize a distributionmodel and monitoring and management tools.

• BAPI: The Business Objects Repository (BOR) Application ProgrammingInterface.

This API of the SAP Business Framework offers business objects forobject-oriented manipulation of business data. The business objects in BORdescribe complete business processes. Each BOR object has one or moremethods, and not all of its methods are exposed. The collection of all exposedmethods of all BOR objects is called the Business API or BAPI.

• RFC: Remote Function Call.

This is the most popular SAP access technology. This provides the basis toaccess ALE/IDocs, BAPIs and BOR information. This interface allows non-SAPand SAP applications to execute SAP Advanced Business ApplicationProgramming (ABAP) functions that have been RFC-enabled. Non-SAPapplications that use this interface behave as RFC client/server programs toSAP .

• EDI: Electronic Data Interchange of Intermediate Documents (EDI/IDoc).

This is the means for communicating business data to and from externalpartners. It is similar to ALE. EDI provides more customization capabilities, sothat data can be communicated to and from specific business partners in aspecific manner.

• IDocs: Intermediate Documents.

These are used to transfer data in a business transaction. IDocs encapsulateapplication data in segment hierarchies. They are used as data containers forboth ALE and EDI. They are called intermediate documents because theywere originally used with EDI, as SAP's common intermediate structure to

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 404: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

382 | SAP Overview

bridge over multiple EDI standards. SAP IDoc data was then mapped tospecific EDI standards later in the process. Communication IDocs are createdfrom master IDocs for point-to-point distribution to individual recipients asper an ALE partner profile within ALE customization. There are severalhundred IDoc types for application data. Both ALE and EDI have onecommon feature, once the specific processing is done, the data isautomatically sent out of the corresponding operational or administrativetransactions (exceptions exist for master data).

The adapter discussed in this document uses ALE/IDoc, RFC, and BAPIinterfacing technology to achieve data interchange. Figure 17 shows how ALEserves as the IDoc interface between SAP systems and non-SAP systems.

Figure 17 SAP Adapter ALE/IDoc interface

SAP Application

TIBCO ActiveMatrixAdapter for SAP

Outbound from SAP

TIBCO Active Matrix Adapter for SAP

_________ __________________Comm. IDoc

Inbound to SAP

SAP Database

_________ __________________Comm. IDoc

ALE Outbound Process

_______ _______ _______Master IDoc

ALE Inbound Process

_______ _______ _______Master IDoc

Non-SAP SystemsTIBCO Environment

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 405: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Exchanging Business Information | 383

IDoc Structure

The IDoc internal structure serves as a general-purpose communication vehicle tomove different kinds of business data. The figure below shows the generalstructure of an IDoc consisting of a control record, one or more data records, and astatus record.

An example of an IDoc type is “ORDER01.” It is used to communicate datadescribing a purchase order, including purchase order number, buyer, paymentterms, amount, etc. There are hundreds of types of predefined IDoc types and at agiven site, many variations of the predefined types are used. As shown in theabove figure, every type of IDoc has three parts:

• Control Record — The format of the Control Record is identical for all IDoctypes. It contains many fields that specify control information, includingmessage ID, the message time, SAP proxy system (logical system), and manyothers.

• Data Records — A Data Record consists of a fixed administration part and adata part (segment). The number and format of the segments can be differentfor each IDoc type and can be recursive, which means that a segment cancontain other segments.

• Status Record — The Status Record describes the processing stages that anIDoc can pass through, and has an identical format for each IDoc type. Statusentries include error and status codes, and state of message processing such as“created”, “sent”, etc.

To determine the syntax of each IDoc type, SAP uses IDoc metadata. Themetadata specifies the IDoc segments in a tree structure, with data fieldcharacteristics within segments, metadata version, and other information genericto the IDoc type. This metadata is extracted by the TIBCO Designer palette andsaved to the project.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 406: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

384 | SAP Overview

RFC/BAPI Structure

Remote Function Calls (RFCs) are implemented in request/reply communication.Business Application Programming Interfaces (BAPIs) are standard SAP businessinterfaces to BOR, and functionally are similar to RFCs. Schema files are extractedfrom the SAP system instance using the TIBCO Designer palette and saved to theproject.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 407: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 385

Appendix C Frequently Asked Questions

This appendix lists answers to the frequently asked questions.

Topics

• Frequently Asked Questions

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 408: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

386 | Frequently Asked Questions

Frequently Asked Questions

What are the requirements to bring up TIBCO Designer from a UNIX command-line?

TIBCO Designer is a GUI based tool and a UNIX GUI environment is mandatoryto run it. You can start TIBCO Designer from the command line.

When starting the adapter, what if the repository is not found?

Start the repository server before starting the adapter. If you are starting a remoterepository ensure that TIBCO Administrator Repository edition is installed on theremote location. Ensure that a properly configured .dat file is available in thepath specified (local or remote). Ensure that the RepoUrl has been specifiedaccurately in the adapter’s .tra file.

Why does the adapter startup fail?

Ensure that the RepoUrl syntax has been specified accurately in the adapter’s.tra file. Ensure that the path specified for the .tra file is correct.

Why does the adapter startup fail, even after specifying the appropriate dat file?

You must start the repository server before you start the adapter. If it is a remoterepository ensure that the RepoUrl syntax has been specified accurately in theadapter’s .tra file. Ensure that the path specified for the .tra file is correct.

When saving an adapter configuration to the project, if an error occurs where is it logged?

TIBCO Designer error messages are logged to the files stderr.log anddesigner.log under the TIBCO_HOME\Designer\<version_number>\logsdirectory.

When an error occurs in a Subscription Service adapter service, where is it displayed?

Errors that occur in a Request-Response operation are sent to the client. Errorsthat occur in a subscription service are logged to a trace file. The log file path andname is set in the .tra file corresponding to the adapter instance. All logs are sentto <install_path>\adapter\<adapter name>\<version>\logs unless otherwisespecified.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 409: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Frequently Asked Questions | 387

Why does the adapter fail to respond to a request?

The subject name may be inconsistent. The subject name to which the adapterlistens may be different from that of the subject name of the client.

Why does the adapter fail to respond to a request after successfully receiving it?

The adapter may fail to respond due to various reasons like errors resulting fromclass mismatch, records not being available in the target application or,connectivity problems with the target application.

I am subscribing to an IDoc using an inbound instance to post into the SAP system. Whathappens to the IDoc if the connection to the SAP system goes down just before the adapterreceives the IDoc or while processing the IDoc ?

On receipt of an IDoc, the subscriber instance checks for validity of the connectionto SAP before posting. If the connection is found to be invalid, the adapterimmediately starts a timer to check for connections to SAP periodically andsuspends the IDoc subscriber so that no further messages are received. The IDocmessage is not confirmed to the sending system.

When the SAP system comes up again, the adapter re-establishes connectivity,and restarts itself automatically to receive the unconfirmed IDoc message.

The connection timer's polling interval is configurable. This recovery mechanismis also available for Inbound oneway RVCM messages.

I have to send sales order information as IDocs to my partner system. The partner is interestedin the information coming in just one segment of the IDoc. Do I still have to publish the entireIDoc to the partner?

The publication service of the adapter provides a way to filter irrelevantinformation from IDocs coming out of the SAP system at both segment and fieldlevels. This feature allows selective publication of only those segments or fieldsthat the partner is interested in.

A partner profile in our SAP system is configured to 'collect IDocs' to push the IDocs out in abatch. Can the adapter also be configured to publish IDocs in batches?

The explode batch format of IDoc publication allows you to bunch and publishIDocs in completely self-describing format in one batch, the size of the batchbeing equal to the packet size configured in SAP for the partner profile.

Why does the adapter startup fail, and give the following error, 'Failed to enable CM transport'?

The possibilities of this error are:

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 410: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

388 | Frequently Asked Questions

• There might be another instance running under the same CM session.

• Permission to create ledger file under the specified directory might be denied.

• The ledger file to be created for the CM session might be corrupted.

Check all these before starting the adapter. If you find a corrupted ledger file, thendelete the file. But you might miss some messages.

How can I update my repository, when there is a change in the schema for IDoc in the SAPsystem, without losing my mappings?

Whenever there is a change in IDoc, the IDoc has to be downloaded again. Theconfigured service for the IDoc should be deleted and recreated with the newIDoc.

If the change in IDoc does not disturb the mapped parameters then the mappingswill not be affected. For example, if you add new export parameter to the schema.In your mappings you will be able to find the new export parameter along withthe other mappings.

If you delete the parameter being mapped from the schema, then the mapping forthe parameter will be lost.

How can I debug my ABAP code when executing the program using the adapter?

The adapter provides an option called ABAP Debug. This flag has to be set to 1during adapter configuration. See Setting up Client Configuration Options onpage 147 for details. Thus once that ABAP program is called, the adapter opensup the SAP GUI, and then you can debug your ABAP code.

How many connections are possible per SAP ID?

Maximum connections per SAP ID should not go above 300. This limit is imposedby SAP. Also SAP licensing is based on user names and not number ofconnections.

What should I do if I do not want to have a permanent connection to SAP, but would like to have

To use ABAP debug, you should have SAP GUI installed on the machine onwhich the adapter is being executed.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 411: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Frequently Asked Questions | 389

a connection established by the adapter when required?

You can dynamically set up connection to SAP when the adapter receives themessage. In case of RFC, you can select the check box Logon Required in theadapter services. Hence when that adapter service receives the request, it firstestablishes connection with SAP before servicing it. You can additionallyconfigure event based connection for RFC/IDoc service of an Inbound adapter.For information regarding its configuration, see Event Driven InboundConnections on page 242.

When sending IDocs from SAP, the adapter does not receive the IDocs but the SAP systemshows that the IDocs were sent without any errors. Why isn't the adapter receiving the IDocs?

This may be because you have more than one adapter listening to the sameProgram ID. Ensure that each adapter is configured for a separate program ID. Tocheck if your program ID is not used by any other adapter at any given time, inSAP go to transaction sm59. Go to your program ID under TCP/IP connection,and then click on test connection. As your adapter instance is not up, the testconnection should fail, or else there is someone else using the same program ID.

How do I know what version and patch level of the adapter, TRA, and Designer I am using?

For exact TRA build, you can look up the file, version.txt under/tibco/tra/<version_number>. When you start the adapter, you will see a bannerwhich will give you the adapter version and patch level. When you open theTIBCO Designer, click the Help menu select About. A popup displays the TIBCODesigner version and the build.

How can the Load Balancing feature of the adapter be used on the Outbound side?

For outbound load balancing, Manager can be used. To set up Manager, duringthe adapter instance configuration, in the Adapter Services tab of the adapterinstance, select outbound Management as Remote. For more information on itsconfiguration refer to the TIDManager on page 195. Make sure that you bring upthe Manager first before you bring up the adapter instances.

How can the Load Balancing feature of the adapter be used on the Inbound side?

For Inbound load balancing, the Distributed Queue feature of the adapter can beused. For more information on configuration and its usage refer to LoadBalancing Using Distributed Queue on page 178.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 412: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

390 | Frequently Asked Questions

When can I use Remote Management?

Management can be used to avoid duplication on the Outbound as well asInbound side when you have more than one adapter instance publishing orsubscribing the same IDocs or tRFCs.

Adapter when processing Latin-2 data, throws up error "Unicode conversion failure: Failed toconvert type "ibm-943 " to Unicode - have you defined the env var TIB_ICU_DATA to point tothe directory that contains tibicudata.dat?" Why is the adapter displaying this error?

Check whether the environment variable TIB_ICU_DATA is set to/tibco/tra/<version_number>/bin and this directory contains the file,tibciudata.dat. Also check whether the characters being sent to the adapterbelongs to the locale set.

At times the adapter throws 'CPIC Error' but after some time it continues processing themessage. Is this something to worry?

CPIC error usually occurs when the adapter is unable to obtain connection to SAP.This may be due to network overload or glitches. It may be also due to sometransient network problems. To verify the same, you can try connecting to SAPfrom the SAP GUI installed on the same machine on which the adapter isthrowing the error.

Adapter gives a core dump on HP-UX and AIX machines. Why does this happen?

The adapter requires you to increase the stacksize by setting the same in theadapter properties file. For more information on stack size and its settings, seeMultithreading on page 233.

I want to open a Support Call. What information should I include in my request so as to avoidunnecessary delays?

If you are planning to open an SR just for information purpose, then include theadapter version and patch level, the platform on which the adapter is runningand the version of SAP system.

If you are opening an SR because you are facing some problems and gettingerrors, then do not forget to include the following:

• TIBCO ActiveMatrix Adapter for SAP Version and patch level

• The TRA version and patch level

• TIBCO Designer version and patch level

• Platform on which the adapter is being run

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 413: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Frequently Asked Questions | 391

• Fresh adapter log files (if error occurs during adapter execution) or DesignerLog files and Designer Console Output (if error is occurring duringconfiguration)

• The repository in which you are getting the error and also the adapterproperties file (adr3.tra)

• The SAP version

• Additional information regarding other components like TIBCOIntegrationManager or TIBCO ActiveMatrix BusinessWorks if acting as sourceof message to the adapter. Also include your contact information.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 414: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

392 | Frequently Asked Questions

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 415: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 393

Appendix D Wireformat Backward Compatibility

This appendix describes wireformat backward compatibility.

Topics

• Backward Compatible RV Message Specification

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 416: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

394 | Wireformat Backward Compatibility

Backward Compatible RV Message Specification

The R/3Publisher Adapter receives IDocs from an SAP system and converts theminto TIBCO Rendezvous messages, which are then published on TIBCORendezvous. The R/3 Subscriber Adapter listens for (subscribes to) thesemessages, receives the data, converts it to IDocs, which are then posted to thereceiving SAP system.

This SAP Adapter supports two different types of message formats for backwardcompatibility. They are briefly described below. The section that followselaborates on the formats.

• SAPCIF: The IDoc is first converted into SAP Certified Intermediate Formatand then packed into an RV message. This RV message contains the IDocheader data followed by IDoc data in SAPCIF format. All the fields present inSAPIDOCOPAQUE message type are present in SAPCIF, except that themessage values are presented in the form of name-value pairs. Each IDoc ispacked into a separate RV message.

• BATCHED: This format is provided to support more efficient handling ofIDocs in groups or “batches.” In batch mode one or more IDocs can be sent ina packet by the SAP system to the SAP Adapter Publisher. All the IDocsreceived in the packet are added to a single RV message. The RV message isappended with IDoc header information followed by the packet of IDoc data.In batch mode, even if only one IDoc is sent, the SAP Adapter still handles theRV message creation as if the IDoc were in a packet. Note that if the“PutEndOfLineInIDOC” is set to 1 in the adapter Publisher configuration file,the Publisher will put a line-feed character at the end of each row of IDoccontrol and data records before publishing them to TIBCO Rendezvous.

Message FieldsIn all three message types the IDoc data is packed in the RV message as ASCII textthat is further divided into fields. Some of the fields must be present in all IDocsand others are present for particular IDoc types.

The following table summarizes the message field format requirements forversion 1.0.x.

IDoc Field Name RV Message Type CIF Batched

SAPIDocType RVMSG_STRING X

SAPIDocRel RVMSG_STRING X

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 417: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Backward Compatible RV Message Specification | 395

The fields are describes below.

Field Name: SAPIDocType

Type: RVMSG_STRING

Length: Variable

Valid values: Valid IDoc types e.g. “MATMAS02” or “CREMAS01” or “SISCSO01” etc.

Description: The IDocTYPE parameter of the control record of an IDoc. It specifies the IDoc Type.

Required?: Yes.

Field Name: SAPIDocRel

Type: RVMSG_STRING

Length: 3 bytes

Valid values: Three-byte SAP release indicator; e.g. “31H” or “40B” or “31G” etc.

Description: The SAP system release from where the IDoc originated.

Required?: Yes.

Field Name: SAPIDocNo

Type: RVMSG_STRING

Length: 16 bytes

SAPIDocEnc RVMSG_UINT X X

SAPIDocMsga RVMSG_STRING X X

SAPIDocTableName RVMSG_STRING X X

EOLPresent RVMSG_BOOLEAN X

NUMBEROFIDOCS RVMSG_UINT X

a. If compression is enabled, the Rendezvous message type is RVMSG_OPAQUE

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 418: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

396 | Wireformat Backward Compatibility

Valid values: Positive number represented as string and appropriately padded with zeros, e.g. “0000000000152674”

Description: The unique IDoc number assigned by SAP to IDoc in ALE (Application Link Enabling) communication layer, when it is being sent to the server program (Publisher Adapter).

Required?: Yes.

Field Name: SAPIDocSize

Type: RVMSG_UINT

Length: The size of an RVMSG_UINT

Description: The size of an ASCII IDoc data string in number of bytes.

Required?: Yes.

Field Name: SAPIDocEnc

Type: RVMSG_UINT

Length: The size of an RVMSG_UINT

Valid values: 0 (SAPCIF) or 1(SAPIDOCOPAQUE format) or 2 (BATCHED)

Description: The encoding format in which the IDoc is being transmitted.

Required?: Yes.

Field Name: SAPIDocTableName

Type: RVMSG_STRING

Length: Variable

Valid values: “EDI_DC” or “EDI_DC40”

Description: Control field table name. The string in this field is either “EDI_DC” to indicate the data is from SAP version 3.x or “EDI_DC40” to indicate the data is from SAP version 4.x.

Required?: Yes.

Field Name: EOLPresent

Type: RVMSG_BOOLEAN

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 419: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Backward Compatible RV Message Specification | 397

Length: 1 byte

Valid values: 1 for true, 0 for not true

Description: In a message containing BATCH IDocs, the IDocs individual lines, of control records and data records can be combined and sent as one continuous chunk of ASCII data without any line breaks. In such a case the EOLPresent is equal to 0. When each line is separated from other by a line break EOLPresent is equal to 1

Required?: In Batch IDocs only.

Field Name: NUMBEROFIDOCS

Type: RVMSG_UINT

Length: The size of an RVMSG_UINT

Valid values: A count greater than zero.

Description: The number of IDocs transmitted in a batch

Required?: In Batch IDocs only.

Field Name: SAPIDocMsg

Type: RVMSG_STRING

Length: Variable

Description: The ASCII IDoc data that is sent in the RV message. The IDoc data begins with the IDoc type indicator followed in sequence by IDoc release indicator, the control record, and a number of data records. Each of the indicator or record types is terminated by end of line symbol. The valid lengths for IDoc are 524 (+1 for end of line) and 1063 (+1 for end of line) respectively for control and data records.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 420: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

398 | Wireformat Backward Compatibility

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 421: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

TIBCO Wrapper Generation for SAP | 399

Appendix E TIBCO Wrapper Generation for SAP

This appendix describes the installation and the usage of TIBCO WrapperGeneration for SAP.

Topics

• Overview

• Installation

• Usage

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 422: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

400 | TIBCO Wrapper Generation for SAP

Overview

This TIBCO Wrapper Generation for SAP generates wrapper function modules ofRFC/BAPI function modules where the table type parameters exist in thefunction interface. A table type describes the structure and functional attributes ofan internal tables that are stored in the ABAP Dictionary.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 423: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Installation | 401

Installation

The TIBCO Wrapper Generation for SAP is executed on the SAP developmentsystem using a SAP client where repository objects can be created and recorded.Once the wrapper function modules are generated they can be importeddownstream across other test and production SAP systems.

If the interface of RFC/BAPI function module changes, run TIBCO WrapperGeneration for SAP again.

Pre-requisites

• Function Modules should be RFC enabled.

• Function Modules should have at least one table type parameter and the tabletype parameter refer to flat structures, meaning that its line type whichdefines the structure and data type attributes of a line of the internal tableshould have more than one data elements.

• Make sure there are no inactive versions of RFC/BAPI.

If any inactive versions exist, TIBCO Wrapper Generation for SAP will use thelast active version of the RFC.

• If using function groups starting with Z or Y, it is recommended that you use adifferent function group to generate the wrapper code.

Installation Steps

Follow these steps to install TIBCO Wrapper Generation for SAP:

1. Log into the SAP development system.

2. Execute the transaction code SE38.

3. Specify the Program ZTIBCO_AUTOGEN_TEMPLATE.

4. Click Create.

The ABAP: Program Attributes screen displays.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 424: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

402 | TIBCO Wrapper Generation for SAP

5. In the ABAP: Program Attributes screen:

a. In the Title field, type TIBCO Table Type Generator Tool.

b. Select INCLUDE program from the Type dropdown list.

c. Specify values for the following optional attributes:

— Status

— Application

— Authorization Group

d. Accept default values for all other fields.

6. Click Save.

You could either save as a local object or associate to a package. If associatingto a package, provide a package name starting with Z or Y.

7. From the ABAP Editor select Utilities (M) > More Utilities >Upload/Download > Upload.

8. Choose All Files (*.*) from the Files of type drop-down list.

9. Specify the path TIBCO_HOME/adapter/adr3/version number/tools/.

10. Choose ZTIBCO_AUTOGEN_TEMPLATE and click Open to load the contents ofthe file into the editor.

11. Click Save.

12. Click Activate.

13. Return to the main screen for SE38.

14. Specify the Program Name ZTIBCO_AUTOGEN_RFC_WRAPPER.

15. Click Create.

The ABAP: Program Attributes screen displays.

16. In the ABAP: Program Attributes screen:

a. In the Title field, type TIBCO Table Type Generator Tool.

b. Select Executable program from the Type dropdown list.

c. Specify values for the following optional attributes:

— Status

— Application

— Authorization Group

d. Accept default values for all other fields.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 425: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Installation | 403

17. Click Save.

Save as a local object or associate to a package, based on step 6 above.

If associating to a package, provide a package name starting with Z or Y.

18. From the ABAP Editor select Utilities (M) > More Utilities >Upload/Download > Upload.

19. Choose All Files (*.*) from the Files of type drop-down list.

20. Specify the path TIBCO_HOME/adapter/adr3/version number/tools.

21. Choose ZTIBCO_AUTOGEN_RFC_WRAPPER and click Open to load the contentsof the file into the editor.

22. Click Save.

23. Click Activate.

24. In the ABAP editor, in the menu, select Goto -> Text Elements -> SelectionTexts. Enter values as shown below:

25. Click Save.

26. Click Activate.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 426: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

404 | TIBCO Wrapper Generation for SAP

Usage

After the installation is complete, the TIBCO Wrapper Generation for SAP toolcan be executed using transaction code SE38.

1. Log into the SAP development system.

2. Execute transaction code SE38.

3. Specify the Program ZTIBCO_AUTOGEN_RFC_WRAPPER.

4. Click Execute (F8).

The following screen displays:

5. Choose one of the following options:

— Specific RFC/BAPI: Select the radio button for Specific RPC/ BAPI andspecify a Function Module.

— Function group: Select the radio button for Function group and specify anexisting Function Group name.

6. Specify a value that starts with a Z or Y character in the Prefix field.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 427: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

Usage | 405

The Wrapper function modules are created with the names prefix as given inthis field.

7. Check the checkbox for Test only to execute in the test mode.

In the test mode, wrapper modules will not be generated. It is recommendedthat you first execute the TIBCO Wrapper Generation for SAP tool in the testmode.

To create the wrapper modules, uncheck the check box for Test only.

8. Choose one of the following options:

— Check the checkbox for Use existing function group to create wrappermodules in the same function group as the function modules.

— Check the checkbox for Use function group specified to create thewrapper function modules in a different function group as specified in theTarget Function Group field.

Specify the function group to use in the Target Function Group field.

The wrapper function module is created in this function group

9. If TIBCO Wrapper Generation for SAP was associated to a package duringinstallation, you may be prompted to provide a Workbench request transportnumber and the following screen displays:

Create a new request or specify an existing request number and then clickContinue.

TIBCO Wrapper Generation for SAP creates the wrapper function modules andgenerates a report.

Wrapper function module names cannot not be longer than 30 characters. If thewrapper function module names are longer than 30 characters, the trailingcharacters will be truncated.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 428: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

406 | TIBCO Wrapper Generation for SAP

The following screen shows a sample report that is generated when the TIBCOWrapper Generation for SAP tool is executed against a specific function groupcontaining few function modules:

The above report contains the following cases:

— not RFC Enabled: indicates those function modules that are not applicablefor conversion as they are not RFC enabled.

— ignored: indicates those function module that do not require the wrapperfunction module as they does not have the table type parameters.

— wrapper creation successful: indicates that wrappers were successfullycreated for this function module.

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

Page 429: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 407

Index

A

ABAP Debug 149Adapter Configuration 41Adapter Services folder 5Adding a Client Connection 137Adding a Connection Reference 134Adding a Server Connection 151Adding Adapter Services 76Adding Adapter Services Automatically 77Adding an Active Connection 132Adding Connections to an Adapter 130advanced folder 5ALE/IDoc Interface 2API xxApplication Server 379Assigning an Active Connection to an Adapter 136,

136Assigning CMQ Name - Inbound Load-balanced

Instance 181Assigning Dynamic Filenames to File Sinks - Inbound

Load-balanced Instance 182, 185

B

Backward Compatible RV Message Specification 394Basic Steps for Configuring and Using the Adapter 16Before Starting 16

C

Class Microagent Name field, adapter 64Client Connection with Load Balancing 141Client Connection with saprfc.ini file 143clientvar property 272

configure SAP instanceto run on two systems 247

Configuring a User Exit for a Publication Service 160Configuring a User exit for a Subscription Service 171,

171Configuring Advanced Publisher Options 160Configuring Advanced Request-Response Invocation

Options 171Configuring Client Connection with Load

Balancing 141Configuring Client Connection with saprfc.ini

File 143Configuring Dedicated Application Server Client

Connection 139Configuring Default Server Connection 152Configuring Multiple Connections for Inbound

Instance 171Configuring Multiple Connections for Outbound

Instance 175Configuring Request-Response Invocation

Service 113Configuring Request-Response Service 119Configuring Schema for Adapter Services 119Configuring Server Connection with saprfc.ini 154,

154Configuring Valid Destinations 128Creating a Project for the Adapter 16customer support xxii

D

Database Server 380debugging 149Dedicated Application Server Client Connection 139Default Server Connection 152, 152Defining a TIBCO Hawk Session 65documents related xvi

TIBCO ActiveMatrix Adapter for SAP Configguration and Deployment¶ Font>

Page 430: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

408 |

E

ENV_HOME xviiierror

publisher application is not running 27Event Driven Inbound Connections 242, 242Example 96, 96, 101, 101, 132, 132

Registering an RFC Server Program Example 158Exchanging Business Information 381

F

Find RFC Destinations Screen 248Frequently Asked Questions 385, 386

G

Gateway Options 248getConnectionStatistics() 195, 277getThreadStatistics() 195, 277Getting Ready to Run Unicode 256Getting Started with Adapter Configuration 16

H

Handling Large Internal Tables from SAP 211Handling Large Internal Tables from SAP R/3 211

I

Identifying the Publication Mode 88IDoc

records contained 88structure 383

IDoc Filtering 215IDoc in native RFC table format 89IDoc in uncompressed “exploded” format 91

IDoc Structure 383IDocs

compressed form 90exploded format 91metadata 90versions supported 88

IDocs Tab 79Inbound BAPI Transactional Support 218Invoking BAPIs/RFCs Using Transactional Semantics

in SAP R/3 227

L

Load Balancing 178load balancing 266Log File field, adapter 59Log Info field, adapter 60Log to Standard field, adapter 59

M

Message Fields 394metadata 6Microagent Session field, adapter 64Mode “10Xbatched” 92Mode “10Xcif” 91Mode “none” 88Multiple Application Servers 242Multiple Inbound Configurations 180Multiple Program IDs 235Multithreading 233Multithreading with Distributed Queues 234

O

obfuscation 269Overview 254, 304

TIBCO ActiveMatrix Adapter for SAP Configguration and Deployment¶ Font>

Page 431: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

| 409

P

palettes 5password property 273Procedure 220, 247Publication Service 84Publishing IDocS on Dynamic Subjects 167

R

R/3 378R3 Connections Folder Hierarchy 130related documents xviReplacing Control Fields 169repository instance 6Request-Response Invocation Service 106Request-Response Service 113, 113resetActivityStatistics() 195, 277RFC Destination RFCTEST Screen 248RFC Destinations 247RFC Interface 2RFC Trace 149RFC/BAPI Structure 384RFCs/BAPIs Tab 81Running an Adapter Instance on Two SAP R/3 Sys-

tems with Single Connection 247RV xxiRVCM xxiRVCMQ Session Attributes 179RvDaemon 190RVDQ xxi

S

Sample saprfc.ini Files 158Sample Scenario 220, 247SAP

application server 379connection error 27database server 380error message 27

SAP GUI Presentation Server 378SAP Language Support 254SAP R/3 Overview 377SAP R/3 Releases 3.x 80SAP R/3 Releases 4.x 80SAP server

GUI/Presentation Server 378saprfc.ini Server Connection 154Saving the Project 124schema

examples of use 39xml 89

schema data 6Schema Support 39Select Gateway Options Pull-down Menu 248Selecting Client Connection Type 137Selecting Server Connection Type 151Setting Adapter Configuration Options 67Setting Adapter Design-Time Connection Options 67Setting Adapter Run-Time Options 128Setting Adapter Standard Logging Options 68, 68Setting Advanced Client Options 147Setting Client Connection Advanced Options 145Setting Inbound Instance Options 67Setting Inbound/Outbound Instance Options 67Setting Outbound Instance Options 67Setting Publisher Configuration Options 84Setting Server Connection Advanced Options 156Setting Subscriber Configuration Options 106Setting TIDManager Configuration Options 199Setting TIDManager for Fault Tolerance 206Setting TIDManager Logging Options 200Setting TIDManager Monitoring Options 202Setting TIDManager Run-Time Options 203Setting up Active Connection Configuration

Options 132Setting up Client Configuration Options 147Setting up Connection Reference Options 134Single Inbound Configuration 181Single Outbound Instance 183Standard Microagent Name field, adapter 63Subscription Service 98, 98Subscription Service - Using Distributed Queue 178Summary of SAP R/3 Interfaces 381support, contacting xxii

TIBCO ActiveMatrix Adapter for SAP Configguration and Deployment¶ Font>

Page 432: TIBCO ActiveMatrix Adapter for SAP ActiveMatrix® Adapter for SAP Configuration and Deployment Software Release 6.2 March 2012

410 |

T

technical support xxiiTerminating the Test 36Test Connection Button 250The SAP R/3 Business Application System 378TIBCO ActiveMatrix Adapter for SAP

ALE IDoc interface 382TIBCO Wrapper Generation for SAP

installation 401pre-requisites 401usage 404

TIBCO_HOME xviiiTIDManager 196tracing 149

U

Use Advanced Logging field, adapter 58Use SAPGUI 149username property 273Using a Dedicated Application Server to Connect

Example 159Using Global Variables 190Using Logon Groups to Connect an RFC Client to SAP

Example 158

W

wire formatheader information 92, 93

Wireformat Backward Compatibility 393

TIBCO ActiveMatrix Adapter for SAP Configguration and Deployment¶ Font>


Recommended