TIBCO ActiveMatrix Adapter for SAP Configuration and ...

TIBCO ActiveMatrix® Adapter forSAP

Configuration and DeploymentSoftware Release 7.0July 2013

Two-Second Advantage®

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 THE LICENSE FILE) 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.TIBCO, Two-Second Advantage, TIBCO ActiveMatrix Adapter for SAP, TIBCO ActiveMatrix Binding Type forAdapters, TIBCO ActiveMatrix BusinessWorks, TIBCO ActiveMatrix Implementation Type for TIBCO Adapters,TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix Service Grid, TIBCO Adapter SDK, TIBCOAdministrator, TIBCO Business Studio, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk,TIBCO Rendezvous, and TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCOSoftware Inc. in the United States and/or other countries.Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition(J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporationin 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 FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFICOPERATING 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-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

| iii

Contents

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

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiTIBCO ActiveMatrix Adapter for SAP Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiThird-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxiv

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviiiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviiiHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviiiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii

Chapter 1 Introduction of Adapter Configuration and Deployment . . . . . . . . . . . . . . . . . . . . . . .1

Configuration and Deployment Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Deployment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Production . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Features of TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Creating a Project for the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Working with the GettingStarted Sample Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Configuring Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Testing Design-Time Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Configuring RFC Outbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Configuring RFC Inbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuring IDoc Outbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuring IDoc Inbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Testing the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16


iv | Contents

Starting the TIBCO EMS server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Starting the adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Testing RFC Loop Back Connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Testing IDoc Loop Back Connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 3 Preparing the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Configuring Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Configuring Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Outbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Inbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Creating Logical System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Establishing Distribution Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Configuring RFC Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Testing the SAP ALE Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 4 Developing an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Adapter Project Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Starting TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Saving a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Opening and Reopening a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Opening a Multi-File Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Importing a Project Saved as a ZIP Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Opening a Project under a Revision Control System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Opening a Project Saved as a DAT File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Working with Global Variables at Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Specifying Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Using Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Precedence of Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Working with a Revision Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Working with a Multi-File Format Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Locking an Adapter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Managing Schema Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Copying, Cutting, Pasting, and Moving a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Chapter 5 Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Creating an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Changing an Existing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


Contents | v

Adapter Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Design-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Runtime Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Runtime Outbound Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Adapter Services Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Chapter 6 Configuring an Adapter Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99

Adding an Adapter Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Adding an Adapter Service Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Adding an Adapter Service Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102IDocs Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104RFC/BAPI Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Configuring an Adapter Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Transport Specific Options for Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Transport Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Wire Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Delivery Mode (JMS Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Connection Factory Type (JMS Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Quality of Service (Rendezvous only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Publication Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Subscription Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Request-Response Invocation Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Request-Response Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139


vi | Contents

Chapter 7 Configuring an Adapter Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Adapter Connection Configuration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Adding Connections to an Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Adding an Active Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Setting up Active Connection Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Adding a Connection Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Setting up Connection Reference Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Assigning an Active Connection to an Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Adding a Client Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Client Connection Types Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Selecting Client Connection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Dedicated Application Server Configuration Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Load Balancing Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Secure Network Connection - SNC Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Setting Client Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Setting up Clients Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Adding a Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Server Connection Types Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Selecting Server Connection Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Default Server Connection Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Secure Network Connection - SNC Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Setting Server Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Chapter 8 Configuring TIDManager Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Introduction of TIDManager Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Interactions between the Adapter and the TIDManager Server Configuration . . . . . . . . . . . . . . . . . . . . . . 172Recovering from Network Outages and TIDManager Server Downtimes . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Setting TIDManager Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Setting TIDManager Logging Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Setting TIDManager Startup Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Setting TIDManager Monitoring Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Setting TIDManager General Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Configuring a TIDManager Session on JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Setting TIDManager for Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Set Up the TIDManager for the Fault Tolerance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Set Up the TIDManager and Adapter for the Fault Tolerance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Chapter 9 Working with Secure Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Introduction of Secure Network Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188SAP Cryptographic Library for SNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188


Contents | vii

Setting Up SNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Download the SAP Cryptographic Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Install the SAP Cryptographic Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Set the Trust Manager Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Create an SNC PSE for the SAP J2EE Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Set SNC Profile Parameters for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Install the SAP Cryptographic Library on the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Install the PSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Set the SNC Parameter Specific to an Inbound Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Set SNC Parameters Specific to Outbound Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Set SNC in TIBCO Designer for the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Useful Transaction Codes in the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Chapter 10 Developing a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215

Overview of Business Process Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Activities for Communicating with Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Activity Configuration Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Mapping and Transforming Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Activity Input Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Mapping and Transforming Process Data to Activity Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Mapping Data with Adapter Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223For Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223For Request-Response Invocation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224For Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Data Type Mapping between the SAP System and Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Testing a Process Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Chapter 11 Deploying an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235

Generating an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Generating an EAR File in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Generating an EAR File in TIBCO Designer for a Project Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236EAR Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Starting TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Task A Start the Administration Server and TIBCO Hawk Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Task B Start the TIBCO Administrator GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Creating an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Changing Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Overview of Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Tuning Performance Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Working with Global Variables at Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Changing Adapter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252


viii | Contents

Deploying an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Deployment Choices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Chapter 12 Managing and Monitoring an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Starting and Stopping a Service Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Overview of Service Instances Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Starting and Stopping a Service Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Viewing Log File Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Configuring Monitoring Options for Using TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Enabling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262(Optional) Defining a TIBCO Hawk Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . 264Invoking a Microagent Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264Adding a Rulebase to a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Monitoring a Service by Using TIBCO Hawk Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Enabling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Starting TIBCO Hawk Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Invoking a Microagent Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Chapter 13 Advanced Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Configuring Advanced Logging Options for an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Using TIBCO Adapter SDK for Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Using Log4J for Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Setting TIBCO Messaging Encoding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280TIBCO Messaging Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Setting Encoding at Design Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Setting Encoding at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Connecting with the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Managing the Connectivity with the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Adapter Reconnection with the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Adapter Connecting to Multiple Client Connection Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Configuring Multiple Connections for Inbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Configuring Multiple Connections for Outbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Connecting to the SAP System Using bgRFC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Password Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Compressing JMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Inbound BAPI Transactional Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Sample Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Configuring Multiple Transactional RFC Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Invoking Multiple RFC/BAPI Transactions as One Transaction in SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Invoking BAPI/RFCs Using Transactional Semantics in SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296


Contents | ix

Support for qRFCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296Sending IDoc through qRFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Receiving IDocs through qRFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Multithreading in Outbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Multithreading in Inbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Multithreading with Distributed Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Multiple Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Posting BAPIs/RFCs/IDocs from Multiple Gateways in the Outbound Adapter . . . . . . . . . . . . . . . . . . . . . . 303Posting BAPIs/RFCs/IDocs from Multiple RFC Destinations in the Outbound Adapter . . . . . . . . . . . . . . . . 304Responding to Dynamic Changes in the Application Server Environment . . . . . . . . . . . . . . . . . . . . . . . . . . 304Configuring the Inbound Adapter for multiple application servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

Event Driven Inbound Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Disabled Connection Pooling Inbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Performing Explicit Logon for RFCs/BAPIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

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

Using JMS Destination Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

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

Load Balancing Using Distributed Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Configuring Inbound Load-Balanced Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Multiple Inbound Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318Single Inbound Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Configuring Outbound Load-balanced Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

Configuring Valid Destinations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Appendix A Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .325

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Appendix B Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333

Appendix C Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .335

Overview of Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Password Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

Adapter Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339Required Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339TIBCO ActiveMatrix Adapter for SAP Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340


x | Contents

Appendix D Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Overview of Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Fields of Trace Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Status Messages of TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Trace Messages of TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352Design-Time Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391Trace Messages Discontinued . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

Appendix E Adapter Microagents and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Adapter Microagents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

Available TIBCO Hawk Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Appendix F Migrating an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

Migrating a Project by Using TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

Migration Tool Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

Migration Tool Directory and Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Migration Tool Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

Notes for Running the Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Migrating a Project by Using the Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462Before the Migration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462Run the Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462After the Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

Steps Following Migration of Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467


Figures | xi

Figures

Figure 1 TIBCO Designer Start Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Figure 2 TIBCO Designer - Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Figure 3 Configuration of RFC Connections - DOCTEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Figure 4 RFC Destination DOCTEST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Figure 5 RFC Destination DOCTEST MDMP and Unicode Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Figure 6 Connection Test DOCTEST Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Figure 7 Connection Test DOCTEST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Figure 8 Transaction SE37. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Figure 9 Builder: Initial Screen - BAPI_CUSTOMER_FIND. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Figure 10 Test Function Module: Initial Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Figure 11 Structure Editor: Change SELOPT_TAB from Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Figure 12 Structure Editor: Display RESULT_TAB Entry 1 From 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Figure 13 Transaction BD12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Figure 14 Enter Send Customers Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Figure 15 Information Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Figure 16 Transaction WE02 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Figure 17 IDoc List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 18 Outbound IDocs DEBMAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 19 Inbound IDocs DEBMAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Figure 20 SALE Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 21 Define Logical System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 22 Information Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 23 Change View “Logical Systems” Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 24 New Entries: Overview of Added Entries Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Figure 25 Change ==> Display Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Figure 26 Prompt for Workbench Request Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Figure 27 DOCVIEW Logical System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Figure 28 Create Request Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38


xii | Figures

Figure 29 DOCVIEW Logical System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Figure 30 TESTCLN Logical System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Figure 31 Maintain Distribution Model and Distribute Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Figure 32 Change Distribution Mode Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Figure 33 Create Model View for Inbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Figure 34 Distribution Model Changed - Model View for Inbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . 42

Figure 35 Add Message Type - Inbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Figure 36 Create Model View for Inbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Figure 37 Distribution Model Changed - Model View for Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . 43

Figure 38 Add Message Type - Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 39 RFC Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Figure 40 RFC - Connection Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Figure 41 Generate Partner Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Figure 42 Log for Partner Profile Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Figure 43 Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Figure 44 Partner Profiles DOCVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Figure 45 Partner Profiles: Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Figure 46 DOCVIEW Logical System Inbound Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Figure 47 DOCVIEW Logical System Outbound Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Figure 48 Send Customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Figure 49 Send Information Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Figure 50 Information Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Figure 51 TIBCO Designer Startup Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Figure 52 Save Project Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Figure 53 Global Variables Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Figure 54 Add Files to the Revision Control System Warning Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Figure 55 Adapter Instance - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Figure 56 Adapter Instance - Change Version Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Figure 57 Adapter Instance - Design-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Figure 58 Connection Success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Figure 59 Connection Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Figure 60 Adapter Instance - Runtime Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83


Figures | xiii

Figure 61 Adapter Instance - Runtime Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Figure 62 Adapter Instance - Adapter Service Tab, Outbound TID Management: Local . . . . . . . . . . . . . . . . . 87

Figure 63 Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote . . . . . . . . . . . . . . . 88

Figure 64 Adapter Instance - General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Figure 65 Adapter Instance - Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Figure 66 Sample Outbound Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Figure 67 Adapter Instance - Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Figure 68 Adapter Instance - Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Figure 69 Adapter Services - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Figure 70 Adapter Services - IDocs Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Figure 71 Adapter Services - RFC/BAPI Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Figure 72 Publication Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Figure 73 Publication Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . . . 118

Figure 74 IDoc in Native RFC Table Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Figure 75 IDoc in Uncompressed “Exploded” Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Figure 76 Publication Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Figure 77 Publication Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Figure 78 Subscription Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . . 126

Figure 79 Subscription Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . . 127

Figure 80 Subscription Service - Schema Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Figure 81 Subscription Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Figure 82 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . 132

Figure 83 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous. . . . . 134

Figure 84 Request-Response Invocation Service - Schema Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Figure 85 Request-Response Invocation Service - Advanced Tab - Transport Type Rendezvous . . . . . . . . 135

Figure 86 Request-Response Service - Configuration Tab - Transport Type: JMS. . . . . . . . . . . . . . . . . . . . 136

Figure 87 Request-Response Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . 138

Figure 88 Request-Response Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Figure 89 Request-Response Service - Advanced Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . 139

Figure 90 Adapter Connection - R3 Connections Folder Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Figure 91 Adapter Connection - ActiveConnections Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Figure 92 Adapter Connection - ConnectionReference Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147


xiv | Figures

Figure 93 Adapter Connection - R3AdapterConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Figure 94 Adapter Connection - Select ClientConnection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Figure 95 Adapter Connection - Dedicated Application Server Runtime Inbound. . . . . . . . . . . . . . . . . . . . . 152

Figure 96 Adapter Connection - Load Balancing Runtime Inbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Figure 97 Adapter Connection - SNC Runtime Inbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Figure 98 Client Connection - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Figure 99 Client - Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Figure 100 Client - Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Figure 101 Adapter Connection - Select ServerConnection Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Figure 102 Adapter Connection - Default Server Connection Runtime Inbound. . . . . . . . . . . . . . . . . . . . . . . 165

Figure 103 Adapter Connection - SNC Runtime Inbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Figure 104 Server Connection - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Figure 105 R3TIDManager Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Figure 106 R3TIDManager Configuration Tab Change Version Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Figure 107 R3TIDManger Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Figure 108 R3TIDManager Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Figure 109 R3TIDManger Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Figure 110 R3TIDManager General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Figure 111 R3TIDManger GenericSession Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Figure 112 TIDManagerJmsSession Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Figure 113 Trust Manager Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Figure 114 Trust Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Figure 115 Configuring PSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Figure 116 PSE Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Figure 117 Import Certificate File Format Base64. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Figure 118 Table/View VSNCSYSACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Figure 119 Type of ACL Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Figure 120 Change View SNC ACL for Systems Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Figure 121 Runtime Inbound Connection in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Figure 122 Map the SNC Name to the User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Figure 123 RFC Destination ZPRALOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Figure 124 Runtime Outbound Connection in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212


Figures | xv

Figure 125 Developing a Business Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

Figure 126 Input Tab of an Example Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Figure 127 Segment Example in SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Figure 128 IDoc SEGNAM Property in the Input Tab of the Publish to Adapter Activity . . . . . . . . . . . . . . . . . 224

Figure 129 Invoke an Adapter Request-Response Service Activity - Input Tab. . . . . . . . . . . . . . . . . . . . . . . . 226

Figure 130 Edit Statement Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Figure 131 Select A Resource Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Figure 132 __caret__userClosure__caret_ element with the RFCCLOSURE Schema. . . . . . . . . . . . . . . . . . 228

Figure 133 Set Breakpoints Dialog for a Sample Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Figure 134 Select Processes To Load Dialog for a Sample Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Figure 135 Select A Resource Dialog for Shared Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Figure 136 Dependencies (Resources) Tab with the Certificate Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

Figure 137 Enterprise Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Figure 138 Adapter Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Figure 139 Application Management > Application Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Figure 140 New Application Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Figure 141 Application Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Figure 142 Deploy Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Figure 143 All Service Instances Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Figure 144 View Service Instance - Tracing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Figure 145 TIBCO Hawk Session Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Figure 146 Hawk Console - Microagent Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Figure 147 Hawk Console - Microagent Dialog - Method Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Figure 148 Machine Console - View Machine Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Figure 149 Microagents, Methods And Arguments Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Figure 150 Microagents, Methods And Arguments Dialog - getComponentInfo method . . . . . . . . . . . . . . . . . 271

Figure 151 Invocation Results - getComponentInfo method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Figure 152 Adapter Instance - Logging Tab for Advanced Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Figure 153 File Sink for an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Figure 154 Log4j Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Figure 155 Setting TIBCO Messaging Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Figure 156 RFC Destination Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286


xvi | Figures

Figure 157 Function Builder Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Figure 158 Create SaleOrder Process Running Successfully . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Figure 159 Sample OrderStatus File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Figure 160 Display Standard Order 14938: Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Figure 161 Create Sales Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Figure 162 Get Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

Figure 163 Outbound Adapter Connecting to Multiple SAP Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Figure 164 Outbound Adapter Registering on Multiple Program IDs on One Gateway . . . . . . . . . . . . . . . . . 304

Figure 165 Clustering Multiple Application Servers under a Central SAP Instance . . . . . . . . . . . . . . . . . . . . 305

Figure 166 Default RVCMQ Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Figure 167 RVCMQ Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

Figure 168 Palette Versioning Issues Dialog for a Migrated Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464


Tables | xvii

Tables

Table 1 TIBCO Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

Table 2 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv

Table 3 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii

Table 4 Remote Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Table 5 Adapter Instance - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Table 6 Adapter Instance - Change Version Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Table 7 Adapter Instance - Design-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Table 8 Adapter Instance - Runtime Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Table 9 Adapter Instance - Runtime Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Table 10 Adapter Instance - Adapter Service Tab, Outbound TID Management: Local . . . . . . . . . . . . . . . . 87

Table 11 Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote . . . . . . . . . . . . . . 88

Table 12 Adapter Instance - Adapter Service Tab, All Subscription Services. . . . . . . . . . . . . . . . . . . . . . . . 89

Table 13 Adapter Instance - General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Table 14 Adapter Instance - Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Table 15 Adapter Instance - Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Table 16 Adapter Instance - Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Table 17 Adapter Services - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Table 18 Adapter Services - IDocs Operation Type in the IDocs Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Table 19 Adapter Services - IDocs Tab for a 4.x SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Table 20 Adapter Services - IDocs Tab for a 3.x SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Table 21 Adapter Services - RFC/BAPI Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Table 22 Publication Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . . 117

Table 23 Publication Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . . 118

Table 24 Publication Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Table 25 Subscription Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . 126

Table 26 Subscription Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . 127

Table 27 Subscription Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 28 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . 133


xviii | Tables

Table 29 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous . . . . 134

Table 30 Request-Response Invocation Service - Advanced Tab - Transport Type: Rendezvous . . . . . . . 135

Table 31 Request-Response Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . 137

Table 32 Request-Response Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . 138

Table 33 Request-Response Service - Advanced Tab - Transport Type: Rendezvous. . . . . . . . . . . . . . . . 140

Table 34 Connection Service Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Table 35 Adapter Connection - Connection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Table 36 Adapter Connection - R3 Connection Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Table 37 Adapter Connection - ActiveConnections Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Table 38 Adapter Connection - ConnectionReference Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Table 39 Dedicated Application Server Runtime Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Table 40 Load Balancing Runtime Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Table 41 SNC Runtime Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Table 42 Client Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Table 43 Client - Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Table 44 Client - Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Table 45 Default Server Connection Runtime Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Table 46 SNC Runtime Inbound Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Table 47 Server Connection Advanced Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Table 48 R3TIDManager Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Table 49 R3TIDManager Configuration Tab Change Version Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Table 50 R3TIDManager General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Table 51 R3TIDManager GenericSession Configuration Tab Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Table 52 TIDManagerJmsSession Configuration Tab Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Table 53 Contents of the SAP Cryptographic Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Table 54 DIR_Executable Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Table 55 Location of SAP Cryptographic Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Table 56 Library Function Requires Permission to Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Table 57 Sub-Directory SEC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Table 58 Location of the Ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Table 59 Trust Manager Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Table 60 Examples of Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192


Tables | xix

Table 61 SNC Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Table 62 SNC Parameters for TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Table 63 SNC Parameters for RFC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Table 64 SNC Parameters for TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Table 65 Useful Transaction Codes in the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Table 66 Adapter Services and Associated Activities in the ActiveEnterprise Adapter Palette . . . . . . . . . 218

Table 67 Schemas Used in the Input and Output of Activities for Adapter Services. . . . . . . . . . . . . . . . . . 222

Table 68 RFCCLOSURE Properties for an Inbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Table 69 RFCCLOSURE Properties for an Outbound Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Table 70 RFCCLOSURE Properties Not Applicable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Table 71 Data Mapping between SAP Data Types and Adapter Data Types. . . . . . . . . . . . . . . . . . . . . . . 230

Table 72 Enterprise Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Table 73 Adapter Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Table 74 Adapter Archive - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Table 75 Adapter Services Supported by TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . 278

Table 76 TIBCO Messaging Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Table 77 Description of BAPI Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

Table 78 Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

Table 79 Required Runtime Adapter Properties File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Table 80 Adapter Properties in TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

Table 81 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP. . . . . . . . . . . . . . . . . . . . . . . . . 345

Table 82 Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

Table 83 Debug Messages for Adapter Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Table 84 Error Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Table 85 Info Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Table 86 Warn Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Table 87 Info Messages for Application Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Table 88 Error Messages for Configuration Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Table 89 Debug Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

Table 90 Info Messages for Configuration Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Table 91 Warn Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

Table 92 Debug Messages for Data Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386


xx | Tables

Table 93 Debug Messages for Hawk Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Table 94 Error Messages for Pubication Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Table 95 Error Messages for Request-Response Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Table 96 Error Messages for Request-Response Invocation Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

Table 97 Error Messages for Subscription Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Table 98 Info Messages for System Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Table 99 Error Messages for System Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

Table 100 Warn Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Table 101 Error Messages for DTA Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

Table 102 Info Messages for DTA Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

Table 103 Error Messages for Repository Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Table 104 Error Messages for Schema Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

Table 105 Warn Messages for Schema Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

Table 106 Discontinued Trace Messages of TIBCO ActiveMatrix Adapter for SAP 7.0. . . . . . . . . . . . . . . . . 401

Table 107 Custom Microagent Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Table 108 Removed or Replaced TIBCO Hawk Methods in TIBCO ActiveMatrix Adapter for SAP 7.0. . . . . 442

Table 109 Files of the Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Table 110 Migration Tool Command-Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460


| xxi

Preface

TIBCO ActiveMatrix Adapter for SAP is used as a bi-directional gateway between SAP applications and applications configured for the TIBCO environment.

The adapter can remotely connect and operate with SAP systems running on OS platforms not supported by the adapter.

This document describes how to configure and deploy a TIBCO ActiveMatrix Adapter for SAP. The document is intended for system administrators of networks running TIBCO ActiveMatrix Adapter for SAP software, as well as for system integrators, who plan to integrate a SAP system with another system. The manual assumes familiarity with the basic concepts of TIBCO environment, and the SAP technology.

Topics

• Related Documentation, page xxii

• Typographical Conventions, page xxv

• Connecting with TIBCO Resources, page xxviii


xxii | Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

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

• TIBCO ActiveMatrix Adapter for SAP Concepts Read this manual for terminology and concepts of the product. Before reading other manuals in this documentation set, you need to be familiar with the information in this manual.

• TIBCO ActiveMatrix Adapter for SAP Installation Read this manual for instructions on site preparation and installation.

• TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment Read this manual for instructions on how to create, configure, and deploy adapter projects.

• TIBCO ActiveMatrix Adapter for SAP Examples Read this manual to work through the examples provided with the adapter.

• TIBCO ActiveMatrix Adapter for SAP Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release.

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

Table 1 TIBCO Products

TIBCO Product Description

TIBCO ActiveMatrix® Binding Typefor Adapters

This product is a TIBCO ActiveMatrix binding that integrates TIBCO Adapters with the TIBCO ActiveMatrix environment.

TIBCO ActiveMatrix BusinessWorks™ This product provides an integration platform that enables companies to rapidly integrate systems and automate business processes.


Preface | xxiii

TIBCO ActiveMatrix® Implementation Typefor TIBCO® Adapters

This product provides capabilities to upload and deploy adapter configurations (packaged as EAR files) using TIBCO ActiveMatrix Administrator GUI.

TIBCO ActiveMatrix® Service Bus This product is a lightweight enterprise service bus (ESB) that mediates the communication between applications and services by routing and transforming disparate data formats and transport protocols.

TIBCO ActiveMatrix® Service Grid This product is a scalable and extensible platform for developing, deploying, and managing applications that conform to a service-oriented architecture.

TIBCO® Adapter SDK This product provides a class library that helps developers implement an adapter with minimal effort.

TIBCO Administrator™ This product provides capabilities for managing users, monitoring machines, and deploying and managing applications that use TIBCO products.

TIBCO Business Studio™ This product provides capabilities that help business analysts document business processes, solution engineers implement business processes, and SOA developers create composite applications.

TIBCO Designer™ This product provides a graphical user interface to create TIBCO ActiveMatrix BusinessWorks process definitions, or create or modify TIBCO Adapter configurations.

TIBCO Enterprise Message Service™ This product sends messages from your applications in a format that conforms to the Java Messaging Service (JMS) specification.

TIBCO Hawk® This product is for monitoring and managing distributed applications and systems throughout the enterprise.

TIBCO Rendezvous® This product uses messages to enable distributed application programs to communicate across a wide variety of hardware platforms and programming languages.

TIBCO Runtime Agent™ This product is a bundle of TIBCO software and third-party software that is required to run many TIBCO applications such as TIBCO ActiveMatrix BusinessWorks, TIBCO Adapters, and so on.

Table 1 TIBCO Products (Cont’d)

TIBCO Product Description


xxiv | Related Documentation

Third-Party DocumentationYou may also find it useful to read the documentation on the following websites:

• http://help.sap.com

This website is the SAP Help Portal where you can find documentation on all SAP products, including SAP ECC 6.0 releases and SAP NetWeaver. In order for TIBCO ActiveMatrix Adapter for SAP to exchange data with SAP systems, you must make configuration in the SAP system to allow for communication and the exchange of messages to take place. This website offers detailed information on such configuration required.

• http://service.sap.com/instguides

This website is provided by the SAP Support Portal and contains documentation on installations and upgrades. The documentation available contains information on components that can be used along with TIBCO ActiveMatrix Adapter for SAP, and the installation of the Secure Network Communications (SNC) libraries where security is required between the adapter and SAP systems.

• http://service.sap.com/connectors

This website provides information on the different types of SAP Connectors available. TIBCO ActiveMatrix Adapter for SAP is based on the SAP Java Connector libraries. You can download the latest versions of these libraries from this website. For more information on the SAP JCo libraries and configuration related to these libraries, see the available documentation from this website.

http://service.sap.com/instguides

http://help.sap.com

http://service.sap.com/connectors


Preface | xxv

Typographical Conventions

The following typographical conventions are used in this manual.

Table 2 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. The default value is TIBCO_HOME.

• Directory The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME.

TIB_ADR3_HOME TIBCO ActiveMatrix Adapter for SAP is installed into a directory within a TIBCO_HOME directory. This directory is referenced in documentation as TIB_ADR3_HOME. The default value of TIB_ADR3_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco\adapter\adr3\ReleaseNumber.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process.

bold code font Bold code font is used in the following ways:

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

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

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


xxvi | Typographical Conventions

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO ActiveMatrix Adapter for SAP Concepts.

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

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

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

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

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

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

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

Table 2 General Typographical Conventions (Cont’d)

Convention Use


Preface | xxvii

Table 3 Syntax Typographical Conventions

Convention Use

[ ] An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

| A logical OR that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand param1 | param2 | param3

{ } A logical group of items in a command. Other syntax notations may appear within each logical group.

For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}


xxviii| Connecting with TIBCO Resources

Connecting with TIBCO Resources

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

How to Access TIBCO DocumentationYou can access TIBCO documentation here:

http://docs.tibco.com

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

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

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

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

https://support.tibco.com

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

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

https://support.tibco.com

http://docs.tibco.com

http://www.tibcommunity.com


| 1

Chapter 1 Introduction of Adapter Configuration and Deployment

This chapter gives an overall introduction of how to configure, deploy, manage, and monitor TIBCO ActiveMatrix Adapter for SAP during an adapter life cycle.

See Chapter 3, "Adapter Life Cycle and TIBCO Infrastructure Tools", in TIBCO ActiveMatrix Adapter for SAP Concepts for an introduction to each phase of the life cycle.

Topics

• Configuration and Deployment Overview, page 2

• Features of TIBCO ActiveMatrix Adapter for SAP, page 6


2 | Chapter 1 Introduction of Adapter Configuration and Deployment

Configuration and Deployment Overview

This section describes the high-level steps required to configure, deploy, manage, and monitor an adapter. See subsequent chapters for more details.

• Preparation, page 2

• Configuration, page 2

• Integration, page 5

• Deployment, page 5

• Production, page 5

For basic steps to configure and run the adapter, see Chapter 2, Getting Started, on page 7.

PreparationBefore starting the configuration, install TIBCO ActiveMatrix Adapter for SAP and all required software, and ensure each product is operating correctly. For detailed information about required software and installation of the adapter, see TIBCO ActiveMatrix Adapter for SAP Installation.

Meanwhile, enable the SAP system for messaging with the TIBCO environment by carrying out appropriate configuration. See Chapter 3, Preparing the SAP System, on page 29.

ConfigurationTIBCO Designer provides the design-time environment for configuring a standalone adapter project. Use the TIBCO ActiveMatrix Adapter for SAP palette in TIBCO Designer to create adapter instances, configure adapter services, download schemas from your SAP system, and test the resulting configuration in a project:

• Task A, Define and Save an Adapter Project, page 3

• Task B, Configure an Adapter Instance, page 3

• Task C, Configure an Adapter Service, page 3

• Task D, (Optional) Configure an Adapter Connection, page 4

• Task E, (Optional) Configure a TIDManager Instance, page 4

• Task F, (Optional) Configure Secure Communication, page 4


Configuration and Deployment Overview | 3

• Task G, (Optional) Configure Advanced Options, page 4

• Task H, Test the Adapter Configuration, page 4

See "TIBCO Designer" in TIBCO ActiveMatrix Adapter for SAP Concepts for an introduction of TIBCO Designer.

Task A Define and Save an Adapter Project

When starting TIBCO Designer, you create or select a project. A project contains adapter configuration information, such as the service and messaging transport to use, logging options, and other specific settings.

When configuring the adapter, you can save the associated project at any time. Each time you save a project, any configuration information you have entered is saved to a project.

Open and save a project in multi-file format so that you can manage the files associated with the project by using a version control system.

See Chapter 4, Developing an Adapter Project, on page 57.

Task B Configure an Adapter Instance

An adapter instance in a project contains all information needed by the runtime adapter. By dragging an R3 Adapter Configuration resource from the TIBCO ActiveMatrix Adapter for SAP palette to the Design panel, you create an adapter instance. Each adapter instance must have its corresponding configuration defined, including options for design-time connection, runtime connection, tracing, monitoring, startup, and so on.

See Chapter 5, Configuring an Adapter Instance, on page 71.

Task C Configure an Adapter Service

Adapter services in TIBCO Designer are an abstraction useful for configuration of already existing adapters. By dragging the appropriate services to the Design panel, you add adapter services to the defined instance. A TIBCO ActiveMatrix Adapter for SAP adapter supports various services: Publication Service, Subscription Service, Request-Response Invocation Service, and Request-Response Service. For each service, specify the schema, the transport, and other attributes.

See Chapter 6, Configuring an Adapter Service, on page 99.



Task D (Optional) Configure an Adapter Connection

When you create a TIBCO ActiveMatrix Adapter for SAP instance, connections required by the adapter are created by default. You can however create new connection references, as well as add configure server and client connections.

See Chapter 7, Configuring an Adapter Connection, on page 141.

Task E (Optional) Configure a TIDManager Instance

In TIBCO ActiveMatrix Adapter for SAP 7.0, you only need to configure the TIDManager server when multiple Publication Service configurations (for IDocs) or Request-Response Invocation Service configurations (for tRFCs) use the same program ID and run in a load-balanced fashion.

See Chapter 8, Configuring TIDManager Options, on page 171.

Task F (Optional) Configure Secure Communication

The Secure Network Communications (SNC) component integrates the adapter with SAP systems. With SNC, you strengthen the security between the adapter and the SAP system.

See Chapter 9, Working with Secure Communication, on page 187.

Task G (Optional) Configure Advanced Options

You can perform additional configuration to refine and enhance various adapter operations.

See Chapter 13, Advanced Topics, on page 273.

Task H Test the Adapter Configuration

The adapter tester in TIBCO Designer is a tool that you can use for testing adapters. When invoked, all adapter services configured in the project are displayed. You select the adapter service to test, and start and stop the adapter from the tester. The tester window displays adapter output within the tool so you can easily view results.

See "Testing Your Adapter Using Adapter Tester" in TIBCO Designer Palette Reference for how to use the tool.


Configuration and Deployment Overview | 5

IntegrationIn an integrated enterprise, TIBCO ActiveMatrix BusinessWorks business processes manage the flow of information between different data sources and destinations. A business process receives data from an adapter service and routes data to an adapter service.

The TIBCO ActiveMatrix BusinessWorks design-time plug-in provides the palettes and resources to TIBCO Designer for creating business processes. Using TIBCO Designer, you create your business process using predefined activities and add conditions and mapping as appropriate.

See Chapter 10, Developing a Business Process, on page 215.

DeploymentWhen you are ready to deploy your project, you must generate an Enterprise Archive (EAR) file, which contains the adapter configuration and process definitions you want to deploy. You can use TIBCO Designer to generate the archive, and upload the archive in TIBCO Administrator to deploy the associated application on the machine of your choice.

See Chapter 11, Deploying an Adapter Project, on page 235.

ProductionAfter you deploy your project to an application by using TIBCO Administrator, you can use TIBCO Administrator to start, stop, and perform more management functions with the application. You can use TIBCO Hawk for more monitoring options.

See Chapter 12, Managing and Monitoring an Adapter Project, on page 257.



Features of TIBCO ActiveMatrix Adapter for SAP

The adapter supports the following SAP integration interfaces:

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

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

• ALE/IDoc (Application Link Enabling/Intermediate Documents) — IDocs are document containers for business transactional data, such as sales orders (for example: ORDERS01) and order invoices (for example: INVOIC02). ALE helps achieve 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. It provides the following services:

• Publication Service This service is used to publish IDocs from the SAP system to the TIBCO environment.

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

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

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

TIDManager Service

The TIDManager service prevents duplicate processing of IDocs and tRFCs in case of communication errors that occur when an IDoc or tRFC is executed in the SAP system.



| 7

Chapter 2 Getting Started

This chapter describes the basic steps that are required to configure and run theTIBCO ActiveMatrix Adapter for SAP. Additional details for each of the describedsteps are provided later in the manual.

Topics

• Creating a Project for the Adapter, page 8

• Working with the GettingStarted Sample Project, page 10

• Configuring Sample Project, page 12

• Testing the Configuration, page 16


8 | Chapter 2 Getting Started

Creating a Project for the Adapter

To begin with the configuration process, use TIBCO Designer to open a project.The TIBCO Designer product documentation contains detailed information onusing TIBCO Designer, the following are the general steps getting you throughthe sample project gettingStarted.

1. Start TIBCO Designer, see Figure 1.

— On Microsoft Windows, run TIBCO Designer from the Start menu.

— On UNIX, execute the TIBCO_HOME/bin/designer command fromcommand line.

Figure 1 TIBCO Designer Start Screen


Creating a Project for the Adapter | 9

2. Click the New empty project button as shown in Figure 1 to create a newproject. Proceed to the TIBCO Designer Window, see Figure 2.

Figure 2 TIBCO Designer - Project



Working with the GettingStarted Sample Project

The installed adapter comes with a pre-configured sample projectgettingStarted, which is available in theTIBCO_HOME\adapter\adr3\version_number\examples\gettingStarteddirectory.

This section explores the sample project and presents a configuration overviewfor TIBCO ActiveMatrix Adapter for SAP in TIBCO Designer.

The following Instructions show how to work with TIBCO Designer, savechanges to the sample project and start up the sample adapter configuration.

1. See Creating a Project for the Adapter on page 8 for steps to create a newempty project.

2. In the Save Project dialog and under the Multi-File Project tab, click the Selecta file from the file system button to locate a working directory for thegettingStarted example and select the example file, for example:TIBCO_HOME\adapter\adr3\version_number\examples\gettingStarted\gettingStarted.zip

3. Select one encoding option from the TIBCO Messaging Encoding drop-downlist.

4. Configure the applicable values according to your system setting after youselected value from the Multi-User System drop-down list and click the TestConfiguration button.

5. Click the OK button.

6. Select Project > Import Full Project from the TIBCO Designer menu.

7. In the Import Project dialog, click the ZIP Archive tab.

8. Click the Select a file from the file system button to locate the example:gettingStarted from the location of step 2.


10. Select the Replace existing global variables with those in import andOverwrite on name conflict radio buttons in the Import - Option dialog.

11. In the Global Variables panel, click the Open Advanced Editor button.


Working with the GettingStarted Sample Project | 11

12. In the Global Variables dialog, enter applicable values for the following globalvariables according to your system setting:— AppServer

— Client

— GatewayHost

— GatewayService

— JmsProviderUrl

— JmsSslProviderUrl

— Password

— ProgramID

— SystemNumber

— UserName


14. Click the Save button.

Now you had your gettingStarted example loaded into TIBCO Designer.

For more information on how to set Program ID global variable see CreatingLogical System on page 33.



Configuring Sample Project

A TIBCO ActiveMatrix Adapter for SAP Configuration is recognized by thefollowing icon:

To set up the sample project:

1. Configuring Global Variables, page 12

2. Testing Design-Time Connection, page 13

Four sample configurations are provided:

• Configuring RFC Outbound Instance, page 13

• Configuring RFC Inbound Instance, page 14

• Configuring IDoc Outbound Instance, page 14

• Configuring IDoc Inbound Instance, page 15

Configuring Global VariablesDefine the following Global Variables in the Global Variables panel for bothdesign time and runtime connections:• AppServer

• Client

• GatewayHost

• GatewayService

• JmsProviderUrl

• JmsSsIProviderUrl

• Password

• ProgramID

• SystemNumber

• UserName

For detailed information about each variable, see Appendix B, Predefined GlobalVariables, on page 333.

The gettingStarted sample project works with JMS and Rendezvous transporttype. Make sure EMS server is running before starting the adapter if use JMS astransport type.


Configuring Sample Project | 13

Testing Design-Time ConnectionTo test the design time connection:

1. In the Project panel, click one of the IDocInbound, IDocOutbound,RFCInbound, or RFCOutbound folders.

2. Click the Design-Time Connection tab.

3. Click the Test Connection button to verify the connection parametersspecified.

Configuring RFC Outbound InstanceThe BAPI_CUSTOMER_FINDClient Service is a Request-Response InvocationService that can send out a request for customer details from an SAP system to theTIBCO environment on the message subject of RFC.BAPI_CUSTOMER_FIND.

To configure RFC Outbound instance:

1. Check the RFCOutbound instance configuration:

In the Project panel, click the RFCOutbound instance and check itsconfiguration setting in the Configuration panel.

2. Check the BAPI_CUSTOMER_FINDClient Service configuration:

— In the Project panel, expand RFCOutbound > Adapter Services.

— Click the BAPI_CUSTOMER_FINDClient Service and check itsconfiguration setting in the Configuration panel.

— Click the Advanced tab and in the Message Subject field enterRFC.BAPI_CUSTOMER_FIND.

3. Click the Apply button to save the project. This configuration is now ready fortesting.

For details on testing this configuration, see Testing RFC Loop Back Connectivity,page 17.

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

You can only test design-time connection if the ProgramID for RFC services andIDoc services are different.



Configuring RFC Inbound InstanceThis is a Request-Response Service configuration for theBAPI_CUSTOMER_FINDServer Service which can receive requests for customerdetails from the TIBCO environment on the RFC.BAPI_CUSTOMER_FIND. TheService invokes the RFC in SAP and sends back a reply to the TIBCOenvironment.

To configure RFC Inbound instance:

1. Check the RFCInbound instance configuration:

In the Project panel, click the RFCInbound instance and check itsconfigurations setting in the Configuration panel.

2. Check the BAPI_CUSTOMER_FINDServer Service configuration:

— In the Project panel, expand RFCInbound > Adapter Services.

— Click the BAPI_CUSTOMER_FINDServer Service and check itsconfiguration setting in the Configuration panel.

— Click the Advanced tab and in the Message Subject field, enterRFC.BAPI_CUSTOMER_FIND.


For details on testing this configuration, see Testing RFC Loop Back Connectivityon page 17.

Configuring IDoc Outbound InstanceThis is an IDoc Publication Service configuration for the basic IDoc typeDEBMAS06. This service receives an IDoc from an SAP system and publishes anIDoc to the TIBCO environment with the message subject IDoc.DEBMAS06.

To configure IDoc Outbound instance:

1. Check the IDocOutbound instance configuration:

In the Project panel, click the IDocOutbound instance and check itsconfigurations setting in the Configuration panel.

2. Check the DEBMAS06Publisher configuration:

— In the Project panel, expand RFCOutbound > Adapter Services.

— Click the DEBMAS06Publisher Service and check its configuration settingin the Configuration panel.

— Click the Advanced tab and in the Message Subject field, enterIDoc.DEBMAS06.


Configuring Sample Project | 15


For testing this configuration, see IDoc Publication Test on page 24 and TestingIDoc Loop Back Connectivity on page 24.

Configuring IDoc Inbound InstanceThis is an IDoc Subscription Service configuration for the basic IDoc-typeDEBMAS06. This service receives an IDoc from the TIBCO environment with themessage subject IDoc.DEBMAS06 and posts the IDoc into the SAP system.

To configure an RFC Inbound instance:

1. Check the IDocInbound instance configuration:

In the Project panel, click the IDocInbound instance and check itsconfigurations setting in the Configuration panel.

2. Check the DEBMAS06Subscriber configuration:

— In the Project panel, expand RFCInbound > Adapter Services.

— Click the DEBMAS06Subscriber Service and check its configurationsetting in the Configuration panel.

— Click the Advanced tab and in the Message Subject field, enterIDoc.DEBMAS06.


For testing this configuration, see IDoc Subscription Test on page 26 and TestingIDoc Loop Back Connectivity on page 24.

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



Testing the Configuration

This section explains how to test the sample configuration:

• Starting the TIBCO EMS server, page 16

• Starting the adapter, page 16

• Testing RFC Loop Back Connectivity, page 17

• Testing IDoc Loop Back Connectivity, page 24

• Stopping the Adapter, page 28

Starting the TIBCO EMS serverThe gettingStarted sample project uses JMS as the transport type. Ensure thatthe TIBCO EMS server is running and accessible to the machine on which theadapter is installed before starting the adapter.

See Chapter 5 Running the EMS Server in TIBCO Enterprise Message Service User’sGuide for how to start and stop an EMS Server.

Starting the adapterOnce completed Configuring Sample Project on page 12, you need to export theproject as gettingStarted.dat, a repository file, before you starting the adapter.

1. Go to the TIB_ADR3_HOME\version_number\bin directory and open the defaultlauncher file provided with the installation, adr3.tra. The URL to therepository project tibco.repourl points to the gettingStarted project.

2. All configuration URLs in tibco.configurl are commented. Uncomment therelevant configuration URLs and launch the adapter by typing just theexecutable name adr3 in the console which the executable name comes fromthe bin directory.

For example, to run the sample RFC Outbound configuration, the configurlto be uncommented in the launcher file is/tibco/adapter/adr3/7.0/examples/gettingStarted/gettingStarted.

dat.

See Preparing the SAP System on page 29 on how to preparing the SAP system.


Testing the Configuration | 17

To run the sample RFC Inbound configuration, comment out the aboveconfigurl and uncomment the configurl/tibco/private/adapter/RFCInbound

Ensure that the adapter traces are seen on the console. A confirmationmessage will appear that is similar to the following:2013 Jun 03 14:42:12:062 GMT +0800 R3AdapterConfiguration Info[Adapter] AER3-000082 Successful initialization of Adapter

Testing RFC Loop Back Connectivity

RFC Connection Test

After starting the Outbound adapter, make sure that the SAP system canprincipally communicate with it through the RFC destination that you havedefined.

To test an RFC Connection:

1. Log in to the SAP system.

2. Run transaction SM59.

3. Select RFC Connections > TCP/IP Connections to expand the list ofdestinations.

4. Find your RFC destination in the list and double click the RFC destination tosee more details, for example DOCTEST as shown in Figure 3.

Figure 3 Configuration of RFC Connections - DOCTEST



5. Click the Connection Test button as shown in Figure 4.

Figure 4 RFC Destination DOCTEST

The Communication Type with Target System configuration defined in theMDMP & Unicode tab should be set accordingly based on the database of the SAPsystem. See Figure 5 for an example.



Figure 5 RFC Destination DOCTEST MDMP and Unicode Tab

6. If an SAP error message is displayed, see Figure 6, either the adapter is notrunning or the Program ID does not match that specified in the adapterinstance. In the case of failed connection, reconfigure your system setting andthen repeat this test.



Figure 6 Connection Test DOCTEST Error

7. The following connection test screen, see Figure 7, shows successfulcommunication established between SAP and the adapter for RFCDestination.



Figure 7 Connection Test DOCTEST

RFC Invocation Test

Use the following steps to test RFC Invocation Service:

1. Log on to the SAP GUI.

2. Run transaction SE37 as shown in Figure 8.

Figure 8 Transaction SE37

3. Enter BAPI_CUSTOMER_FIND into the Function module field for the name ofthe RFC function module to be used in the test. See Figure 9 as example, youmay not have this function module in your system so change to a functionmodule available in your system.



Figure 9 Builder: Initial Screen - BAPI_CUSTOMER_FIND

4. Click the Test/Execute button to initiate execution of theBAPI_CUSTOMER_FIND function.

— The Test Function Module: Initial Screen appears, see Figure 10.

— Specify the target system as DOCTEST and then click the DetailsView/Editbutton of SELOPT_TAB.

— RFC target system refers to the RFC destination where the program ID isregistered on the adapter.

Figure 10 Test Function Module: Initial Screen



5. Enter values into the fields, see Figure 11, then click the Single Entry button toinitiate transfer of the RFC message data.

You might not have 0000004130 in your SAP system, thus take the followingvalues as example:

— In the TABNAME field, enter KNA1.

— In the FILEDNAME field, enter KUNNR.

— In the FIELDVALUE field, enter 0000004130.

Figure 11 Structure Editor: Change SELOPT_TAB from Entry

6. Now go back to the Test Function module: Initial Screen to verify the result.

— Click the Execute button to go to the Test Function Module: Result Screen.

— Click the Single Entry button of RESULT_TAB Result to the StructureEditor: Display RESULT_TAB from Entry screen.

— Click the Single Entry button to view the result, see Figure 12.

— Note that 1 RFC entry was transferred.



Figure 12 Structure Editor: Display RESULT_TAB Entry 1 From 1

Testing IDoc Loop Back Connectivity

IDoc Publication Test

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

To test IDoc loop back connectivity:

1. If you have configured the logical message type DEBMAS06 then on the SAPsystem run transaction BD12, see Figure 13.

In order to do the test in this section, the following must be done:

1. Create logical system.

2. Update the ALE Distribution Model to reflect the new logical system and theusage of the DEBMAS IDoc.

3. Update the outbound partner profile for the logical system to reflect DEBMAS.



Figure 13 Transaction BD12

2. Enter the values into the fields as shown in Figure 14.

Figure 14 Enter Send Customers Values

3. Once the Execute button has been clicked, the following two messages appear,see Figure 15.



Figure 15 Information Dialogs

IDoc Subscription Test

1. Close both of the windows from Figure 15, Information Dialogs, on page 26.Go back to the initial window of SAP Easy Access then run transaction WE02,see Figure 16.

Figure 16 Transaction WE02

2. Set the time range for the search. See Figure 17 for example.



Figure 17 IDoc List

3. First verify the Outbound IDocs, sending is successful when the value of thestatus field is 03, see Figure 18.

Figure 18 Outbound IDocs DEBMAS

4. Next verify the Inbound IDocs, reception is successful when the value of thestatus field is 53, see Figure 19. If the test failed, reconfigure your systemsetting then start the test again.



Figure 19 Inbound IDocs DEBMAS

Stopping the AdapterYou can stop the adapter using 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 89 for message subjectdetails. The convention of the subject is%%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit with “now” asthe message content.

Example — To stop an adapter instance called IDocOutbound, available in thegettingStarted.zip, type the following command in 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.


Preparing the SAP System | 29

Chapter 3 Preparing the SAP System

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

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

Topics

• Configuring Design Time, page 30

• Configuring Runtime, page 31

• Configuring the SAP System, page 33


30 | Chapter 3 Preparing the SAP System

Configuring Design Time

The followings are the requirements to configure design time:

• Obtain a valid SAP username and password that allows access to a dedicated SAP application server. Valid username and password are required to extract metadata for BAPIs, RFCs, and IDocs using TIBCO Designer.

• Obtain required authorization from your SAP system administrator to execute RFCs and access tables in SAP for design time username.

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

• IDocs/RFCs/BAPIs specific to a particular language will not be retrieved if you log in to SAP from the SAP GUI or TIBCO Designer with a different language.

• Ensure successful execution of the RFCs in Table 4 via transaction code SE37 in your SAP GUI with the provided test data.

Table 4 Remote Function Calls

Remote Function Call Test Input Data

RFC_GET_TABLE_ENTRIES TABLE_NAME = EDBAST

TABLE_NAME = EDCIM

TABLE_NAME = EDCIMT

EDI_IDoc_SYNTAX_GET PI_IDocTYP = MATMAS01

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

RFC_GET_STRUCTURE_DEFINITION_P TABNAME = E1MARAM

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

RFC_GET_FUNCTION_INTERFACE_P FUNCNAME = <name of any RFC/BAPI>

DDIF_FIELDINFO_GET Run transaction SE37.

This transaction is to get Data Dictionary metadata from the SAP system.


Configuring Runtime | 31

Configuring Runtime

Customization required for runtime interaction with the adapter are described here. The GUI screen shots are taken from SAP ECC 6.0 version.

Additional steps might be required depending on pre-existing maintenance and allocations in the client SAP system. See the help section in the SAP Implementation Guide and other SAP user documentation before customization.

The following topics describe how to enable outbound and inbound messaging.

• Outbound Messaging, page 31

• Inbound Messaging, page 32

Outbound MessagingUse the following options to customizing the system configuration to achieving outbound messaging.

Configuration of Invoking BAPIs/RFCs from the SAP System

1. Define an RFC destination in the SAP system.

An RFC destination should be defined and mapped to a program ID. The outbound adapter is registered on the SAP gateway with this program ID that is specified in the adapter configuration. The outbound adapter receives BAPIs/RFCs invoked on the corresponding RFC destination. An RFC destination allows the SAP system to invoke BAPIs/RFCs in the outbound adapter. For configuration details, see Registering program ID under RFC Destination on page 44.

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

Configuration of Publishing IDocs from the SAP System

You can customize all required SAP ALE outbound configuration via transaction code SALE by following instructions from the SAP Implementation Management Guide.

The following steps are mandatory to enable the transfer IDocs between the SAP system and the TIBCO environment.

1. Create a logical system for the adapter. See Creating Logical System on page 33 for details.



2. Establish the customer distribution model. See Establishing Distribution Model on page 39 for details.

3. Configure RFC communication. See Configuring RFC Communication on page 44 for details.

4. Testing the SAP ALE configuration. See Testing the SAP ALE Configuration on page 55 for details.

Inbound MessagingThis section describes the required minimum configuration in the SAP system to achieve inbound messaging.

Configuration of Invoking BAPIs/RFCs from the TIBCO Environment

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

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

Verify the authorizations by testing of executing the BAPI/RFC via transaction code SE37 in the SAP GUI without specifying a destination.

ALE Customization for Transferring IDocs from the TIBCO Environment

You can customize all required ALE inbound configuration via transaction code SALE by following instructions from the SAP implementation management guide.

The following steps are mandatory to enable the transfer of IDocs from the TIBCO environment into the SAP system.

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

2. Define the customer distribution model. This step defines what IDocs can be transferred in the inbound direction. See Establishing Distribution Model for Inbound Messaging on page 40 for details.

3. Define the partner profile. See Defining Inbound Parameter for Partner Profiles on page 49 for details.


Configuring the SAP System | 33

Configuring the SAP System

The following steps required to customize the SAP ALE system by using the SAP GUI version 6.0.0 to operating with the adapter.

1. Creating Logical System, page 33

2. Establishing Distribution Model, page 39

3. Configuring RFC Communication, page 44

4. Testing the SAP ALE Configuration, page 55

Creating Logical SystemIn the SAP system, each logical system represents a business entity. A unique program ID is assigned explicitly to a logical system. Many logical systems connected to create a distributed environment in an SAP system.

Use the following topics to create logical system.

• Creating a Logical System for an Adapter Instance, page 33

• Creating a Logical System for a Client, page 39

Creating a Logical System for an Adapter Instance

First to create an ALE logical system to representing the adapter publication service.

Use following steps to create a logical system:


2. Run the SALE transaction, see Figure 20.



Figure 20 SALE Transaction

3. Expand IDoc Interface / Application Link Enabling (ALE) > Basic Settings > Logical Systems > Define Logical System, see Figure 21.

Figure 21 Define Logical System

4. Click the IMG - Activity button, the Information dialog displays then click the Click (Enter) button, see Figure 22.



Figure 22 Information Page

5. The Change View “Logical Systems”: Overview page displays, click the New Entries button to create a new logical system, see Figure 23.

Figure 23 Change View “Logical Systems” Page

6. The New Entries: Overview of Added Entries page displays. In the Log System and Name column fields, enter DOCVIEW and Logical System for Documentation respectively, see Figure 24.



Figure 24 New Entries: Overview of Added Entries Page

7. The Change ==> Display dialog displays, click the Yes button to proceed, see Figure 25.

Figure 25 Change ==> Display Dialog

8. The Prompt for Workbench request dialog displays.

— Click the Continue button in the Prompt for Workbench request dialog to proceed if to assign the change request to the change using an existing change request, see Figure 26.



Figure 26 Prompt for Workbench Request Dialog

Then the Display View “Logical Systems”: Overview page displays, scroll down the Logical Systems table to verify newly created DOCVIEW Logical System, see Figure 27.

Figure 27 DOCVIEW Logical System

— If to create a new change request click the Create Request button, shows in Figure 26, then the Create Request page displays, see Figure 28.



Figure 28 Create Request Page

Click the Save (Enter) button to apply new settings. Then click Continue button in Figure 26, Prompt for Workbench Request Dialog, on page 37 to proceed to Display View “Logical Systems”: Overview page to verify newly created Logical Systems - DOCVIEW, see Figure 29.

Figure 29 DOCVIEW Logical System



Creating a Logical System for a Client

After the logical system DOCVIEW is created, you need to create another logical system to representing a client as a business entity, so that the relationship between the client and the other logical systems can be set up.

Process of creating a logical system for a client is the same as Creating a Logical System for an Adapter Instance on page 33. We created a logical system for a client called TESTCLN, see Figure 30.

Figure 30 TESTCLN Logical System

Establishing Distribution ModelA distribution model is to define the ALE message flow between logical systems. Through the unique distribution model, business objects connect to recipients according to rules of varying complexity that are depending on the type of business objects involved.

You need to establish two distribution models, one for the SAP Inbound messaging and another for the SAP Outbound messaging.

Use the following topics to establish the two distribution models:

• Establishing Distribution Model for Inbound Messaging, page 40

• Establishing Distribution Model for Outbound Messaging, page 43



Establishing Distribution Model for Inbound Messaging

Take the following steps to establish the distribution model for inbound messaging:


2. Run the SALE transaction.

3. On the Display IMG page, expand IDoc Interface / Application Link Enabling (ALE) > Modelling and Implementing Business Processes > Maintain Distribution Model and Distribute Views, see Figure 31.

Figure 31 Maintain Distribution Model and Distribute Views

4. Click the IMG - Activity button, see Figure 31, then the Display Distribution Model page displays, click the Switch between the display and edit mode (F9) button to switch to the Change Distribution Mode Edit Mode page, see Figure 32.



Figure 32 Change Distribution Mode Edit Mode

5. From Figure 32, click the Create model view button to create a model view that contains the relationships between logical systems you want to establish.

6. The Create Model View dialog displays and provide value of you choose to the fields in Figure 33.



Figure 33 Create Model View for Inbound Messaging

7. Click the Continue (Enter) button, Figure 33, then proceed to the Display Distribution Model page to verify newly created Distribution Model, DOCVIEW, see Figure 34.

Figure 34 Distribution Model Changed - Model View for Inbound Messaging

8. From Figure 34, click the Add message type button to define type of newly created model view, see Figure 35.

— In the Model View, Sender, Receiver, and Message Type fields, for example, enter DOCVIEW, DOCVIEW, TESTCLN, and DEBMAS respectively.

You can add more Message Type by repeating step 8, for example, enter MATMAS in the Message Type field to create message type of material IDocs.

Figure 35 Add Message Type - Inbound Messaging

9. Click the Continue (Enter) button. Now you established the relationship between the logical systems for SAP inbound messaging.



Establishing Distribution Model for Outbound Messaging

Use the following steps to establish the distribution model for outbound messaging.

1. The starting steps follow step 1 to 5 as Establishing Distribution Model for Inbound Messaging on page 40.

2. The Create Model View dialog displays and provide value of you choose to the fields in Figure 36.

Figure 36 Create Model View for Inbound Messaging

3. Click the Continue (Enter) button, Figure 33, then proceed to the Display Distribution Model page to verify newly created Distribution Model, DOCVIEW1, see Figure 37.

Figure 37 Distribution Model Changed - Model View for Outbound Messaging

4. From Figure 34, click the Add message type button to define type of newly created model view, see Figure 38.

— In the Model View, Sender, Receiver, and Message Type fields, for example, enter DOCVIEW, TESTCLN, DOCVIEW, and DEBMAS respectively.



Figure 38 Add Message Type - Outbound Messaging

5. Click the Continue (Enter) button. Now you established the relationship between the logical systems for SAP outbound messaging.

Configuring RFC CommunicationAn RFC communication combines many RFC programs functioning as either caller or called program. The adapter and the SAP system invokes with those RFC programs to processing events, which the event is defined as a component of an object type.

Use the following topics to configuring RFC Communication.

• Registering program ID under RFC Destination, page 44

• Generating Partner Profile, page 47

• Defining Inbound Parameter for Partner Profiles, page 49

• Defining Outbound Parameter for Partner Profiles, page 53

Registering program ID under RFC Destination

You need to register your program ID in your SAP system under an RFC destination. The RFC destination masks the program ID with a symbolic name to direct events to target system. You need to configure the program ID in both of the SAP system and the adapter.

Use the following steps to register your program ID in SAP.


2. Run the transaction code SM59 to Configuration of RFC Connections page.

3. Expand RFC Connections > TCP/IP connections then click the create button.



4. Enter parameters in the RFC Destination page, see Figure 39.

— Enter a name for the RFC Destination field.

The RFC destination should have the same name of the adapter’s logical system you created. Choose T (TCP/IP connection) as the connection type.

— Select the Registered Sever Program radio button on the Technical Settings tab.

— Enter your program ID in the program ID field.



Figure 39 RFC Destination

5. In your adapter configuring, change the adapter program ID global variable value to the program ID defined in step 4 then start your adapter.


7. Click the Connection Test button. See Figure 40 once valid connection established.



Figure 40 RFC - Connection Test

Generating Partner Profile

Partner profile defines parameters for the electronic interchange of data with a trading partner using the IDoc interface. You must generate a partner profile to communicate with a partner using the IDoc interface.

Use the following steps to generate partner profile.


2. Run the SALE transaction to Display IMG page.

3. Expand IDoc Interface / Application Link Enabling (ALE) > Modelling and Implementing Business Processes > Partner Profiles > Generate Partner Profiles.

4. Enter applicable values on the Generate Partner Profile page, see Figure 41.



Figure 41 Generate Partner Profile

5. Click the Execute button. Proceed to Log for Partner Profiles Generation page, see Figure 42.



Figure 42 Log for Partner Profile Generation

Defining Inbound Parameter for Partner Profiles

Partner profile consists of information about the partners participating in a logical system, this involves defining who can exchange messages with the SAP system and using which port.

Use the following steps to define inbound parameter for partner profile.


2. Run transaction code WE20, see Figure 43.



Figure 43 Partner Profiles

3. Expand Partner > Partner Profiles > Partner Type LS Logical system then click the partner you created, for example DOCVIEW. See Figure 44.



Figure 44 Partner Profiles DOCVIEW



4. Click the Create Inbound parameter button to proceed to the Partner profiles: Inbound parameters page. See Figure 45, for example:

— In the Message type field enter DEBMAS.

— Click the Inbound options tab.

In the Process code field, enter DEB2.

Check the Cancel Processing After Syntax Error checkbox.

Select the Trigger Immediately radio button.

— Click the Post processing permitted agent tab.

In the Ty, Agent, and Lang fields enter applicable values.

— Click the Save button.

Figure 45 Partner Profiles: Inbound Parameters

5. Click the Save button. The inbound parameter for DOCVIEW logical system is defined, see Figure 46.



Figure 46 DOCVIEW Logical System Inbound Parameter

Defining Outbound Parameter for Partner Profiles

Use the following steps to define outbound parameter for partner profile.

1. Following the first three steps of Defining Inbound Parameter for Partner Profiles on page 49.

2. Run transaction code WE20.



3. Click the Create Outbound parameter button to proceed to the Partner profiles: Outbound parameters page. see Figure 47, for example:

— In the Message type field enter DEBMAS.

— Click the Outbound options tab.

In the Receiver port field, enter A000000038. The receiver port is generated in Figure 42, Log for Partner Profile Generation, on page 49.

In the Basic type field enter DEBMAS06.

Check the Cancel Processing After Syntax Error checkbox.

— Click the Save button.



Figure 47 DOCVIEW Logical System Outbound Parameter

Testing the SAP ALE ConfigurationIn the SAP system, run transaction code BD12 to send IDocs to any logical system.

Use the following steps to test the SAP ALE configuration.


2. Run transaction code BD12.

3. Start your adapter, change the adapter program ID coherent to you predefined in Log for Partner Profile Generation on page 49, for example.



4. Enter test value as Figure 48.

Figure 48 Send Customers

5. Click the Execute button.

6. An Information dialog displays, see Figure 49

Figure 49 Send Information Dialog

7. Click the Continue button.

8. An Information dialog displays, see Figure 50

Figure 50 Information Dialog

9. Click the Continue button.

10. Now you successfully sent an IDoc message.


| 57

Chapter 4 Developing an Adapter Project

Projects are the key organizational principle for the configuration information. You can create and manage an adapter project by using TIBCO Designer.

This chapter introduces how to create and manage an adapter project.

See also:

• "TIBCO Designer" in TIBCO ActiveMatrix Adapter for SAP Concepts for a brief overview and important concepts of TIBCO Designer.

• The TIBCO Designer documentation.

Topics

• Adapter Project Structure, page 58

• Starting TIBCO Designer, page 59

• Creating a Project, page 60

• Saving a Project, page 61

• Opening and Reopening a Project, page 62

• Working with Global Variables at Design Time, page 63

• Working with a Revision Control System, page 66


58 | Chapter 4 Developing an Adapter Project

Adapter Project Structure

An adapter project contains the following folders:

• AESchemas Folder This folder is the default location for the schema files of all TIBCO Adapters. When you configure an adapter, TIBCO Designer creates schema resources and places them in the appropriate location in this folder. Each schema file contains a collection of classes, scalars, associations, unions, and sequences.

You need to use the created schemas for data mapping and transformation when developing a business process. See Mapping and Transforming Data on page 220 for detailed information.

• Adapter Services Folder This folder contains the adapter instances you create and adapter services added to the adapter, as well as the configuration you specify for the adapter instances and services.

• Advanced Folder This folder contains resources created by TIBCO Designer when you configure the adapter. For example, each time you add a service to an adapter, a session and endpoint are created and stored in the Advanced folder. Other resources such as advanced logging resources are accessed directly from the folder. Adapter developers typically do not access resources in this folder. Most of the adapter configuration is done by changing resources that are available from the Adapter Services folder.


Starting TIBCO Designer | 59

Starting TIBCO Designer

To start TIBCO Designer:

• Under Microsoft Windows:

From the Start menu, select All Programs > TIBCO > [ENV_NAME >] TIBCO Designer n.n > TIBCO Designer

or

Invoke TIBCO_HOME\designer\n.n\bin\designer in a command prompt.

• Under UNIX:

Invoke ./TIBCO_HOME/designer/n.n/bin/designer in a command console.



Creating a Project

You can create a new project in one of the following ways:

• When you launch TIBCO Designer, the Startup dialog is displayed, as shown in Figure 51. With the Startup dialog, you can create a new project, open an existing project, convert a project from a legacy format, and perform some administrative tasks.

Figure 51 TIBCO Designer Startup Dialog

• Select Project > New Project from the menu in TIBCO Designer main window.

When you create a new project, the Save Project dialog will be displayed. You can choose to input the project information right after creating a project, or save the project later. Follow step 2 in Saving a Project on page 61 to save the project.


Saving a Project | 61

Saving a Project

When you save a project, you can save it as a multi-file project, or under XML Canon.

To save a multi-file project:

1. In the main window, do one of the following:

— Select Project > Save from the menu.

— Select Project > Save As from the menu and specify the storage directory.

— Click the Save icon in TIBCO Designer Toolbar.

2. In the displayed Save Project dialog, click the Multi-File Project tab and provide the following information:

— Project Directory: provide the directory and name of the project.

— TIBCO Message Encoding: select the TIBCO message encoding from the list. Message encodings of ISO8859-1 and UTF-8 are available, but for TIBCO ActiveMatrix Adapter for SAP, you must select UTF-8.

See "Multilingual Support" in TIBCO ActiveMatrix Adapter for SAP Concepts for more information.

Figure 52 shows the Save Project dialog.

Figure 52 Save Project Dialog

3. Click OK.



Opening and Reopening a Project

Different procedures are required to open projects saved in different formats.

See "Project Formats" in Chapter 3, "Adapter Life Cycle and TIBCO Infrastructure Tools" of TIBCO ActiveMatrix Adapter for SAP Concepts for a detailed introduction to each format.

Opening a Multi-File ProjectYou can open a multi-file project in two ways:

• From the Startup dialog when you launch TIBCO Designer.

• Select Project > Open from the menu if TIBCO Designer is already open. TIBCO Designer will create a new window for your project.

Importing a Project Saved as a ZIP ArchiveSelect Project > Import Full Project or Project > Import Resources From File, Folder, URL from the menu in the TIBCO Designer window. In the displayed dialog, provide the appropriate information for the project files and click OK.

Opening a Project under a Revision Control SystemIf you are opening a project under a revision control system, you need to provide the appropriate information for the system you are working with.

Opening a Project Saved as a DAT FileIf you need to open a project saved in a legacy format, you must convert it first. Use the Administration tab in the Startup dialog to convert the DAT file into a multi-file project and then open the multi-file project from TIBCO Designer.

If you create a project using a DAT file, it is possible that not all configurations can be loaded successfully. It is recommended that you use ZIP archives whenever possible.


Working with Global Variables at Design Time | 63

Working with Global Variables at Design Time

Global variables provide an easy way to set defaults for use throughout your project. The variable substitution mechanism can override global variables, predefined in the project repository, in a restricted manner at both design time and runtime.

A number of global variables are predefined in TIBCO Designer and in TIBCO ActiveMatrix Adapter for SAP.

• For the variables predefined in TIBCO ActiveMatrix Adapter for SAP, see Appendix B, Predefined Global Variables, on page 333.

• For the variables predefined in TIBCO Designer, see "Predefined Global Variables" in TIBCO Designer User’s Guide.

This section gives an overview of how to specify and use global variables at design time:

• Specifying Global Variables, page 63

• Using Global Variables, page 65

• Precedence of Global Variables, page 65

See Working with Global Variables at Deployment on page 250 for details of changing and using global variables at runtime.

See also:

• "Variable Substitution" in TIBCO Adapter SDK Programmer’s Guide for the variable substitution mechanism.

• "Working With Global Variables" in TIBCO Designer User’s Guide for specifying global variables at configuration.

Specifying Global VariablesYou can add, specify, and group global variables by using the Global Variables editor in TIBCO Designer.

To display the global variables editor, in the project panel, select the Global Variables tab or drop down, then click the Open Advanced Editor (pencil) icon. If you select a global variable, then click the pencil icon, the editor opens with the variable selected.

Figure 53 shows the global variables editor.



Figure 53 Global Variables Editor

Global Variable Attributes

In the Global Variable editor, you can specify one or more of the following fields for each global variable:

• Name Name for the variable.

• Value Value for the variable, depending on the type you select.

• Deployment Check the Deployment checkbox to make the variable visible and configurable when deploying using TIBCO Administrator. If the checkbox is unchecked, the variable is not visible in TIBCO Administrator.

• Service Check this checkbox, and check the Include All Service Level Global Variables checkbox when generating the EAR file for deployment. Then the variable is configurable at the service level and service instance level for each adapter service at deployment.

See Chapter 11, Deploying an Adapter Project, on page 235 for how to set global variables at deployment.

• Type The field has a drop-down list to select the variable type, String, Integer, Boolean, or Password. If Password is selected, the value you provide is obfuscated in the repository.

Add Variable Group

Add Variable

Delete Variable


Working with Global Variables at Design Time | 65

• Constraint For String and Integer types, provide a range of allowed values. The constraint field for Strings takes an enumeration, for example, one, two, three. The constraint field for Integers takes a range, for example, 1-100. Note that constraints are currently not implemented in TIBCO Administrator.

• Description Provide a description of the variable.

Using Global VariablesTo use the global variable in the fields of a resource in TIBCO Designer, enter the variable name surrounded by %% on both sides. For example, you must enter %%UserName%% in the User Name field to use the UserName global variable.

You can also drag global variables to the fields in the Configuration panel, for example, user name and password fields.

Precedence of Global VariablesYou can also specify global variables in a TRA properties file or on the command line at design time.

A variable value set on the command line overrides the same variable value set in the properties file. Similarly, a variable value set in the properties file overrides the same variable set in TIBCO Designer.



Working with a Revision Control System

TIBCO Designer supports revision control systems, such as Microsoft Visual SourceSafe, Perforce and so on. Different developers can then add resources to the project and lock the parts of the project on which they are working. This section introduces the following topics:

• Working with a Multi-File Format Project, page 66

• Locking an Adapter Configuration, page 66

• Managing Schema Files, page 66

• Copying, Cutting, Pasting, and Moving a Service, page 68

Working with a Multi-File Format ProjectThe multi-file format creates one ActiveEnterprise XML file for each logical object that occurs in the repository instance, such as an adapter instance, a set of related ActiveEnterprise classes, or a TIBCO ActiveMatrix BusinessWorks process, and so on. This kind of project is referred as a multi-file project.

You can check multi-file projects into a version control system, and a project can contain more than one adapter configuration. This allows a number of people to work on the same project at the same time, with different people working on each adapter configuration: a developer can check out the specific file corresponding to an object that needs to be changed, update the file, and check it back in. TIBCO Designer accesses the local synchronized copies of the files on the developer’s hard drive.

Locking an Adapter ConfigurationTIBCO Designer creates a file that you can share and lock for each top-level resource, for example, an adapter configuration. It does not create a file for each resource. As a result, you can lock an adapter instance configuration but cannot lock individual adapter services.

Managing Schema FilesIf you are using a revision control system, you must manually add some configured resources to the revision control system and check in the resources when completing the instance configuration.


Working with a Revision Control System | 67

When you configure an adapter service, the adapter creates a corresponding set of schema files in the AESchemas folder. For TIBCO ActiveMatrix Adapter for SAP, as part of the service configuration, the adapter creates schema files in root/AESchemas/ae/SAPSystemNumber/basic. For example, if you configure a Publication Service or a Subscription Service in an adapter configuration Instance1, the following 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 Service or a Request-Response Service in an adapter configuration Instance1, the following files are created:

project_root/AESchemas/ae/45B/basic/functionModules.aeschemaproject_root/AESchemas/ae/45B/basic/structures.aeschema

The ae.aeschema file under project_root/AESchemas/ae/scalar/ae.aeschema will be modified to update custom scalars if necessary. The R3Connections.adr3Connections file under project_root will be modified to update connections for the instance.

When you save the project and specify a revision control system, the adapter displays a warning dialog that additional files were created and you need to add them to the revision control system. This warning is displayed only when the files are created for the first time. Figure 54 shows the displayed warning dialog.

The warning contains a Go To Resource button that helps in navigating to the resource. Select Multi-User > Add Resources To RCS from the menu to add these files to the revision control system.



Figure 54 Add Files to the Revision Control System Warning Dialog

Copying, Cutting, Pasting, and Moving a ServiceFollow these instructions when you want to copy, cut, paste, or move a service:

• To successfully copy and paste a service from adapter instance1 to instance2, you must check out the adapter configuration and schema files for instance2.

• To successfully cut and paste a service from adapter instance1 to instance2, you must check out the adapter configuration and schema files for both instance1 and instance2.

• To successfully move a service from adapter instance1 to instance2, you must check out the adapter configuration and schema files for both instance1 and instance2.

Regeneration When Moving, Copying and Pasting

Default subjects are not regenerated to reflect the new instance name when you move a service.

When working with the AESchemas folder:

• Structure your project so that each user owns a folder in the AESchemas area.

• Do not keep the AESchemas folder locked. If you do, other users cannot add resources to it, not even to their own folder inside the AESchemas folder.


Working with a Revision Control System | 69

Manually changed certified messaging and certified messaging queue ledger file names are regenerated to defaults when you move, or copy and paste a service to a new instance.

If you move, or copy and paste a service associated with a custom session, the custom session is not moved, or copied and pasted. The session is regenerated as a default session.




| 71

Chapter 5 Configuring an Adapter Instance

An adapter instance in a project contains all configuration information needed by the runtime adapter. This chapter explains how to create and configure an adapter instance in TIBCO Designer by using the TIBCO ActiveMatrix Adapter for SAP palette.

Topics

• Creating an Adapter Instance, page 72

• Configuring an Adapter Instance, page 73

• Changing an Existing Configuration, page 75

• Adapter Configuration Reference, page 76


72 | Chapter 5 Configuring an Adapter Instance

Creating an Adapter Instance

The TIBCO ActiveMatrix Adapter for SAP configuration resource in TIBCO Designer represents a configurable adapter instance. By adding the resource to your project, you create an adapter instance.

When an adapter instance is created, TIBCO Designer automatically creates two folders:

• Adapter Services For storing the service configuration.

• Advanced For storing the corresponding sessions and other objects.

To create an adapter instance:

1. Start TIBCO Designer and open the project you created.

2. In the Project panel, click the top-level project folder.

3. In the Palette panel, drag the R3AdapterConfiguration resource in the TIBCO ActiveMatrix Adapter for SAP palette to the Design panel. This creates an adapter instance named, by default, R3AdapterConfiguration.

Click the adapter instance you created, the configuration options for the instance are displayed in the Configuration panel. Once you have configured and saved the adapter instance, the adapter is ready to run. See Configuring an Adapter Instance on page 73 for configuration details.

As of the 7.0 release, the adapter supports configuration using one TIBCO Designer palette, which supports SAP systems that are either Unicode or Non-Unicode enabled. When configuring a project where multiple R3 Adapter configurations exist, it is recommended that you do not mix configurations where an adapter configuration is referring to a Unicode-enabled SAP system and another configuration is referring to a Non-Unicode-enabled SAP system, because both of these configurations can refer to common SAP schema and the schema is maintained differently based on the SAP system.


Configuring an Adapter Instance | 73

Configuring an Adapter Instance

Each adapter instance must have its corresponding configuration defined. You can configure an inbound instance, outbound instance, or both. The configuration is accessed whenever an adapter project is started.

To configure an adapter instance in TIBCO Designer:

1. Start TIBCO Designer and open the project you created.

2. In the Project panel, select the instance you created.

3. Configure the instance by using the tabs displayed in the Configuration panel:

a. In the Configuration tab, define the adapter instance name, description, and R/3 connection type. To show all configuration tabs, check the Show All Tabs checkbox in this tab. See Configuration Tab on page 76.

b. In the Design-Time Connection tab, define the design-time connection options. Click the Test Connection button to verify the connection parameters specified. Only when the design-time connection is established, are you ready to configure the adapter services. See Design-Time Connection Tab on page 80.

c. In either the Runtime Inbound tab or the Runtime Outbound tab, define the runtime connection options, based on the R/3 connection type you select in step a:

- Inbound See Runtime Inbound Tab on page 83.

- Outbound See Runtime Outbound Tab on page 84.

- Both Configure both Inbound and Outbound connections. See Runtime Inbound Tab on page 83 and Runtime Outbound Tab on page 84.

d. (Optional) In the Adapter Services tab, define TIDManager options for the instance. See Adapter Services Tab on page 86.

e. (Optional) In the General tab, define the termination subject or topic and active connection reference. See General Tab on page 89.

f. (Optional) In the Logging tab, define the logging options. Decide now whether you need to perform advanced logging.

- If the adapter does not use custom roles, use the Logging tab to specify logging information.

- If the adapter uses custom roles, check the Use Advanced Logging checkbox, and use the Log Sinks folder in the Project panel to define your sinks.



See Logging Tab on page 91.

g. (Optional) In the Startup tab, define the startup options. See Startup Tab on page 95.

h. (Optional) In the Monitoring tab, define the monitoring options. See Monitoring Tab on page 95.

4. Save the project.


Changing an Existing Configuration | 75

Changing an Existing Configuration

When making changes, be aware of the following rules:

• It is recommended to back up your project before making major configuration changes. To back up a project, use TIBCO Designer to export the project. The export file can be imported into TIBCO Designer, if necessary. For more information, see TIBCO Designer Palette Reference.

• Deleting an adapter instance deletes all the services included in that configuration.

• When deleting an adapter service, the associated schema is not deleted from the project. In the event the adapter service is added again to the project and the schema has changed in the SAP system, it is important to refresh the schema in the project.



Adapter Configuration Reference

This section is a reference for the information you supply for a TIBCO ActiveMatrix Adapter for SAP in the Configuration panel:

• Configuration Tab, page 76

• Design-Time Connection Tab, page 80

• Runtime Inbound Tab, page 83

• Runtime Outbound Tab, page 84

• Adapter Services Tab, page 86

• General Tab, page 89

• Logging Tab, page 91

• Startup Tab, page 95

• Monitoring Tab, page 95

Configuration TabFigure 55 shows the Configuration tab.

Figure 55 Adapter Instance - Configuration Tab

Many of the configuration options make use of global variables. Use the Global Variables tab in the Project panel to define a global variable. See Working with Global Variables at Design Time on page 63 for details on how to define and use global variables.


Adapter Configuration Reference | 77

Table 5 lists the fields in the Configuration tab.

Table 5 Adapter Instance - Configuration Tab

Name Description

Instance Name Name of the adapter instance. This name corresponds to the adapter instance configuration object stored in the tibco/private area of TIBCO Repository.

Use the default name or replace it with a name of your choice. See Guidelines for Choosing an Instance Name on page 78 for more information.

Description (Optional) Description of the adapter instance.

Version Version of the adapter repository.

When a new adapter instance is created in TIBCO Designer 5.7 or above, the version is set to AE Version 5.3 by default.

Change Version... To change the adapter environment version, click the Change Version... button.

See Figure 56, Adapter Instance - Change Version Window on page 78 and Table 6, Adapter Instance - Change Version Window on page 78.

Message Filter (Optional) Filter that performs manipulations on incoming and outgoing data before sending it on the network or handing it to the target application.

You can write filters by using TIBCO Adapter SDK. See TIBCO Adapter SDK Programmer’s Guide for information about writing a message filter.

Show All Tabs (Optional) Check this checkbox to display additional tabs for configuring advanced options.

This checkbox is unchecked by default. See Guidelines for Showing All Tabs on page 79 for when you need to show all the configuration tabs.



Figure 56 Adapter Instance - Change Version Window

Guidelines for Choosing an Instance Name

• An instance name must use alphanumeric characters. You can use underscore (_) characters, but you cannot use the space character. The entire instance name must be less than 80 characters.

R/3 Connection Type An applicable client or server connection reference will be created in the R/3 connection. See Guidelines for Choosing R/3 Connection Type on page 80.

In the R/3 Connection Type drop-down list, select the type of instance. Possible values are:

• Inbound

• Outbound

• Both

Table 5 Adapter Instance - Configuration Tab (Cont’d)

Name Description

Table 6 Adapter Instance - Change Version Window

Name Description

What Version Do You Want To Change To In the What Version Do You Want To Change To drop-down list, select the adapter environment version of your preference.

Possible values are:

• AE Version 4.0

• AE Version 5.0

• AE Version 5.1

• AE Version 5.2

• AE Version 5.3



• An instance name cannot use global variables.

• An instance name must be unique with respect to other adapter instances for the same adapter in the project. You can use the same instance name to name an adapter instance for a different adapter in the same project. For example, a TIBCO ActiveMatrix Adapter for SAP instance named TEST and a TIBCO ActiveMatrix Adapter for Siebel instance named TEST can coexist in the same project.

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

When you create an adapter instance, the palette automatically creates several resources for it. The names of these resources derive from the name of the instance they belong to. Changing the adapter instance name results in an automatic regeneration of the resources names. If you manually modify any resource name, that particular name will not be automatically regenerated next time you rename the adapter instance. The following resources in the adapter are automatically named when you name the adapter instance:

• Subject name

• CM name

• CMQ name

• Ledger file

• Default client connections

• Default server connections

• Active connection

Guidelines for Showing All Tabs

If any of the following configurations are required, you must check this checkbox:

• Configuring Outbound TID Management to Remote

• Configuring Termination Subject or Topic

• Configuring an adapter instance to a specific ActiveConnection Reference

• Configuring Discovery Agent Plugin

For instructions on setting advanced configuration parameters, see Chapter 13, Advanced Topics, on page 273.



Guidelines for Choosing R/3 Connection Type

Select the type of instance:

• Inbound

If in the What version do you want to change to drop-down list you select Inbound, proceed to enter the Inbound configuration parameters in the Runtime Inbound tab.

• Outbound

If in the What version do you want to change to drop-down list you select Outbound, enter the Outbound configuration parameters in the Runtime Outbound tab.

• Both

Default setting. If in the What version do you want to change to drop-down list you select Both, enter configuration details in both the Runtime Inbound and Runtime Outbound tabs.

The adapter instance type Both is a test adapter instance. It is recommended not to shift between Both to Inbound or Both to Outbound. There is no automatic mechanism to change the adapter services to reflect the change. You need to manually delete the Publication Service if the change was made from Both to Inbound and vice versa.

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

Regardless of the value of type you select from the R/3 Connection Type in the Configuration Panel, a client connection reference and a server connection reference are created whenever you drag a configuration resource into the Design Panel.

For example, in the R/3 Connection Type drop-down list select Outbound upon creation of the adapter configuration, a client connection reference is also created in the R/3 Connection.

Conversely, in the R/3 Connection Type drop-down list select Inbound, a server connection reference is created in addition to the client connection reference.

Design-Time Connection TabFigure 57 shows the Design-Time Connection tab.



Figure 57 Adapter Instance - Design-Time Connection Tab

Table 7 lists the fields in the Design-Time Connection tab.

• Click the Test Connection button to verify the specified connection parameters.

• Click the Apply button to apply the changes before leaving this tab.

Table 7 Adapter Instance - Design-Time Connection Tab

Field Description

Application Server The host name of the SAP system instance.

For example: SAPsvr

System Number The integer specifying the SAP Database instance. For example: 00

Client The integer specifying the SAP client. For example: 853

Username The user name for logging onto the SAP system.

Password The password corresponding to the user name.

Remember Password Check the Remember Password checkbox to store a password in the project repository.

R/3 Logon Language In the R/3 Logon Language drop-down list, select the language to be used when logging in to the SAP system. The selected language is only used at design time.



Test Connection

Click the Test Connection button to verify the connection parameters specified.

• If connectivity is available, a successful message dialog is displayed. See Figure 58 as an example.

Figure 58 Connection Success

• If connectivity is not available, an error message with details of the error is displayed. See Figure 59 as an example.

Figure 59 Connection Failure

Use Design-Time Connection For Runtime Check the Use Design-Time Connection For Runtime checkbox to copy design-time parameters in the Design-Time Connection tab to the parameters in the Runtime Inbound tab.

If the Use Design-Time Connection For Runtime checkbox is checked, the default runtime inbound connection is not allowed for modification. All fields in the Runtime Inbound tab are disabled. To customize values in the default Runtime Inbound connection tab, uncheck the Use Design-Time Connection For Runtime checkbox.

If the SAP system is behind a firewall, then the SAP router string along with the application server name should be mentioned. See Route String Entry for SAP router for more information.

Table 7 Adapter Instance - Design-Time Connection Tab

Field Description



Runtime Inbound TabFigure 60 shows the Runtime Inbound tab.

Figure 60 Adapter Instance - Runtime Inbound Tab

Table 8 lists the fields in the Runtime Inbound tab. Click the Apply button to apply the changes before leaving this tab.

You can configure an Inbound Adapter Instance using the Runtime Inbound tab. TIBCO Designer creates one inbound connection on creating an adapter instance and the inbound connection is of the Dedicated Application Server type.

Table 8 Adapter Instance - Runtime Inbound Tab

Field Description

Application Server The host name of the SAP system instance. For example: SAPsvr

System Number The integer specifying the SAP Database instance. For example: 00

Client The integer specifying the SAP client. For example: 853

Username The user name for logging onto the SAP system.

Password The password corresponding to the user name.

R/3 Logon Language The login language for the SAP system. The selected language is only used at runtime.

R/3 Code Page Choose the character sets used by the SAP system and database. The default value is 1100.



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

You can use the default client connection, which is a Dedicated Application Server connection or choose from one of the available client connections:

— Dedicated Application Server Configuration Reference, page 151

— Load Balancing Configuration Reference, page 153

— Secure Network Connection - SNC Configuration Reference, page 155

Test the connection before you proceed with further configuration.

Inbound Connection Reference

Click the Go To Reference Resource button to configure advance settings for the default connection reference.

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

An adapter instance with multiple inbound connections can have only one default connection. In case of multiple inbound connections, only the default inbound instance configuration is displayed. During creation of adapter services, the default inbound connection is used to configure connections requiring inbound connectivity to the SAP system.

Runtime Outbound TabFigure 61 shows the Runtime Outbound tab.

Figure 61 Adapter Instance - Runtime Outbound Tab



Table 9 lists the fields in the Runtime Outbound tab. Click the Apply button to apply the changes before leaving this tab.

You can configure an Outbound Adapter Instance using the Runtime Outbound tab. This tab is displayed only if you select Outbound or Both as the R/3 Connection Type in the Configuration tab.

The default type or the Secure Network Connection - SNC file type can be used as the default server connection. See Default Server Connection Configuration Reference on page 164 and Secure Network Connection - SNC Configuration Reference, page 180 for details.

Before specifying a server connection reference ensure that the required server connection has been created. See Adding a Server Connection on page 163 for details. During creation of adapter services, the default outbound connection is used to configure connections requiring outbound connectivity to the SAP system.

Outbound Connection Reference

Click the Go to referenced resource button to configure advance settings for the default server connection reference.

An outbound adapter instance can be configured with multiple server connections. For details see Adding a Server Connection on page 163.

Table 9 Adapter Instance - Runtime Outbound Tab

Field Description

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

Gateway Service Specify the SAP gateway service, default value is SAPgw00.

Gateway Host Specify the gateway host name or IP address or router string. If there is no specified machine acting as a gateway host, this is the same as the appserver.

Username Specify a valid name for logging onto the SAP system.

RFC Trace Specify whether the trace is on or off. Possible values are 0 or 1 only.

0 denotes trace is OFF

1 denotes trace is ON

If any other values are entered, an error is displayed. If you do not provide a valid value, then it defaults to the original value. The default value is 0.



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

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

When an Active Connection reference is modified, see Assigning an Active Connection to an Adapter on page 148.

You can only use Adapter Services tab to configure All Publication Services and All Subscription Services.

All Publication Services

Configuration of the All Publication Service depends on the value you choose from the Outbound TID Management drop-down list:

• Outbound TID Management: Local, page 86

• Outbound TID Management: Remote, page 87

Select local TID Management only when one Program ID is using in any server connections defined in the instance. If there are multiple instances sharing the same Program ID they must share the same TID Manager. Else, it is not possible to ensure that data is being sent only once from the SAP system.

Outbound TID Management: Local

Figure 62 shows the Adapter Service tab with Outbound TID Management set to Local.

The Enable Connectionless property is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.



Figure 62 Adapter Instance - Adapter Service Tab, Outbound TID Management: Local

Table 10 lists the fields in the Adapter Service tab, Outbound TID Management: Local. Click the Apply button to apply the changes before leaving this tab.

Outbound TID Management: Remote

Figure 63 shows the Adapter Service tab with Outbound TID Management set to Remote.

Table 10 Adapter Instance - Adapter Service Tab, Outbound TID Management: Local

Field Description

Outbound TID Management The default value is Local.

TID Filename The TID file is used by the TIDManager to maintain state information on the transaction IDs (TID) sent from the SAP system. By default, the name of the TID file is tidFile.tid. See Setting TIDManager General Options on page 180.

Valid Destinations For example: tibrvd. For more information, see Configuring Valid Destinations on page 323.



Figure 63 Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote

Table 11 lists the fields in the Adapter Service tab, Outbound TID Management: Remote. Click the Apply button to apply the changes before leaving this tab.

Table 11 Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote

Field Description

Outbound TID Management TID Management is Remote.

Shutdown all outbound adapter services requiring TID management following timeout exception

Check this checkbox to disable communications to Remote TID Manager when it is unable to communicate from the adapter.

TID Manager Client Retry Count Specify the number of retries from the adapter to the TIDManager server after which the adapter should conclude that the TIDManager is down, default value is 3. See Outbound TIDManagement for usage details for this parameter.

TID Manager Client Retry Interval Specify the time interval in milliseconds between any two ping attempts to the TIDManager server. This setting will take effect once the TIDManager server is unreachable, default value is 30000ms.

TID Manager Client Ensure that the TIDManager client in all the adapter instances matches the TIDManager server in the TIDManager server being used. Also ensure that the subject name of the TIDManager client is configured appropriately and that the client and the TIDManager server are on the same transport.



All Subscription Services

See Figure 63, Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote on page 88 for a sample screen of the All Subscription Services.

Table 12 lists the fields in the Adapter Service tab, All Subscription Services. Click the Apply button to apply the changes before leaving this tab.

General TabIn the General tab, you can configure the following:

• Termination Subject or Topic

• ActiveConnection Reference

• Plugin: Discovery Agent

Figure 64 shows the General tab.

Valid Destinations Enter valid destinations in this field. For example: DOCTEST. The destinations reflect the Receiving Partner Number field on the IDoc control record, which is RVCPRN. See Configuring Valid Destinations on page 323 for details.

When creating a client session manually, under the R3 TIDManager Configuration, you need to make sure that you specify a value into the Invocation Timeout (ms) field that is greater than the default value 0. Otherwise, the messages will not be deleted from the destination.

Table 11 Adapter Instance - Adapter Service Tab, Outbound TID Management: Remote (Cont’d)

Field Description

Table 12 Adapter Instance - Adapter Service Tab, All Subscription Services

Field Description

Valid Destinations The valid destinations of the TID file. For example: DOCTEST. The destinations reflect the Receiving Partner Number field on the IDoc control record, which is RVCPRN. See Configuring Valid Destinations on page 323 for details.

The property Adapter encoding is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.



Figure 64 Adapter Instance - General Tab

Table 13 lists the fields in the General tab. Click the Apply button to apply the changes before leaving this tab.

Table 13 Adapter Instance - General Tab.

Field Description

Termination Subject or Topic As long as a message is sent on the termination subject (if Rendezvous is the transport) or topic (if JMS is the transport) then the adapter would stop. The default value of the termination subject is given next.%%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit

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



Logging TabFigure 65 shows the Logging tab.

ActiveConnections Reference Specify the name of the active connection to be assigned to the adapter. Changing the reference of the active connection used by an adapter instance will change all client and server connections used by the adapter. The facility to change the active reference allows you to use an existing active connection without having to reconfigure 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 server connection reference for the Active Connection. The Active Connection folder is displayed. Select the required connection reference resource from the project. The resource configuration tab displays. Browse to locate the required server or client connection, click Apply and return to the adapter configuration tabs. See Setting up Connection Reference Options on page 147 for details on setting connection references.

Discovery Agent In TIBCO ActiveMatrix Adapter for SAP 7.0, the Discovery Agent can now be configured as a plugin in the adapter. See Chapter 13, Advanced Topics, on page 273 on how to configure the plugin for the Discovery Agent for runtime adapter.

When configuring the Polling Interval field, the value must be greater than the TRA property adr3.maxRetryInterval defined in the outbound adapter instance. If it is not greater than this would prevent the outbound adapter instance from processing any messages received from the Discovery Agent.

Table 13 Adapter Instance - General Tab. (Cont’d)

Field Description



Figure 65 Adapter Instance - Logging Tab.

Table 14 lists the fields in the Logging tab. Click the Apply button to apply the changes before leaving this tab.

Table 14 Adapter Instance - Logging Tab

Field Description

Use Advanced Logging Use this checkbox to choose whether to use customized logging options:

• Unchecked (Default)

• Checked

To add custom log sinks, check this checkbox and configure log sink resources for the adapter instance in the Advanced folder. See Configuring Advanced Logging Options for an Adapter Instance on page 274 for more information.

Log to Standard I/O Use this checkbox to turn on or off sending logging information to the console window when the adapter is started:

• Checked (Default)

• Unchecked

Logging information is displayed when this checkbox is checked.



Log File File to which logging information is written.

The default log file name for the adapter is %%DirTrace%%/%%Deployment%%.%%InstanceId%%.log. The log is written to the logs directory specified by the tibco.clientVar.DirTrace property in the adapter properties file.

The default log file name for the TIDManager is ProjectName.R3TIDManager.log.

If no file name is specified, trace information is not written to a file.

You can use global variables to specify the location of the log file. See Working with Global Variables at Design Time on page 63 for details on how to define and use global variables.

Log Info Messages Use this checkbox to turn on or off sending all messages of type INFO to the specified location(s):


• Unchecked

For when to turn on the option, see Guidelines for Turning on the Log Levels on page 94.

Log Debug Messages Use this checkbox to turn on or off sending all messages of type DEBUG to the specified location(s):

• Checked

• Unchecked (Default)


Log Warning Messages Use this checkbox to turn on or off sending all messages of type WARNING to the specified location(s):


• Unchecked


Table 14 Adapter Instance - Logging Tab (Cont’d)

Field Description



Guidelines for Turning on the Log Levels

The log levels available are Info, Debug, Warning, and Error messages. The logging messages generated depend on the levels you selected. Turning on the level can affect the performance of the adapter. It is recommended that you turn on the required levels only. By default, the Info, Warning, and Error levels are checked. The Debug level is reserved. Do not select this level unless requested by the TIBCO Product Support Group. This option writes much debugging information to the log file and significantly reduces the speed of the adapter.

Figure 66 shows an example of a log file.

Figure 66 Sample Outbound Log File

Log Error Messages Use this checkbox to turn on or off sending all messages or type ERROR to the specified location(s):


• Unchecked


Table 14 Adapter Instance - Logging Tab (Cont’d)

Field Description



Startup TabFigure 67 shows the Startup tab.

Figure 67 Adapter Instance - Startup Tab

Table 15 lists the fields in the Startup tab. Click the Apply button to apply the changes before leaving this tab.

Monitoring TabFigure 68 shows the Monitoring tab.

Table 15 Adapter Instance - Startup Tab

Field Description

Show Startup Banner Defines whether to display a startup banner when the adapter is started. The startup banner displays the runtime adapter version, the infrastructure version on which the adapter is built, and copyright information in the console window when the adapter is started.

• Checked (Default) The banner is displayed

• Unchecked

Metadata Search URL Location where the adapter searches for base schemas. The adapter searches for any schema that has been defined and saved at this location, and that needs to be loaded at startup.

This field is predefined and cannot be changed.



Figure 68 Adapter Instance - Monitoring Tab

Table 16 lists the fields in the Monitoring tab. Click the Apply button to apply the changes before leaving this tab.

See also: Chapter 12, Managing and Monitoring an Adapter Project, page 257.

Table 16 Adapter Instance - Monitoring Tab

Field Description

Enable Standard MicroAgent Turns on or off the standard TIBCO Hawk microagent.

Click the button, to switch the way of configuration between a standard checkbox and text value (true or false) so that you can use a global variable.

Standard MicroAgent Name Name for the standard microagent that will be registered with the TIBCO Hawk system. In most cases, keep the default value. You do not need to specify the InstanceId variable, because it is automatically set at runtime by the runtime adapter.

Standard MicroAgent Timeout (ms) Timeout value for the standard microagent in milliseconds.

The default value is 10000.

Normally you do not need to change this value. However, on machines under extreme stress where method invocations are timing out, you can use this option to increase the timeout value.



Enable Class MicroAgent Turns on or off the instance-specific or class-specific standard TIBCO Hawk microagent.

Click the button, to switch the way of configuration between a standard checkbox and text value (true or false) so that you can use a global variable. By default, the input field is populated with the HawkEnabled global variable.

Warning: Use the global variable only when all instances of the project share the same behavior. If not all instances share the same behavior, you must use the checkbox option.

Class MicroAgent Name Name for the class microagent that will be registered with the TIBCO Hawk system. In most cases, keep the default value. You do not need to specify the InstanceId variable, because it is automatically set at runtime by the runtime adapter.

Class MicroAgent Timeout (ms) Timeout value for the class microagent in milliseconds.

The default value is 10000.

Normally you do not need to change this value. However, on machines under extreme stress where method invocations are timing out, you can use this option to increase the timeout value.

Default Microagent Session TIBCO Rendezvous session to be used by the TIBCO Hawk microagents by default.

This field is disabled and you cannot change it. The session name and the corresponding session are automatically generated by TIBCO Designer.

However, you can modify the session parameters if required by navigating to the Sessions folder under the Advanced folder and modifying the session parameters.

For how to define a TIBCO Hawk session, see (Optional) Defining a TIBCO Hawk Session on page 262.

Table 16 Adapter Instance - Monitoring Tab (Cont’d)

Field Description



R/3 Adapter MicroAgent Name Name for the custom microagent used to configure microagents specific to TIBCO ActiveMatrix Adapter for SAP. The name specified will be displayed in the TIBCO Hawk monitoring console and the methods associated with the microagent are made available.

The default value is SAPAdapterMicroAgent.

R/3 Adapter MicroAgent Type Type of the custom microagent:

• Local (Default)

• Remote

Table 16 Adapter Instance - Monitoring Tab (Cont’d)

Field Description


| 99

Chapter 6 Configuring an Adapter Service

TIBCO ActiveMatrix Adapter for SAP uses adapter services to communicate with SAP systems. You can complete configuration tasks in TIBCO Designer and store configuration information in a project that is later used by the runtime adapter. This chapter explains how to add an adapter service to an adapter instance and configure the service in TIBCO Designer.

Topics

• Adding an Adapter Service, page 100

• Configuring an Adapter Service, page 109

• Transport Specific Options for Adapter Services, page 110

• Publication Service Configuration Reference, page 116

• Subscription Service Configuration Reference, page 125

• Request-Response Invocation Service Configuration Reference, page 132

• Request-Response Service Configuration Reference, page 136


100 | Chapter 6 Configuring an Adapter Service

Adding an Adapter Service

After configuring an adapter instance, you can add one or more adapter services to an instance. You can add a service in two ways, automatically or manually. An adapter service must be associated with an IDoc or RFC/BAPI schema. The procedure to associate the schema with the added service is different for each way. This section introduces the two ways to add a service:

• Adding an Adapter Service Automatically, page 100

• Adding an Adapter Service Manually, page 101

Adding an Adapter Service AutomaticallyTo add an adapter service automatically:P

1. In the Project panel, expand Project_Name > AdapterInstance > Adapter Services. All available services for the adapter are displayed in the Palette panel.

2. In the Configuration panel, specify the schema filter and fetch the schema for the service:

— For Publication Service or Subscription Service Specify the value in the IDoc Filter field and click the Fetch IDocs button to download the list of IDocs according to the filter you provided.

— For Request-Response Invocation Service or Request-Response Service Specify the value in the RFC/BAPI Filter or the RFC/BAPI Group Filter field and click the Fetch RFC/BAPIs button to download the list of RFCs or BAPIs according to the filter you provided.

See Configuration Tab on page 102 for more information on how to specify filters.

TIBCO recommends you to add an adapter service automatically.


Adding an Adapter Service | 101

3. Select the schema and add the service:

— For Publication Service or Subscription Service After you fetched the schemas, an additional tab named IDocs is displayed in the Configuration panel. The IDocs tab contains the list of IDocs available for selection.

Select the IDocs in the IDocs tab and click the Apply button. The IDocs schemas are retrieved from the SAP system and the adapter services associated with the schemas are automatically added.

See IDocs Tab on page 104 for more information.

— For Request-Response Invocation Service or Request-Response Service After you fetched the schemas, the RFC/BAPI tab is displayed in the Configuration panel. The RFC/BAPI tab contains the list of RFCs or BAPIs available for selection.

Select the RFCs or BAPIs in the RFC/BAPI tab and click the Apply button. The RFCs or BAPIs schemas are retrieved from the SAP system and the adapter services associated with the schemas are automatically added.

See RFC/BAPI Tab on page 106 for more information.

Adding an Adapter Service ManuallyTo add an adapter service manually:

1. In the Project panel, select Project_Name > AdapterInstance > Adapter Services. All available services for the adapter are displayed in the Palette panel.

2. Drag the service you want to add from the Palette panel to the Design panel. This step adds a service to the adapter instance you selected.

3. In the Configuration panel, click the Schema tab to specify schema filter for the service:

— For Publication Service or Subscription Service Specify the IDoc Filter field.

— For Request-Response Invocation Service or Request-Response Service Specify the RFC/BAPI Filter field or RFC/BAPI Group Filter field.

See Configuration Tab on page 102 for more information on specifying filters.

4. Specify schema filter for the service:

— For Publication Service or Subscription Service In the Schema tab, click the Select IDoc button. A list of IDocs are displayed in a new window. Choose

It is recommended that you check the Used checkbox only when the IDocs or RFC/BAPI is in use.



an IDoc from the list by checking the Used checkbox for that IDoc and clicking the OK button.

See IDocs Tab on page 104 for more information.

— For Request-Response Service or Request-Response Invocation Service Click the Select RFC/BAPI button. A list of RFCs or BAPIs is displayed in a separate window. Choose an RFC/BAPI from the list by checking the Used checkbox for that RFC/BAPI and clicking the OK button.

See RFC/BAPI Tab on page 106 for more information.

The schema of the selected IDoc, RFC or BAPI is downloaded and displayed in the IDocs or RFC/BAPI tab. The schema details displayed are similar to the display in the SAP system. This service is properly associated with the selected schema now.

Configuration TabFigure 69 shows the Configuration tab.

Figure 69 Adapter Services - Configuration Tab

Table 17 lists the fields in the Configuration tab.

Click the Fetch IDocs button or the Fetch RFC/BAPIs button when adding an adapter service automatically. See Adding an Adapter Service Automatically on page 100.

Click the Apply button to retrieve the list of IDocs or RFC/BAPIs when adding an adapter service manually. See Adding an Adapter Service Manually on page 101.

Table 17 Adapter Services - Configuration Tab

Field Description

IDoc Filter Filter to restrict the number of IDocs returned from the SAP system. The default value is *. The * character can appear only at the beginning or the end of the expression. For example: MAT*



Guidelines for Using RFC/BAPI Filter and Group Filter with Namespace

In the Configuration tab, to download the BAPI/RFC list with a namespace, you can use one of the following options:

• Fetch the entire namespace of the RFC/BAPI or RFC/BAPI Group Filter.

For example: set RFC/BAPI Filter as /* and leave the RFC Group Filter blank and vice versa.

• Fetch the namespace by filtering the RFC/BAPI or RFC/BAPI Group Filter.

For example: set RFC/BAPI Filter as /SAPTRX/* and leave the RFC Group Filter blank and vice versa.

Leave either the RFC/BAPI Filter or RFC/BAPI Group Filter field blank when you click the Fetch RFC/BAPIs button. The default RFC/BAPI or RFC/BAPI Group Filter expression * does not download the entire namespace.

The character / is a reserved character in the TIBCO environment. To support namespaces, 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 runtime, the adapter replaces the __SLASH__ with the / character in all its interactions with the SAP system.

For example: the RFC /tibco/MY_CUSTOM_RFC will be interpreted in the TIBCO environment as __SLASH__tibco__SLASH__MY_CUSTOM_RFC.

RFC/BAPI Filter Filter to restrict the number of RFCs or BAPIs returned from the SAP system. The default value is *. There is no restriction on the usage of *. Values like BAPI*ORDER are allowed.

RFC/BAPI Group Filter Filter to restrict the number of RFCs or BAPIs returned from the SAP system. The filter retrieves the RFCs or BAPIs associated to a particular set of function groups in the SAP system. The default value is *. If the function group is unknown, leave the value of the RFC Group Filter as * and specify a value in the RFC Filter field.

Custom Folder Directory for the downloaded schema. If you want to download the schema to a specific folder, specify a directory to download the schema in this field. If the field is not specified, the schema will be downloaded to a predefined location.

Table 17 Adapter Services - Configuration Tab (Cont’d)

Field Description



This applies to parameters referred to by the BAPI/RFC also.

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

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

Table 18 lists the Operation Type in the IDocs Tab.

The fields displayed depend on the version of SAP release that is currently in use. Two possible scenarios are detailed in this section, which are the Release 4.x?, see Table 19 on page 105, and the Release 3.x?, see Table 20 on page 105.

Figure 70 shows the IDocs tab. The IDocs displayed are retrieved with the Release 4.x? IDocs filter.

Figure 70 Adapter Services - IDocs Tab

You can drag to change sequence of the IDocs tab fields displayed.

Table 18 Adapter Services - IDocs Operation Type in the IDocs Tab

Field Description

Inbound Subscription Service

Outbound Publication Service

Both Publication Service and Subscription Service



Table 19 lists the fields in the IDocs tab when the IDocs are retrieved from a 4.x SAP system.

Table 20 lists the fields in the IDocs tab when the IDocs are retrieved from a 3.x SAP system.

Table 19 Adapter Services - IDocs Tab for a 4.x SAP System

Field Description

Basic Type Name of the basic IDoc type in the SAP system.

Extended Type Name of the extended IDoc type in the SAP system.

Description Description of the IDoc in the SAP system.

Used Check this checkbox to select the IDoc schema to be downloaded and for appropriate adapter services to be created.

Operation Type Values shown depend on the SAP R/3 Connection Type inside the adapter configuration.


• Outbound

• Inbound

• Both

Release 4.x? Check this checkbox to download IDoc schema using 4.x schema. By default, it is enabled.

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

Table 20 Adapter Services - IDocs Tab for a 3.x SAP System

Field Description

IDoc Type Name of the basic or extended IDoc type in the SAP system.

Description Description of the IDoc in the SAP system.

Used Check this checkbox to select the IDoc schema to be downloaded and for appropriate adapter services to be created.



RFC/BAPI TabYou can select the required RFCs or BAPIs, in the RFC/BAPI tab.

Figure 71 shows the RFC/BAPI tab.

Figure 71 Adapter Services - RFC/BAPI Tab

You can drag to change sequence of the RFC/BAPI tab fields displayed.

Table 21 lists the fields in RFC/BAPI Tab.

Operation Type Values shown depend on the SAP R/3 Connection Type inside the adapter configuration


• Outbound

• Inbound

• Both.

TIBCO ActiveMatrix Adapter for SAP 7.0 supports IDocs of port type 3.x. Due to the IDoc name size limitation for IDocs of port type 3.x in the SAP system, IDocs containing a namespace are not applicable. A namespace is identified by a slash character followed by a prefix followed by another slash character.

Table 20 Adapter Services - IDocs Tab for a 3.x SAP System (Cont’d)

Field Description



Table 21 Adapter Services - RFC/BAPI Tab

Field Description

Name Name of the RFC or BAPI. To obtain information on the parameters available in the RFC or BAPI expand the node alongside this field. For field information on these types expand the node alongside the name of the parameter, if the parameter pertains to a structure, denoted by “struct”, or table, denoted by “sequence”.

Type Type of the BAPI.

Direction Direction of the BAPI parameter.


• In The parameter is an Import parameter, the direction is In.

• Out The parameter is an Export parameter, the direction is Out.

• In/Out The parameter is a Table, the direction is In/Out.

Used Check this checkbox to select downloading the RFC/BAPI schema and create appropriate adapter services.

Operation Type Possible values are:

• Inbound

• Outbound

• Both



Invocation Protocol Select the appropriate Invocation Protocol in order to create an adapter service for a particular RFC or BAPI.

Possible invocation types are:

• Request/Reply

• One Way

Request/Reply is for both directions. It is not just for inbound connections to the SAP system. It is also supported for outbound connections from the SAP system as well. You can invoke the BAPI/RFC in the SAP system without waiting for a reply from the system by using Request/Reply invocation protocol.

If you want to have the operation invoked as tRFC or qRFC, you need to download the schema as One Way.

To configure a One-way RFC/BAPI, in the Invocation Protocol drop-down list, select Request/Reply.

Table 21 Adapter Services - RFC/BAPI Tab (Cont’d)

Field Description


Configuring an Adapter Service | 109

Configuring an Adapter Service

Select the adapter service you added from the Adapter Services folder, the configuration options for the service are displayed in the Configuration panel.

You need to specify the following options:

• Transport specific options Two transport types are available for the runtime adapter, namely JMS and Rendezvous. The transport type you select determines transport specific service options you need to configure. See Transport Specific Options for Adapter Services on page 110.

• Service specific options Each service has its specific options. For configuration details, see the corresponding section for the service you want to add:

— Publication Service Configuration Reference, page 116

— Subscription Service Configuration Reference, page 125

— Request-Response Invocation Service Configuration Reference, page 132

— Request-Response Service Configuration Reference, page 136



Transport Specific Options for Adapter Services

Two transport types are available for a runtime adapter, namely JMS and Rendezvous. The transport type you selected determines transport specific service options, such as quality of service, delivery mode, wire format, and so on. Only options that are compatible with the transport type of a service will be available.

This section explains the transport types and the transport specific service configuration options that are common to all services:

• Transport Type, page 110

• Wire Format, page 112

• Delivery Mode (JMS Only), page 112

• Connection Factory Type (JMS Only), page 113

• Quality of Service (Rendezvous only), page 114

Transport TypeAfter selecting the transport type, you can configure the transport specific options:

• Transport Types and Related Configuration Options, page 110

• Secure Transport, page 111

Transport Types and Related Configuration Options

Two transport types are available for the runtime adapter:

• JMS, page 110

• Rendezvous, page 111

JMS

JMS indicates that JMS (Java Messaging Service) transport mode will be used by the service. An adapter service that uses JMS mode can communicate only with the TIBCO Enterprise Message Service server.

If you select this transport type, you need to specify the following options:

• Wire Format The publishing format of the message. See Wire Format on page 112.


Transport Specific Options for Adapter Services | 111

• Delivery Mode The delivery mode for the message. See Delivery Mode (JMS Only) on page 112.

• Connection Factory Type The type of the client connection to the TIBCO Enterprise Message Service server. See Connection Factory Type (JMS Only) on page 113.

For more detailed information, see TIBCO Enterprise Message Service User’s Guide.

Rendezvous

Rendezvous indicates that TIBCO Rendezvous transport mode will be used by the service.

If you select this transport type, you need to specify the following options:

• Wire Format The publishing format of the message. See Wire Format on page 112.

• Quality of Service The quality of service for publishing messages. See Quality of Service (Rendezvous only) on page 114.

For more detailed information, see TIBCO Rendezvous Concepts.

Secure Transport

For the chosen transport, you can specify a trusted store and an identity resource for use in SSL (Secure Sockets Layer) configuration. TIBCO Rendezvous sessions and JMS topics have an SSL configuration field that uses a dialog to perform SSL configuration.

To enable and configure SSL:

1. In the Project panel, select the adapter instance.

2. Select the Advanced > Sessions folder, and then select the TIBCO Rendezvous session or JMS session.

3. Check the Use SSL checkbox in the Configuration panel.

4. Click the Configure SSL button to do further configuration.

See the online help associated with the session dialog or Chapter 5, "Managing Trusted Certificates", in TIBCO Designer User’s Guide for the SSL configuration options.

If the JMS SSL configuration is not specified correctly, a Undefined Gvars tab with the RuntimeCertificatesDirectory global variable will be displayed when you run the adapter tester in TIBCO Designer for the service you configure.



Wire FormatWire Format indicates the format in which messages are to be sent or received. Services must use the same wire format to exchange data.

Three wire formats are available:

• ActiveEnterprise Message (TIBCO Rendezvous only), page 112

• Rendezvous Message (TIBCO Rendezvous only), page 112

• XML Message, page 112

ActiveEnterprise Message (TIBCO Rendezvous only)

ActiveEnterprise Message is an externally-described XML message format supported by TIBCO Adapter SDK. ActiveEnterprise standard wire format provides class information and packing rules for the TIBCO Adapter SDK set of data types. This format allows ActiveEnterprise components to perform extra validation on messages sent or received. Control information for validation is sent in the message. If no control information is included, an exception is returned to the subscriber.

See TIBCO Adapter SDK Programmer’s Guide for details about the control information generated and sent with TIBCO ActiveEnterprise messages.

Rendezvous Message (TIBCO Rendezvous only)

Rendezvous Message is a self-describing message format used by TIBCO Rendezvous applications. Control information for validation is not sent in the message. For Rendezvous wire format, a message of type RVMSG_RVMSG (Rendezvous 5.x) or TIBRVMSG_MSG (Rendezvous 6.x) is always sent. If a publisher sends a simple RVMSG_STRING or TIBRVMSG_STRING, an exception is passed to the subscribing application.

XML Message

XML Message conforms to specifically constructed and fully compliant XML Schema (XSD) based on the existing definition of the ActiveEnterprise schema.

Delivery Mode (JMS Only)For JMS transport, different delivery modes are available for different services:

Services must use the same transport type and wire format to exchange data.



• For Publication Service and Request-Response Invocation Service, page 113

• For Subscription Service and Request-Response Service, page 113

For Publication Service and Request-Response Invocation Service

For a Publication Service or Request-Response Invocation Service, the following delivery modes are supported:

• Persistent The message will be available to a JMS client even if the JMS server goes down.

• Non-persistent The message will not be available to a JMS client if the JMS server goes down.

For Subscription Service and Request-Response Service

For a Subscription Service or Request-Response Service, the Delivery Mode option is available only when the Connection Factory Type is Topic. See Connection Factory Type (JMS Only) on page 113 for details about connection factory types.

The following delivery modes are supported:

• Durable The service is registered with the JMS server. The JMS server holds messages sent to a durable Subscription Service or Request-Response Service until they are consumed by the service. If the service was down and recovered, it will receive the messages that arrived at the JMS server while the service was down.

• Non-durable The service is not registered with the JMS server. The JMS server does not hold messages sent to a non-durable Subscription Service or Request-Response Service. If the service was down and recovered, it will not receive the messages that arrived at the JMS server while the service was down.

See TIBCO Enterprise Message Service User’s Guide for more information about delivery modes.

Connection Factory Type (JMS Only)For JMS transport, two kinds of connection factories are available:

• Topic, page 114

• Queue, page 114



Topic

A message published to a topic is broadcast to one or more subscribers. All messages published to the topic are received by all services that have subscribed to the topic. This messaging model is known as publish-subscribe.

Queue

A message sent to a queue is consumed by one and only one receiver. Each message has only one receiver, though multiple receivers may connect to the queue. The first receiver to access the queue gets the message. The other receivers do not. This messaging model is known as point-to-point.

See TIBCO Enterprise Message Service User’s Guide for more information about connection factories.

Quality of Service (Rendezvous only)For Rendezvous transport, three kinds of Quality of Service are available:

• Certified, page 114

• Reliable, page 114

• Distributed Queue (Subscription Service and Request-Response Service only), page 115

Certified

Certified Message Delivery guarantees that every certified message reaches its intended recipient in the order sent. A message can be sent across network boundaries, and if a network fails, delivery attempts continue until delivery succeeds or until the time limit of the message expires. This is often called guaranteed delivery. When this Quality of Service is chosen, an RVCM session will be used.

Reliable

Reliable Message Delivery ensures that each multicast or broadcast message is received as long as the physical network and packet recipients are working. It also ensures that the loss of a message is detected.

Reliable Message Delivery can compensate for brief network failures, because it can retransmit a message on request if the first attempt fails. This option is appropriate when message delivery is expected but some loss can be tolerated. When this Quality of Service is chosen, an RV session will be used.



Distributed Queue (Subscription Service and Request-Response Service only)

Distributed Queue delivers a message to one of many service listeners (workers). It contains features of both Certified Messaging and Fault Tolerance.

See TIBCO Rendezvous Concepts for more information about the types of Quality of Service available in TIBCO Rendezvous.



Publication Service Configuration Reference

A Publication Service is used to publish an IDoc from an SAP system as a TIBCO Rendezvous message or TIBCO Enterprise Message Service message.

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

You can configure Publication Service parameters under the following tabs:


• Schema Tab, page 122

• Advanced Tab, page 122

Configuration TabThis is the standard configuration. You can specify Publication Service configuration options by using the Configuration tab.

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

Two groups of settings are applicable to the Configuration tab, depending on which transport type you choose:

• Transport Type: JMS, page 116

• Transport Type: Rendezvous, page 118

Transport Type: JMS

Figure 72 shows the Publication Service Configuration tab for JMS transport.


Publication Service Configuration Reference | 117

Figure 72 Publication Service - Configuration Tab - Transport Type: JMS

Table 22 lists the fields in the Configuration tab for JMS transport.

Table 22 Publication Service - Configuration Tab - Transport Type: JMS

Field Values Description

Name Default:

PublicationService

Name of the Publication Service.

Transport Type JMS Type of the message transport used by the service.

See JMS on page 110 for details.

Wire Format XML Message Format in which messages are sent.

For integrating two SAP systems, the wire format and transport type for both the publisher and subscriber must be the same, otherwise an error will occur.

See Wire Format on page 112 for details.

Publish Mode • explode

• none

• exploded batch

Appropriate publication mode.

See Identifying Publication Mode on page 119 for details.

Delivery Mode • Non-Persistent

• Persistent

Delivery mode for the message.

See Delivery Mode (JMS Only) on page 112 for details.



Transport Type: Rendezvous

Figure 73 shows the Publication Service Configuration tab for Rendezvous transport.

Figure 73 Publication Service - Configuration Tab - Transport Type: Rendezvous

Table 23 lists the fields in the Configuration tab for Rendezvous transport.

Connection Factory Type • Queue

• Topic

Client connection type to the TIBCO Enterprise Message Service server.

See Connection Factory Type (JMS Only) on page 113 for details.

Table 22 Publication Service - Configuration Tab - Transport Type: JMS (Cont’d)


Table 23 Publication Service - Configuration Tab - Transport Type: Rendezvous


Name Default:

PublicationService

Name of the Publication Service.

Transport Type Rendezvous Type of the message transport used by the service.

See Rendezvous on page 111 for details.

Wire Format • ActiveEnterprise Message

• Rendezvous Message

• XML Message

Format in which messages are sent.





Identifying Publication Mode

You can configure the publish mode by selecting values from the Publish Mode list. The following section describes each available mode in detail:

• None Mode, page 119

• Explode Mode (Default), page 120

• Exploded Batch Mode, page 121

None Mode

In the default interface mode, IDoc output from an SAP system is processed in the native RFC table format. This compressed (unexploded) form uses metadata to describe an IDoc. The IDoc data is most efficiently transmitted in this format, because no additional processing is required to expand the IDoc segments and fields. For best performance the decompression (exploding) step is left for the stage when the data is actually consumed.

IDocs of SAP System Releases 3.x and 4.x (port types 3 and 4) are supported. SAP 4.x releases are also capable of sending IDocs in a format understandable by older releases, 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)

Publish Mode • explode

• none

• exploded batch

Appropriate publication mode.


Quality of Service • Reliable

• Certified

Type of Quality of Service to use for publishing messages.

See Quality of Service (Rendezvous only) on page 114 for details.

Table 23 Publication Service - Configuration Tab - Transport Type: Rendezvous (Cont’d)




Figure 74 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.

Figure 74 IDoc in Native RFC Table Format

Examples of 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>

• 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>

Explode Mode (Default)

IDocs are initially received in compressed form as RFC tables. The received IDoc is expanded and serialized into a hierarchical ActiveEnterprise message structure, namely the ActiveEnterprise Message format, using IDoc metadata. Figure 75, IDoc in Uncompressed “Exploded” Format, on page 121 shows an 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 in the TIBCO Adapter SDK Concepts manual.

If multiple SAP JCos are received in a batch, then each IDoc in the batch is split from the other IDocs and sent individually.

The SAP system sends out data to the adapter with padded blanks wherever a field in the IDoc segment does not occupy the complete field length or a field is not populated at all.

By default, the adapter trims off the trailing spaces from blank padded fields, and cuts out blanks-only fields.

Figure 75 IDoc in Uncompressed “Exploded” Format

Exploded Batch Mode

Using Exploded Batch mode, the adapter sends a batch of IDocs in Explode mode. Similarly on the subscriber side, the adapter receives the IDocs in a batch and processes them in SAP.

The data published for a particular IDoc segment field is based on the actual data sent by the SAP system. The adapter does not pad the value provided by the SAP system with trailing whitespace.



If the ALE outbound profile for an IDoc type is set up to Collect IDocs, IDocs are collected within the SAP system till the packet size value is reached, and then sent to the adapter in one time.

Exploded Batch mode ensures that individual IDocs are “exploded” to a self-describing format and also maintained as a batch. The batch of exploded IDocs is then published as one single message by the adapter.

Schema TabFigure 76 shows the Publication Service Schema tab.

Figure 76 Publication Service - Schema Tab

Advanced TabFigure 77 shows the Publication Service Advanced tab.

The data published for a particular IDoc segment field is based on the actual data sent by the SAP system. The adapter does not pad the value provided by the SAP system with trailing whitespace.



Figure 77 Publication Service - Advanced Tab

Table 24 lists the fields in the Advanced tab.

Table 24 Publication Service - Advanced Tab

Field Description

Message Subject

(Rendezvous transport only)

Subject name to use by default when publishing.

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

Destination

(JMS transport only)

Name on which the service publishes to a topic or sends messages to a queue if you are setting advanced options for a Publication Service.

Endpoint Reference Endpoint to be used by the Publication Service.

Class Reference Class referenced in this Publication Service.

Log IDoc: Destination Destination of the IDoc logging file. The outbound IDoc can be sent to a Rendezvous or JMS endpoint or written to a file.


• Log to file

• Publish message

Log IDoc: Format Format of the IDoc logging file.

When writing to a file, the possible values are:

• None

• XML



Log IDoc: Log IDoc to Directory Directory to log IDoc files. If no value is entered for this property that the IDoc would either be logged to the current working directory of the adapter or the directory specified in the TRA property of adr3.idocLogDirectory.

Table 24 Publication Service - Advanced Tab (Cont’d)

Field Description


Subscription Service Configuration Reference | 125

Subscription Service Configuration Reference

A Subscription Service is used to receive IDocs from the TIBCO environment and then send it to the SAP system. A separate Subscription Service is required for every IDoc to be sent to the SAP system.

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 the IDoc will not be used.

You can configure Subscription Service parameters under the following tabs:




Configuration TabYou can specify Subscription Service configuration options by using the Configuration tab.

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




Transport Type: JMS

Figure 78 shows the Subscription Service Configuration tab for JMS transport.



Figure 78 Subscription Service - Configuration Tab - Transport Type: JMS

Table 25 lists the fields in Subscription Service Configuration tab for JMS transport.

Table 25 Subscription Service - Configuration Tab - Transport Type: JMS


Name Default:

SubscriptionService

Name of the Subscription Service.






Receive IDocs In Exploded Batch Mode

• On

• Off

Check this checkbox to receive IDocs in exploded batch mode.


Delivery Mode

(Topic connection factory only)

• Non-Durable

• Durable






Figure 79 shows the Subscription Service Configuration tab for Rendezvous transport.

Figure 79 Subscription Service - Configuration Tab - Transport Type: Rendezvous

Table 26 lists the fields in the Subscription Service Configuration tab for Rendezvous transport.


• Topic



Table 25 Subscription Service - Configuration Tab - Transport Type: JMS (Cont’d)


Table 26 Subscription Service - Configuration Tab - Transport Type: Rendezvous


Name Default:

SubscriptionService

Name of the Subscription Service.





Schema TabFigure 80 shows the Subscription Service Schema tab.

Wire Format • ActiveEnterprise Message

• Rendezvous Message

• XML Message

Format in which messages are sent.



Receive IDocs in Exploded Batch Mode

• On

• Off

Check this checkbox to receive IDocs in exploded batch mode.



• Certified

• Distributed Queue



For an IDoc being received as TIBCO Rendezvous 5.x message, the wire format must be Rendezvous Message.

Table 26 Subscription Service - Configuration Tab - Transport Type: Rendezvous (Cont’d)




Figure 80 Subscription Service - Schema Tab

Advanced TabFigure 81, Subscription Service - Advanced Tab, on page 129 shows the Subscription Service Advanced tab.

Figure 81 Subscription Service - Advanced Tab




Table 27 Subscription Service - Advanced Tab

Field Description

Message Subject




Destination


Name on which the service publishes to a topic or sends messages to a queue if you are setting advanced options for a Subscription Service.

Endpoint Reference Endpoint to be used by the Subscription Service.

Class Reference Class referenced in this Subscription Service.

Log IDoc: Destination Destination of the IDoc logging file. The outbound IDoc can be sent to a Rendezvous or JMS endpoint or written to a file.


• Log to file

• Publish message

Log IDoc: Format Format of the IDoc logging file.

When writing to a file, the possible values are:

• None

• XML (Default value)

Log IDoc: Log IDoc to Directory

Directory to log IDoc files. If no value is entered for this property that the IDoc would either be logged to the current working directory of the adapter or the directory specified in the TRA property of adr3.idocLogDirectory.

Client Connection Reference Appropriate client connection reference. The default directory is the client connection directory for that instance. You can point to a different client connection by clicking the Browse Resource button to locate the client connection reference.

Thread Count Must be a number and cannot be less than 1, which is the default. You can explicitly specify the number of dispatcher threads for the service in the Thread Count field.

Thread Count support Global Variables.



qRFC Queue Name You can specify the inbound IDoc as qRFC by using this field. If left blank then inbound IDoc would be tRFC. The Subscription adapter service can either configured using tRFC or qRFC, but not both.

For a Subscription Service, only one adapter service per schema can be configured. If qRFC and tRFC are both required, you need to create two adapter instances.

Table 27 Subscription Service - Advanced Tab (Cont’d)

Field Description



Request-Response Invocation Service Configuration Reference

A Request-Response Invocation Service is used to invoke an outbound RFC or BAPI from the SAP system to the adapter. A separate Request-Response Invocation Service is required for every RFC or BAPI to be invoked.

You can configure parameters under the following tabs:




Configuration TabUse the Configuration tab to specify transport type, Quality of Service and invocation protocol to use for the Request-Response Invocation Service.

You can choose one of the following sets of configuration which is depending on your choice of transport type.



Transport Type: JMS

Figure 82 shows the Request-Response Invocation Service Configuration tab for JMS transport.

Figure 82 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS


Request-Response Invocation Service Configuration Reference | 133


Table 28 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS


Name Default:

Request-ResponseInvocationService

Name of the Request-Response Invocation Service.






Delivery Mode • Non-Persistent

• Persistent




• Topic






Figure 83 shows the Request-Response Invocation Service Configuration tab for Rendezvous transport.

Figure 83 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous

Table 29 lists the fields in the Configuration tab for Rendezvous transport.

Table 29 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous


Name Default:

Request-ResponseInvocationService

Name of the Request-Response Invocation Service.



Wire Format ActiveEnterprise Message Format in which messages are sent.




• Certified




Request-Response Invocation Service Configuration Reference | 135

Schema TabFigure 84 shows the Request-Response Invocation Service Schema tab.

Figure 84 Request-Response Invocation Service - Schema Tab

Advanced TabFigure 85 shows the Request-Response Invocation Service Advanced tab.

Figure 85 Request-Response Invocation Service - Advanced Tab - Transport Type Rendezvous


Table 30 Request-Response Invocation Service - Advanced Tab - Transport Type: Rendezvous

Field Description

Message Subject




Destination


Name on which the service publishes to a topic or sends messages to a queue if you are setting advanced options for a Request-Response Invocation Service.

Endpoint Reference Endpoint to be used by the Request-Response Invocation Service.

Class Reference Class referenced in this Request-Response Invocation Service.



Request-Response Service Configuration Reference

A Request-Response Service is used to invoke an inbound RFC or BAPI, in the SAP system, from the adapter. A separate Request-Response Service is required for every RFC or BAPI.

You can configure parameters under the following tabs:




Configuration TabUse the Configuration tab to specify transport type, Quality of Service and invocation protocol to use for the Request-Response service.




Transport Type: JMS

Figure 86 shows the Request-Response Service Configuration tab for JMS transport.

Figure 86 Request-Response Service - Configuration Tab - Transport Type: JMS


Request-Response Service Configuration Reference | 137



Figure 87 shows the Request-Response Service Configuration tab for Rendezvous transport.

Table 31 Request-Response Service - Configuration Tab - Transport Type: JMS


Name Default:

Request-ResponseService

Name of the Request-Response Service.






Delivery Mode

(Topic connection factory only)

• Non-Durable

• Durable




• Topic





Figure 87 Request-Response Service - Configuration Tab - Transport Type: Rendezvous

Table 32 lists the fields in the configuration tab for Rendezvous transport.

Table 32 Request-Response Service - Configuration Tab - Transport Type: Rendezvous


Name Default:

Request-ResponseService

Name of the Request-Response Service.



Wire Format ActiveEnterprise Message Format in which messages are sent.




• Certified

• Distributed Queue




Request-Response Service Configuration Reference | 139

Schema TabFigure 88 shows the Request-Response Service Schema tab.

Figure 88 Request-Response Service - Schema Tab

Advanced TabFigure 89 shows the Request-Response Service Advanced tab.

Figure 89 Request-Response Service - Advanced Tab - Transport Type: Rendezvous

If you invoke the service by using Request/Reply invocation protocol, you must set the Quality of Service as Reliable. If you invoke the service by using One Way invocation protocol, you must set the Quality of Service as Certified. If the adapter instance is Load-Balance with other similarly configured inbound instances, you must set the Quality of Service as Distributed Queue.

If the SAP system expects a response from the adapter, you must set the invocation protocol as Request/Reply. If no reply is expected, set the invocation protocol as One Way.

In the case of Oneway, the schema used by the Request-Response server should not have any OUT parameters since receiving a reply is not applicable.




Table 33 Request-Response Service - Advanced Tab - Transport Type: Rendezvous

Field Description

Message Subject




Destination


Name on which the service publishes to a topic or sends messages to a queue if you are setting advanced options for a Request-Response Service.

Endpoint Reference Endpoint to be used by the Request-Response Service.

Note: In the case of Oneway RFCs, if there is an error when invoking SAP then the original message sent can be forwarded to a Rendezvous or JMS endpoint by using the Endpoint Reference property.

Class Reference Class referenced in this Request-Response Service.

Log Rfc: Endpoint Reference The endpoint to be used by log Rfc. The transport type should be either JMS or RV.

Client Connection Reference Appropriate client connection reference. The default directory is the client connection directory for that instance. You can point to a different client connection by clicking the Browse Resource button to locate the client connection reference.

Thread Count Must be a number and cannot be less than 1, which is the default. You can explicitly specify the number of dispatcher threads for the service in the Thread Count field.

The Logon Required, Commit Required, and Commit Expiry properties are removed from TIBCO ActiveMatrix Adapter for SAP 7.0.

For a Request-Response Service using invocation protocol One Way, if the LogRfc: Endpoint Reference is not configured and an exception is returned by the SAP system, the contents of the requested message is saved to a file and the format of the filename is NameOfRFC/BAPI.YYYYMMDDHHMMSSsss.rfc.


| 141

Chapter 7 Configuring an Adapter Connection

This chapter describes advanced connection configuration options available in the TIBCO Designer adapter palette so that you can refine and enhance various adapter operations.

Topics

• Adapter Connection Configuration Overview, page 142

• Adding Connections to an Adapter, page 143

• Adding an Active Connection, page 145

• Adding a Connection Reference, page 147

• Adding a Client Connection, page 150

• Setting Client Connection Advanced Options, page 158

• Adding a Server Connection, page 163

• Setting Server Connection Advanced Options, page 169


142 | Chapter 7 Configuring an Adapter Connection

Adapter Connection Configuration Overview

You can configure adapter connections in the following two ways:

• Adding an Adapter Service Automatically, page 100

• Adding an Adapter Service Manually, page 101

You can however create new connection references, add and configure server and client connections. You can also maintain advanced client and server configuration options.

Based on the adapter R/3 Connection Type of your choice, you have the connection services created for you as shown in Table 34:

Table 34 Connection Service Setting

R/3 Connection Type Connection Pool Created

Inbound Client Connection Pool

Outbound Server Connection Pool

Both Client Connection Pool

Server Connection Pool


Adding Connections to an Adapter | 143

Adding Connections to an Adapter

You can modify the default connections or create additional connections to suit your requirements. When you create an adapter instance, a basic set of connections are created depending on whether the adapter instance is Inbound, Outbound, or Both. In the same project, adapter instances for inbound, outbound, and both connections are sharing these connections.

Table 35 lists the default connection types for Inbound and Outbound adapter instances.

When creating an adapter instance, if no other adapter instance exists, an R3Connections folder is created under the project folder.

Figure 90 lists the hierarchy of the R3Connections folder.

Table 35 Adapter Connection - Connection Type

Connection Type Default Names

Client Connection R3AdapterConfigurationInboundConnection

Server Connection R3AdapterConfigurationOutboundConnection

Clients R3AdapterConfigurationInboundConnectionClient0

ActiveConnections clientConnectionReference

serverConnectionReference

R3AdapterConfiguration is the default name if it was the first SAP configuration in the Designer project.

The complete hierarchy can not be modified in any way. This includes the top R3Connection folder and any of the contents inside.



Figure 90 Adapter Connection - R3 Connections Folder Hierarchy

Table 36 lists the description of every folder under the R3Connection folder.

You can carry out the following connection configuration:

• Adding an Active Connection, page 145

• Adding a Connection Reference, page 147

• Adding a Client Connection, page 150

• Setting Client Connection Advanced Options, page 158

• Adding a Server Connection, page 163

• Setting Server Connection Advanced Options, page 169

The following sections describe each of these connection configurations in detail.

Table 36 Adapter Connection - R3 Connection Folder

Folder Name Description

ClientConnections All clients share client connection information. In this case, clients are SAP clients. A ClientConnections folder contains individual client connection information. A default client connection is created when an adapter instance is created.

ServerConnections The SAP server shares server connection information. A default server connection is created when an adapter instance is created.

Client The SAP client information. A default client is created when an adapter instance is created.

R3AdapterConfigurationActiveConnections For connection reference information indicating the default active server or client connection. Default connection references to a client connection and a server connection are also created by default.


Adding an Active Connection | 145

Adding an Active Connection

You can use the ActiveConnections resource available from the Palette panel to configure all connections maintained inside an adapter instance.

When you configure an adapter instance, an active connection instance is created by default with reference to one client connection and one server connection. If the default configuration does not meet your requirements, you can modify the existing active connection instance or create a new one and provide an appropriate reference to the active connection instance.

For details on associating an adapter instance with an active connection reference, see Assigning an Active Connection to an Adapter on page 148.

Setting up Active Connection Configuration OptionsFigure 91 shows the ActiveConnections dialog.

Figure 91 Adapter Connection - ActiveConnections Configuration

Use the following steps to add and configure an active connection.

1. Click the R3Connections folder in the Project panel. Drag an ActiveConnections icon from the Palette panel to the Design panel.

2. Specify the options list in Table 37 in the Configuration tab.

Even though a client connection or server connection may be created it won’t be used unless there is a connection reference tied to that client or server connection.

Table 37 Adapter Connection - ActiveConnections Configuration

Name Description

Name Unique name for the active connection. The default active connection name is ActiveConnections. You can change it to a name of your choice.

Description Brief description for this active connection.



3. Click the Apply button.

After creating an active connection instance, the next step is to tie references from the active connection to the required client or server connections. See Adding a Connection Reference on page 147.


Adding a Connection Reference | 147

Adding a Connection Reference

You can use a connection reference to associate a particular client or server connection inside an active connection. On creating an adapter instance, two default connection references are created. One points to the client connection created by default on creating the adapter instance and the second points to the server connection created by default on creating the adapter instance. If you are maintaining multiple client or server connections then you must specify one of each type as the default.

You can configure connection reference parameters using the Configuration within the Connection Reference options.

Setting up Connection Reference OptionsDefault connection references are automatically created when you configure an adapter instance. If additional connection references are required, use the following steps to create them.

Figure 92 shows the ConnectionReference dialog.

Figure 92 Adapter Connection - ConnectionReference Configuration

Create client connections and server connections prior to creating connection references. See Adding a Client Connection on page 150 and Adding a Server Connection on page 163 for details.

Table 38 Adapter Connection - ConnectionReference Configuration

Name Description

Name A unique name for the connection reference. The default name is ConnectionReference, you can change this to a name of your choice.



Use the following steps to set up the connection reference.

1. Click the ActiveConnections folder in the Design panel.

2. Drag a ConnectionReference icon from the Palette panel to the Design panel. The Configuration displays.

3. Specify the options list in Table 38 in the Configuration tab.


5. To view or modify the client connection or server connection parameters, click the Go to referenced resources button.

Assigning an Active Connection to an AdapterA default active connection instance is created when an adapter instance is created. By default, a reference point to the active connection is also created in the adapter instance.

Referenced Connection Referenced client or server connection of the ActiveConnection. Click the Browse Resources button to view information for the specific client or server connection.

See Adding a Client Connection on page 150 and Adding a Server Connection on page 163 for details on configuring client and server connection parameters.

Default Connection Check the Default Connection checkbox as the default client or server connection for the associated adapter instance.

If multiple client or server connections are referred, only one connection per type can be set as default for that particular type.

This is only applicable to the client connection. If you create an inbound adapter service, it uses the default client connection as the client connection reference.

Table 38 Adapter Connection - ConnectionReference Configuration

Name Description

In case of multiple clientConnectionReferences are set up in the R3AdapterConfigurationActiveConnection folder.

If you changed the default clientConnectionReferences to manually created clientConnectionReference, once you reopen your project the default clientConnectionReferences will be reset to the one prior you made the change.


Adding a Connection Reference | 149

If you require a different active connection, you must set up an appropriate reference in the adapter instance.

Figure 93 shows the R3AdapterConfiguration dialog.

Figure 93 Adapter Connection - R3AdapterConfiguration

Use the following steps to associate an adapter instance with an active connection reference:

1. Click the R3AdapterConfiguration folder in the Project panel.

2. Click the General in the Configuration panel only if the Show All s checkbox is checked in the Configuration.

3. Click the Browse resources button associates the Active Connection Reference field.

4. Select the required active connection from the Select a Resource Window. Click OK then Apply button.

It is recommended that you associate one instance with one active connection.



Adding a Client Connection

The adapter supports one or more client connection pools where a client connection pool is referenced by one or more inbound adapter services.

Client Connection Types OverviewThe following are the supported types of client connection pools available through the TIBCO Designer project.

• Dedicated Application Server Configuration Reference, page 151

• Load Balancing Configuration Reference, page 153

• Secure Network Connection - SNC Configuration Reference, page 155

A client connection of the Dedicated Application Server type is created by default when you configure an Inbound adapter instance. You can add client connections as per your configuration needs, choosing from the three types available.

Additional client connections are required in cases where an adapter instance must connect to multiple SAP application servers or clients. Each application server or client has its own client connection.

Selecting Client Connection TypeFigure 94 shows the Select ClientConnection Type drop-down list.

The adapter uses the SAP JCo libraries and each client connection pool can contain 1 to 99 connections.

When set ClientConnection’s maxConnections to 0, the adapter can startup without throwing errors.

In case of you renamed the ClientConnection, if you want the Project_Name > R3Connections > Clients > ClientConnectionClient0 corresponding with the ClientConnection’s name then you need to rename it.


Adding a Client Connection | 151

Figure 94 Adapter Connection - Select ClientConnection Type

Use the following steps to select the required ClientConnection Type.

1. Expand R3Connections > ClientConnections folder in the Project panel.

2. Drag a ClientConnection icon from the Palette panel to the Design panel.

3. In the Configuration, select one of the following ClientConnection types in the Select ClientConnection Type drop-down list:

— Dedicated Application Server Configuration Reference, page 151

— Load Balancing Configuration Reference, page 153


4. Click the Apply button. A client connection is automatically created in the ClientConnection folder.

Dedicated Application Server Configuration ReferenceUse the following options to configure Dedicated Application Server ClientConnection parameters.

• Run-Time Inbound, page 151

• Advanced, page 153

Run-Time Inbound

Figure 95 shows the Dedicated Application Server Run-Time Inbound.

The ClientConnection Type of Saprfc.ini file is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.



Figure 95 Adapter Connection - Dedicated Application Server Runtime Inbound

Table 39 lists Dedicated Application Server runtime inbound parameters.

Table 39 Dedicated Application Server Runtime Inbound Parameters

Name Description

Application Server The network name of the host SAP application server machine.

System Number The SAP system number.

Client The SAP client number.

User Name The valid username that logs into the specified SAP client.

Password The valid password corresponding to the username.

R/3 Logon Language The language used to log in to the SAP system. The selected language is only used during design time.


The R/3 Code page should only be populated if needed and in certain cases.

Test Connection Click the Test Connection button to test the connection of your configuration.



For every client connection pool, the adapter would do a test connection in order to validate the configuration. If the connection is valid then an error would be shown on the adapter log during startup. When the first attempt is made to use the pool then the adapter would try to connect several times based on what has been supplied in the Advanced tab. Depending on the configuration supplied, the services tied to the pool would be suspended or the adapter would stop.

Advanced

See Setting Client Connection Advanced Options on page 158 for configuration details.

Load Balancing Configuration ReferenceUse the following s to configure Load Balancing ClientConnection parameters.



Run-Time Inbound

Figure 96 shows the Load Balancing Run-Time Inbound.

Figure 96 Adapter Connection - Load Balancing Runtime Inbound



Table 40 lists Load Balancing runtime inbound parameters.

In order to validate each client connection pool configured in the adapter, an automatic check is performed and a connection is observed following the adapter’s start up.

The client connection pool is only validated at the time it is used by the inbound adapter service. If the client connection pool is found to be invalid then the pool is disabled or the adapter is stopped.

Table 40 Load Balancing Runtime Inbound Parameters

Name Description

System Name The SAP/R3 system ID used in conjunction with load balancing. For example, to use load balancing, the client machine initiating the request must have a service named SAPmsXXX defined on the system, where XXX is the value of systemName. The default service value is 3600/tcp, and can be changed.

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 Load Balancing. For example, PUBLIC

In the SAP system, names of Logon Groups are case sensitive.

Stagger the start time for adapter instances when starting multiple adapter instances using the same SAP Logon group.


User Name The valid username that logs into the SAP client.

Password The valid password corresponding to the username.

R/3 Logon Language The language used to log in to the SAP system. The selected language is only used during design time.






Advanced


Secure Network Connection - SNC Configuration ReferenceUse the following s to configure SNC parameters.



Run-Time Inbound

Figure 97 shows the SNC Run-Time Inbound.

Figure 97 Adapter Connection - SNC Runtime Inbound

Table 41 lists SNC runtime inbound parameters.

Table 41 SNC Runtime Inbound Parameters

Name Description

Application Server The network name of the host SAP application server machine.

System Number The SAP database instance number.



SNC Mode • 0 Do not apply SNC to connections

• 1 Apply SNC to connections

SNC Partnername • 1 Apply authentication only

• 2 Apply integrity protection (authentication)

• 3 Apply privacy protection (integrity and authentication)

• 8 Apply the default protection

• 9 Apply the maximum protection

SNC QOP <own_snc_name>

SNC Lib Path and file name of the library.


User Name The valid username logs in to the specified SAP client.

Password The valid password corresponds to the username.

R/3 Logon Language

The language logs in to the SAP system. The selected language is only used during design time.

R/3 Code Page Choose the character sets used by SAP and database. The default value is 1100. The R/3 Code page should only be populated if needed and in certain cases.


For more information on SNC parameters, see Working with Secure Communication on page 187 for more details or go to the documentation website of SAP.

When test connection using SNC as client connection type to the SAP system, you may receive a sucessful confirmation even though the connection parameters are incorrect. This only occurs when the connection parameters are made incorrect following a successful test connection within the same TIBCO Designer session. You can close the project and reopen the project prior to testing the connection.


Name Description



In order to validate each client connection pool configured in the adapter, an automatic check is performed and a connection is observed following the adapter’s start up.

The client connection pool is only validated at the time it is used by the inbound adapter service. If the client connection pool is found to be invalid then the pool is disabled or the adapter is stopped.

Advanced




Setting Client Connection Advanced Options

The advanced parameters are identical for Dedicated Application Server, Load Balancing, and SNC client connections.

Figure 98 shows the Advanced tab of Client Connection.

Figure 98 Client Connection - Advanced Tab

Table 42 lists the Advanced parameters.

The property Number of Reconnect Attempts before Suspending Service and Is Unicode are removed from TIBCO ActiveMatrix Adapter for SAP 7.0.

Table 42 Client Connection Advanced Options

Name Description

Maximum number of Reconnect Attempts The maximum number of times the 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 Reconnect Attempts Before Suspending Impacted Service(s). For reconnect to continue forever, set the value to -1.

Interval Between Reconnect Attempts (milliseconds)

The time interval between two successive reconnections in milliseconds. The default value is 30000ms.


Setting Client Connection Advanced Options | 159

Setting up Clients Configuration OptionsA Client is automatically created as a result of the client connection configuration process. There are two ways to modify a Client Connection configuration.

— Adding a Client Connection on page 150

— Configuring Client on page 160

However, advanced client configuration must be configured directly under the Advanced of Client configuration.

Use the following s to configure client parameters:

• Client - Configuration on page 160

• Client - Advanced on page 161

Adapter Termination Criteria (after max number of reconnect attempts)

This field is relevant for Inbound configurations connected to multiple SAP systems. This field is not relevant for Outbound configurations.

Possible values are:• When All Pools Are Suspended

• When Any Pool Is Suspended

The default setting is When All Pools Are Suspended.

The logic is still valid even if there is only one client connection pool. If there is only one and it is set to “When All Pools Are Suspended“ then the adapter stops.

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.

Disable Connection Pooling Check this checkbox if you do not require connection pooling to the SAP system. If this checkbox is checked, connection pooling to the SAP system is disabled, client connections to the SAP system remain open when they are used or if idled after certain time and the connection would be closed automatically after the call to SAP is completed.

Table 42 Client Connection Advanced Options

Name Description



Configuring Client

Client - Configuration

Figure 99 shows the Client - Configuration.

Figure 99 Client - Configuration

Use the following steps to configure the SAP Clients:

1. Expand the R3Connections > Clients folder in the Project panel.

2. Select the according service, for example: R3AdapterConfigurationInboundConnectionClient0.

3. Define the parameters in Table 43 in the Configuration tab.

Table 43 Client - Configuration

Name Description

Name The name derived from the client connection instance associated with 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 username to log in to the SAP client specified.

Password Specify a valid password corresponding to the username.

R/3 Logon Language Select the language to be used when logging in to the SAP system.


Setting Client Connection Advanced Options | 161

Client - Advanced

You can specify the tracing and debugging parameters for an SAP client using advanced options. This option can be used to carry out debugging of RFCs from the SAP GUI.

It is recommended that you install the SAP GUI on the same machine as the adapter.

Figure 100 shows the Client - Advanced.

Figure 100 Client - Advanced


If other values are entered, an error message appears. If a valid value is not provided, the original value is used.



Table 43 Client - Configuration

Name Description

Table 44 Client - Advanced

Name Description Significance

RFC Trace Indicate whether the trace is on. Possible values are 0 or 1. By default, set to 0.

• 0 Corresponding trace is turned OFF

• 1 Corresponding trace or debug is turned ON

Use SAPGUI Indicate whether the trace or debug is on. Possible values are 0, 1, or 2. Default value is 0.

• 0 SAPGUI is not started

• 1 SAPGUI is started

• 2 SAPGUI is started and hidden until used by an invocation of an RFC.



The trace files are generated in the working directory of the adapter. This is set in the adr3.tra file using the parameter application.start.dir=C:/Tibco/adapter/adr3/version_number.

When attaching SAPGUI to the client connection, verify that the information documented in SAP OSS note 1258724 is valid for your SAP system. If the information mentioned is not available in your SAP system then the adapter would generated an error message during startup.

The property ABAP_Debug is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.


Adding a Server Connection | 163

Adding a Server Connection

The adapter supports one or more server connection pools where a server connection pool points to a distinct combination of Program ID, Gateway Host, and Gateway Server. All server connection pools reference all of the outbound adapter services, that is, associating a specific server connection pool to an outbound adapter service is not allowed.

Server Connection Types OverviewThe following are the supported types of server connection pools available through the TIBCO Designer Project.

• Default Server Connection Configuration Reference, page 164

• Secure Network Connection - SNC Configuration Reference, page 166

Server connection pools are also created using the adapter TRA file by configuring the properties specific to the Discovery Agent.

A server connection pool can contain one or more connections where the default is one connection and the default type is created automatically when you configure an outbound adapter instance. You can add server connections as per your requirements, choosing from the two types available.

Selecting Server Connection TypeFigure 101 shows the Select ServerConnection Type drop-down list.

When set ServerConnection’s maxConnections to 0, the adapter will throw errors when startup.

Multiple server connections are required in those cases where an outbound adapter instance needs to connect to multiple Gateway Host servers or connect to SAP system using multiple Program IDs. See Multiple Connections, page 303 for details on multiple Program IDs.



Figure 101 Adapter Connection - Select ServerConnection Type

Use the following steps to select the required client connection type.

1. Expand R3Connections > ServerConnections folder in the Project panel.

2. Drag a ServerConnection icon from the Palette panel to the Design panel.

3. In the Configuration, select one of the following server connection types in the Select ServerConnection Type drop-down list:

— Default Server Connection Configuration Reference, page 164


4. Click the Apply button. A server connection is automatically created in the ServerConnection folder

Default Server Connection Configuration ReferenceUse the following options to configure Default ServerConnection parameters.

• Run-Time Outbound, page 164


Run-Time Outbound

Figure 102 shows the Default Server Connection Run-Time Inbound.

The ServerConnection Type of Saprfc.ini file is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.



Figure 102 Adapter Connection - Default Server Connection Runtime Inbound

Table 45 lists Default ServerConnection runtime inbound parameters.

The adapter supports automatic retries for server connection pools in the event there is an issue connecting to the SAP system. If the number of retries has been exhausted, the server connection pool is suspended or the adapter is stopped.

Advanced

See Setting Server Connection Advanced Options on page 169 for configuration details.

Table 45 Default Server Connection Runtime Inbound Parameters

Name Description

Program ID A valid existing program ID defined in the RFC destination inside the SAP system, SM59. The program ID identifies the RFC server program for the SAP system. For details on configuring multiple program IDs see Multiple Connections on page 303.

Gateway Service The SAP gateway service. The default value is SAPgw00.

Gateway Host The Gateway Host name, IP address, or router string. If there is 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 1 only. 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 a valid value, then it defaults to 0.



Secure Network Connection - SNC Configuration ReferenceUse the following s to configure SNC parameters.

• Run-Time Outbound, page 166


Run-Time Outbound

Figure 103 shows the SNC Run-Time Inbound.

Figure 103 Adapter Connection - SNC Runtime Inbound

Table 46 lists SNC runtime inbound parameters.

When configuring a Server Connection Service, if you provided with an incorrect Program ID then there will no error messages generated after the adapter started. The validation process is based on the combination of Gateway Host and Gateway Service.


Name Description Values

Program ID A valid existing program ID defined in the RFC destination inside the SAP system, SM59. The program ID identifies the RFC server program for the SAP system. For details on configuring multiple program IDs see Multiple Connections on page 303.

N/A



Gateway Service The SAP gateway service. The default value is SAPgw00.

N/A

Gateway Host The Gateway Host name, IP address or router string. If there is no machine acting as a gateway host, it is the same as the application server.

N/A

SNC Mode SNC activation indicator. • 0 Do not apply SNC to connections

• 1 Apply SNC to connections

SNC QOP Quality of Protection (security level). • 1 Apply authentication only

• 2 Apply integrity protection (authentication)

• 3 Apply privacy protection (integrity and authentication)

• 8 Apply the default protection

• 9 Apply the maximum protection

SNC Myname Initiator’s SNC name. <own_snc_name>

SNC Lib External security product’s library. Path and file name of the library

RFC Trace Indicate whether the trace is on or off. Possible values are 0 or 1 only. By default the value is 0.

If any other values are entered, an error is displayed. If you do not provide a valid value, then it defaults to 0.

• 0 trace is turned OFF

• 1 trace is turned ON

For more information on SNC parameters, see Working with Secure Communication on page 187 for details or go to the documentation website of SAP.

Table 46 SNC Runtime Inbound Parameters (Cont’d)




The adapter supports automatic retries for server connection pools in the event there is an issue connecting to the SAP system. If the number of retries has been exhausted, the server connection pool is suspended or the adapter is stopped. The suspension of server connection pool is based on the maximum retry interval maintained in seconds.

Advanced

See Setting Server Connection Advanced Options on page 169 for configuration details.

When you set the RFC Trace to 0 which means you disabled the RFC Trace. You may still experience that the CPIC Trace file is created unexpectedly. The creation of the CPIC Trace file would still occur depending on the settings of the SAP system.


Setting Server Connection Advanced Options | 169

Setting Server Connection Advanced Options

The advanced parameters are identical for Default Server Connection and SNC.

Figure 104 shows the Advanced tab of Server Connection.

Figure 104 Server Connection - Advanced Tab


The Maximum Number of Reconnect Attempt property is removed from TIBCO ActiveMatrix Adapter for SAP 7.0.

Table 47 Server Connection Advanced Options

Name Description

Maximum time between two startup attempts in case of failures (secs)

The maximum time interval the adapter will retry to connect to the Gateway Host. Once this interval is reached the server connection pool would be suspended. By default, it is set to 60 seconds and connection attempt will be retried at the following time:

— First startup at 1st seond

— Seond startup at 2nd second

— Third startup at 4th second

— Fourth startup at 8th second

— Fifth startup at 16th second

— Sixth startup at 30th second

— Seventh startup at 60 second

After the seventh startup, the adapter will either suspends the server connection pool or stops the adapter.



Adapter Termination Criteria (after max number of reconnect attempts)

This field is relevant for Inbound configurations connected to multiple SAP systems. This field is not relevant for Outbound configurations.

Possible values are:• When All Pools Are Suspended

• When Any Pool Is Suspended

The default setting is When All Pools Are Suspended.

The logic is still valid even if there is only one server connection pool. If there is only one and it is set to “When All Pools Are Suspended“ then the adapter stops.

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.

Even though RFC trace is turned off when you set the RFC trace to 0 in the adapter configuration, the trace file could still be generated due to the setting defined in the RFC destination in the SAP system or parameters defined on the SAP Gateway.

Table 47 Server Connection Advanced Options

Name Description


| 171

Chapter 8 Configuring TIDManager Options

Topics

• Introduction of TIDManager Configuration, page 172

• Setting TIDManager Configuration Options, page 175

• Setting TIDManager Logging Options, page 177

• Setting TIDManager Startup Options, page 178

• Setting TIDManager Monitoring Options, page 179

• Setting TIDManager General Options, page 180

• Setting TIDManager for Fault Tolerance, page 185


172 | Chapter 8 Configuring TIDManager Options

Introduction of TIDManager Configuration

The Transaction Identification Manager (TIDManager) is used to ensure exactly-once delivery for transactions that are exchanged between the SAP system and the outbound adapter. The TIDManager component ensures that no transactional data is duplicated in case of communication errors between the adapter and the SAP system.


Outbound configurations sharing the same program ID must refer to the same remote TIDManager server configuration.

If more than one TIDManager is maintained for the same Program ID, the adapter cannot be guaranteed exactly-once delivery from SAP.

Interactions between the Adapter and the TIDManager Server ConfigurationAfter the adapter is set for remote TIDManagement mode, the adapter invokes the TIDManagement operations on the remote TIDManager server in the TIBCO environment. The adapter and the TIDManager server can interact on TIBCO Rendezvous, which is the default setting, or JMS transports.

The TIDManager server maintains the status of each Transaction Identifier (TID) associated with a transaction been executed by the adapter. The TIDManager server creates and maintains a local file system of a TID file that maintains the TID status.

Ensure that the TID_RPC_CLIENT service under the R3AdapterConfiguration > Advanced > Sessions > TIDManagerSession folder in the Project panel is correctly configured the Configuration tab settings for each adapter instance. See Adapter Services Tab on page 86 for details on setting RPC client reference.

The TID_RPC_Client subject field should match the TID_RPC_SERVER subject field in Configuration tab. See General Tab on page 89.


Introduction of TIDManager Configuration | 173

Recovering from Network Outages and TIDManager Server DowntimesWhen an adapter is configured for remote TIDManagement, the TIDManager server must be up and running to perform TIDManagement operations. The adapter cannot process any transaction if it is unable to communicate with the TIDManager server. Thus availability of the TIDManager server is critical for remote TIDManagement.

Outbound TIDManagement

In case of the remote TIDManagement for outbound configuration, if the TIDManager server is not running or not reachable because of network outages, the adapter throws the following errors upon receiving a transaction from the SAP system:2013 Feb 13 10:07:52:633 GMT +8 R3AdapterConfiguration Error [Adapter] AER3-000102 TID operation timed out DCE70E186AA951AEB09B24E8.

2013 Feb 13 10:08:12:432 GMT +8 R3AdapterConfiguration Warn [Adapter] AER3-970276 Server Exception:Gateway Host: 220.231.14.24 Gateway Service: sapgw00 Program ID: ZTest Error Message : check TID fault: Remote TIDManager timeout

2013 Feb 13 10:10:22:531 GMT +8 R3AdapterConfiguration Info [Adapter] AER3-000265 Creating a Server connection

2013 Feb 13 10:13:15:213 GMT +8 R3AdapterConfiguration Info [Adapter] AER3-000166 Connection State: Available

The transaction itself is not lost and is maintained in the SAP system's tRFC queue. The SAP system will periodically try to push out the transactions and clear the queue. If communication to the TIDManager server is restored, normal processing continues.

Use the following tabs to configure the TIDManager instance:

Setting TIDManager Configuration Options, page 175

Setting TIDManager Logging Options, page 177

Setting TIDManager Startup Options, page 178

Setting TIDManager Monitoring Options, page 179

Transactions maintained in the tRFC queue will be retried as long as they are configured for the corresponding RFC Destination and the transaction has not been retried manually. If the transaction is retried manually and there is still an issue with connecting to the outbound adapter then the transaction will no longer be retried by the SAP system.

In 7.0 release, an option was added to the configuration of the outbound adapter instance where you can suspend communications between the outbound adapter and the remote TID Manager.



Setting TIDManager General Options, page 180

If you want to set TIDManager for Fault Tolerance, see Setting TIDManager for Fault Tolerance on page 185 for more information.


Setting TIDManager Configuration Options | 175

Setting TIDManager Configuration Options

Figure 105 shows the Configuration tab.

Figure 105 R3TIDManager Configuration Tab

To configure a TIDManager instance:

1. Drag an R3TIDManagerConfiguration icon from the Palette panel to the Design panel.

2. Specify the parameters, Table 48, in the Configuration tab.


Change Version

Figure 106 shows the Change Version window.

Table 48 R3TIDManager Configuration Tab

Name Description

Instance Name Assign a unique name to the TIDManager instance. By default the name is R3TIDManagerConfiguration. You can change it to a name of your choice.

Version Display the adapter runtime environment version.

Change Version See Change Version on page 175 for details.

Show All Tabs Check this checkbox to access the General tab. See Setting TIDManager Monitoring Options on page 179 for details on setting monitoring options.



Figure 106 R3TIDManager Configuration Tab Change Version Window

You can change the adapter runtime environment version by clicking the Change Version button.

1. Click the Change Version button. A new Change Version window pops out.

2. Select an AE Version from the What version do you want to change to? drop-down list, see Table 49 for more details.

3. Click either the OK or Cancel button to confirm or exit your selection.

Table 49 R3TIDManager Configuration Tab Change Version Window

Name Description

What version do you want to change to? Adapter runtime versions you can select from.

Available version:• AE Version 4.0 (default version)

• AE Version 5.0

• AE Version 5.1

• AE Version 5.2


Setting TIDManager Logging Options | 177

Setting TIDManager Logging Options

You can configure logging preferences and information in the Logging tab.

Figure 107 shows the Logging tab.

Figure 107 R3TIDManger Logging Tab

TIDManager logging options are identical to those of an adapter instance. For instructions on setting logging options see Logging Tab on page 91.



Setting TIDManager Startup Options

You can configure startup options in the Startup tab.

Figure 108 shows the Startup tab.

Figure 108 R3TIDManager Startup Tab

TIDManager startup options are identical to those of an adapter instance. For instructions on setting startup options see Startup Tab on page 95 for details.


Setting TIDManager Monitoring Options | 179

Setting TIDManager Monitoring Options

You can configure monitoring options in the Monitoring tab.

Figure 109 shows the Monitoring tab.

Figure 109 R3TIDManger Monitoring Tab

TIDManager monitoring options are identical to those of an adapter instance. For instructions on setting monitoring options see Monitoring Tab on page 95



Setting TIDManager General Options

Figure 110 shows the General tab.

Figure 110 R3TIDManager General Tab

Table 50 R3TIDManager General Tab

Name Description

TID Manager Server The reference of the TIDManager server.

TID Filename A unique TID filename. The TID file is used by the TIDManager to maintain state information on the transaction IDs (TID) sent from the SAP system. By default, the name of the TID file is tidFile.tid.

It is recommended that you use the name of the TIDManager instance as part of the filename.

Termination Subject or Topic A message sent on the termination subject (if Rendezvous is the transport) or topic (if JMS is the transport) stops the adapter. The subject or topic must be unique to each TIDManager instance. The default value of the termination subject is given next.%%Domain%%.%%Deployment%%.adr3TIDManager%%InstanceId%%.exit

The message should contain "now" in the body.

For example: tibrvsend domain.<project name>.adr3.<instance name>.exit "now"

When the transport type is JMS use the following command to stop the adapter.jmsflow --send domain. <project_name>.adr3.<instancename>.exit --msg "now"

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


Setting TIDManager General Options | 181

Configure the RPC Server endpoint to be used by the TIDManager. Ensure that the subject assigned to the TID RPC Server matches the subject name of the TID RPC Client. This RPC client is referred to the Subject field of the Configuration tab of TID_RPC_CLIENT server under the R3AdapterConfiguration > Advanced > Sessions > TIDManagerSession folder.

By default, the subject name for the TID_RPC_SERVER session is SAP.TIDMANAGER. You can change the subject as appropriate. The subject must be unique for each TIDManager.

The subject name should match subject names being used by TID_RPC_CLIENT references in all adapter instances using this TIDManager.

You must change the name of the log file, adapter.log, if you intend to run multiple SAP TIDManagers.

Configuring a TIDManager Session on JMSYou can use the following topics to configure TIDManager session in JMS transport type.

• Creating a TIDManagerJmsSession, page 181

• Configuring a TIDManagerJmsSession, page 182

Creating a TIDManagerJmsSession

Figure 111 shows the Configuration tab for a GenericSession Configuration dialog.



Figure 111 R3TIDManger GenericSession Configuration Tab

To select JMS as your session type:

1. Click the Session folder, in the R3TIDManagerConfiguration > Advanced directory of the Project panel, to activate it.

2. Drag a GenericSession icon from the Palettes panel to the Designer panel.

3. Select the Advanced > Sessions folder for the TIDManager Server configuration.

4. Select JMS, in the Session Type drop-down list.


Configuring a TIDManagerJmsSession

Figure 112 shows the Configuration tab of TIDManagerJmsSession.

Table 51 R3TIDManager GenericSession Configuration Tab Options


Session Type Select the choice of session type from the Session Type drop-down list.

Applicable values are:• JMS

• RV

• RVCM


Setting TIDManager General Options | 183

Figure 112 TIDManagerJmsSession Configuration Tab

Table 52 TIDManagerJmsSession Configuration Tab Options

Name Description

Name A unique name for the TIDManagerJmsSession.

Description Brief description of the TIDManagerJmsSession.

Client ID The identification of the URL of the naming service provider and any other properties, such as the username and password to authenticate the client to the service.

Leave blank, upon save of the project the client ID would automatically be configured.

JNDI Lookups Checkbox to look up client ID through JDNI by using TIBCO Enterprise Message Service.

Connection Factory Type Drop-down list to select the connection factory type Session that options are:• Queue

• Topic

If the JNDI Lookups checkbox is selected then this field name will be changed to JNDI Conn. Factory Type, applicable drop-down list options remind the same.



You can configure the settings list in Table 52 to set TIDManagerJmsSession options. Upon the configuration’s completion, you can click the Apply button to proceed.

Once a TIDManagerJmsSession is created, you may also create a Server Session by dragging the icons accordingly from the Palettes panel to the designer panel.

Connection Factory Name A unique name for the Connection Factory Name.

If the JNDI Lookups checkbox is selected then this field name will be changed to JNDI Conn. Factory Name.

Connection Username Username for the connection.

If the JNDI Lookups checkbox is selected then this field name will be changed to JNDI Conn. Username.

Connection Password Password for the connection.

If the JNDI Lookups checkbox is selected then this field name will be changed to JNDI Conn. Password.

Provider URL A URL for the JMS provider.

If the JNDI Lookups checkbox is selected then this field name will be changed to JNDI Provider URL.

Provider Context Factory The naming directory for the Provider Context Factory.

SSL Checkbox to configure if using SSL to connection to the SAP system.

If this checkbox is checked, then you need to configure the %%JmsSslProviderUrl%% variable in the Global Variables panel.

Configure SSL Only applicable once the SSL checkbox is checked.

For more details on how to configure the Client ID and JNDI Lookups fields, see Chapter 12, "Using the EMS Implementation of JNDI: Looking up Administered Objects Stored in EMS", in TIBCO Enterprise Message Service User’s Guide.

Table 52 TIDManagerJmsSession Configuration Tab Options (Cont’d)

Name Description

The Client ID field must not contain a blank value. When creating a new JMS session, the Client ID field is not populated, but it will be automatically populated with a unique value following save of the project.


Setting TIDManager for Fault Tolerance | 185

Setting TIDManager for Fault Tolerance

You can set up the TIDManager in fault tolerant mode using the JMS exclusive queue feature.

Use the following topics to set up the fault tolerance mode.

• Set Up the TIDManager for the Fault Tolerance Mode, page 185

• Set Up the TIDManager and Adapter for the Fault Tolerance Mode, page 185

Set Up the TIDManager for the Fault Tolerance ModeTo set up the TIDManager for fault tolerance:

1. Edit the EMS_HOME/bin/queues.conf file and specify the queue name using the exclusive property for the TIDManager.

For example: SAP.TIDMgr exclusive

See the TIBCO Enterprise Message Service documentation for more information on editing the queues.conf file.

2. The endpoint and session of the remote TID Manager should match that of the TID Client defined in the outbound adapter configuration.

3. Start the TIDManager instances.

4. Start the adapter.

The primary instance of TIDManager will process IDocs while it is up and running. The secondary instance will take over when the primary instance goes down.

If the instances of TIDManager are started on different machines then make sure the TID file is in a location accessible by both instances of TIDManager.

Set Up the TIDManager and Adapter for the Fault Tolerance ModeIn order to start the TIDManager and the adapter in fault tolerance mode in for TIBCO ActiveMatrix Adapter for SAP 7.0, the secondary instance should be given a new instance ID.

For example:

1. Start the first TIDManager instance as ./adr3TIDManager

Fault tolerance remains the same as in prior releases.



2. Start the second TIDManager instance as ./adr3TIDManager -system:instanceID myTID


TID | 187

TID

Chapter 9 Working with Secure Communication

This chapter introduces functionality and configuration of the Secure NetworkCommunication, SNC. The component which provides secure communicationbetween the TIBCO ActiveMatrix Adapter and the SAP system.

Topics

• Introduction of Secure Network Communication, page 188

• Setting Up SNC, page 189


188 | Chapter 9 Working with Secure Communication

Introduction of Secure Network Communication

You can use the Secure Network Communication, SNC, component for securecommunication between TIBCO ActiveMatrix Adapter for SAP and the SAPsystem.

SNC provides the following three levels of security protection between theadapter and the SAP system:

• Authentication

• Integrity

• Privacy

See the SAP documentation for more information about SNC.

SAP Cryptographic Library for SNCThe SAP Cryptographic Library is the default security product for performingencryption functions in SAP Systems. For example, you can use it for providingSNCs.

This chapter describes using the SAP Cryptographic Library for SNC. SAPCryptographic Library provides the entire functionality defined in the standardinterface of the GSS-API V2 (Generic Security Services Application ProgrammingInterface Version 2).


Setting Up SNC | 189

Setting Up SNC

You can use the following steps to set up the SNC in the SAP system and theTIBCO ActiveMatrix Adapter for SAP.

1. Download the SAP Cryptographic Library, page 189

2. Install the SAP Cryptographic Library, page 190

3. Set the Trust Manager Profile Parameters, page 191

4. Create an SNC PSE for the SAP J2EE Engine, page 193

5. Set SNC Profile Parameters for SAP, page 197

6. Install the SAP Cryptographic Library on the Adapter, page 199

7. Install the PSE, page 199

8. Set the SNC Parameter Specific to an Inbound Scenario, page 204

9. Set SNC Parameters Specific to Outbound Scenarios, page 208

10. Set SNC in TIBCO Designer for the Adapter, page 212

11. Useful Transaction Codes in the SAP System, page 213

Download the SAP Cryptographic LibraryYou can download the SAP Cryptographic Library in the SAP ServiceMarketplace from www.service.SAP.com/tcs by selecting Support Packages andPatches > Browse our Download Catalog > SAP Cryptographic Software > SNCCLIENT ENCRYPTION.

Table 53 lists contents of the SAP Cryptographic Library for Windows NT andUNIX operating system.

Table 53 Contents of the SAP Cryptographic Library

Platform Libraries

Windows NT • SAPcrypto.dll (Library)

• SAPgenpse.exe (executable file)

• ticket (licence ticket)

UNIX • libSAPcrypto.<ext> (Library)

• SAPgenpse (executable file)

• ticket (licence ticket)



Install the SAP Cryptographic LibraryUse the following procedure to install the SAP Cryptographic Library.

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. Table 54 and Table 55 list directory examples for WindowsNT and UNIX operating systems.

3. Check the file permissions for the SAP Cryptographic Library. Table 56 listsexamples of library function requiring permission to execute.

4. Copy the ticket file to the sub-directory sec in the instance directory$(DIR_INSTANCE), Table 57 and Table 58 list details.

Table 54 DIR_Executable Directory

Platform DIR_EXECUTABLE Directory

Windows NT <DRIVE>:\usr\SAP\<SID>\SYS\exe\run\

UNIX /usr/SAP/<SID>/SYS/exe/run/

Table 55 Location of SAP Cryptographic Library

Platform Location of SAP Cryptographic Library

Windows NT <DRIVE>:\usr\SAP\<SID>\SYS\exe\run\SAPcrypto.dll

UNIX /usr/SAP/<SID>/SYS/exe/run/libSAPcrypto.so

Table 56 Library Function Requires Permission to Execute

Platform Library Function

Windows NT SAPService<SID>

UNIX <sid>adm

Table 57 Sub-Directory SEC

Platform DIR_INSTANCE Directory

Windows NT <DRIVE>:\usr\SAP\<SID>\<instance>

UNIX /usr/SAP/<SID>/<instance>



5. Set the environment variable SECUDIR to the sec sub-directory. Theapplication server uses this variable to locate the ticket and its credentials atruntime.

If you set the environment variable using the command line, then the valuemay not be applied to the server's processes. Therefore, we recommendsetting SECUDIR in the startup profile for the server's user or in the WindowsNT registry.

6. Now, the SAP Cryptographic Library is installed on the application server andthe environment is set up correctly so that the server can locate the library atruntime.

Set the Trust Manager Profile ParametersYou need to set the profile parameters so the trust manager can access the SAPCryptographic Library.

Figure 113 shows sample screen of the Trust Manager Profile.

Table 58 Location of the Ticket

Platform Location of the Ticket

Windows NT <DRIVE>:\usr\SAP\<SID>\<instance>\sec\ticket

UNIX /usr/SAP/<SID>/<instance>/sec/ticket



Figure 113 Trust Manager Profile

Use the following steps to set the profile parameters.

1. Set the profile parameters lists in Table 59 and Table 60 on each SAP Web ASABAP instance. For more information on these profile parameters see the SAPdocumentation.

Table 59 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

Table 60 Examples of Profile Parameters

Profile Parameters Example

sec/libSAPsecu • UNIX /usr/SAP/<SID>/SYS/exe/run/libSAPcrypto.so

• Windows NT <DRIVE>:\usr\SAP\<SID>\SYS\exe\run\SAPcrypto.dll



2. Restart the application server.

3. You can now maintain the SNC PSE using the trust manager.

Create an SNC PSE for the SAP J2EE EngineWhen using the SAP Cryptographic Library as the security product for SNC, theapplication server must possess a Personal Security Environment (PSE). This PSEcontains the SAP J2EE Engine’s public-key information, which includes its privatekey, its public-key certificate, and the list of public-key certificates that it trusts.

Figure 114 shows a sample screen of the Trust Manager, which provides you theGUI for configuring SNC PSE.

ssf/ssfapi_lib • UNIX /usr/SAP/<SID>/SYS/exe/run/libSAPcrypto.so

• Windows NT <DRIVE>:\usr\SAP\<SID>\SYS\exe\run\SAPcrypto.dll

ssf/name SAPSECULIB

Table 60 Examples of Profile Parameters

Profile Parameters Example



Figure 114 Trust Manager

To create the SNC PSE for the SAP J2EE Engine use the command line toolSAPgenpse.exe or as an alternative, you can use a single PSE for both theapplication server and the SAP J2EE Engine. In this case, copy the applicationserver’s SNC PSE to the SAP J2EE Engine’s SECUDIR directory.

Before creating the PSE make sure you have:

• The SAP Cryptographic Library is installed on the SAP J2EE Engine.

If the SAP Cryptographic Library is not installed, then the Trust Manager doesnot display the node for the SNC PSE.

• The environment variable SECUDIR is set to the location where the PSE is to bestored.



To check the location of the SECUDIR directory, execute SAPgenpse withoutincluding any command options. The program will display various detailedinformation such as the library version and the location of SECUDIR.

• Naming convention for the Distinguished Name matches the DistinguishedName of the server's SNC name that is in the profile parametersnc/identity/as. If this profile parameter is not yet set, then you can stillspecify the SAP J2EE Engine's Distinguished Name, but you receive awarning that you have to maintain the profile parameter.

Additionally, the SAP J2EE Engine's Distinguished Name for SNC must beunique. It cannot used in a different PSE.

Figure 115 shows a sample of configuring PSE.

Figure 115 Configuring 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 Uss Individual PSE for All Components onpage 200.

1. Type in STRUST to proceed to Trust Manager page, see Trust Manager onpage 194.

2. Click the SNC (SAPCryptolib) folder.

3. Select Context > Create (if no PSE exists) or Replace.

4. The Create/Replace PSE dialog appears.

If the server's SNC name is defined in the profile parameter snc/identity/asthen the system automatically determines the Distinguished Name



accordingly. Otherwise, enter the Distinguished Name parts in thecorresponding 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.

5. Click Enter button then return to the Trust Manager page.

6. For SNC, you must assign a password to the PSE. Choose Assign passwordfield then PSE dialog appears.

7. Enter a password for the PSE and click Enter button then return to the TrustManager page.

The SNC PSE is created and distributed to the individual application servers.The system protects the PSE with a password and creates credentials for theserver to access the PSE at runtime, see Figure 116 for sample of created PSE.

Figure 116 PSE Sample



Set SNC Profile Parameters for SAPThis section describes how to set the SNC profile parameters. Use Transactioncode RZ10 to set the parameters list in SNC Profile Parameters on page 197 in theInstance 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, use the following steps to set SNC Profile parameters for SAP.

1. Set the profile parameters, list in Table 61, 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 61 SNC Profile Parameters


snc/enable 1

• The value of 1 represents SNC is enabled, if the value is set to 0then it represents the SNC is disabled.

snc/gsSAPi_lib Path and file name where the SAP Cryptographic Library islocated

For example:

• UNIX usr/SAP/<SID>/SYS/exe/run/libSAPcrypto.so

• Windows NTD:\usr\SAP\<SID>\SYS\exe\run\SAPcrypto.dll

snc/identity/as Application server's SNC name

Syntax: 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



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. Save and activate the profile.

3. Restart the application server.

4. The application server is now ready to use SNC.

snc/data_protection/min 1 Authentication only



snc/data_protection/use 1 Authentication only



9 Use the value from snc/data_protection/max

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


If the snc/enable profile parameter is set to 0 then the usage of SNC properties inthe client connection pool of an adapter configuration would not be validatedsince a non-secured connection would be created by default.



Install the SAP Cryptographic Library on the AdapterUse the following steps to install the SAP Cryptographic Library on the adapter.

1. Extract the SAP Cryptographic Library.

2. Copy the SAP Cryptographic Library file to a folder. Make sure you add thepath of 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 Copy the ticket file to thesub-directorysec in the instance directory$(DIR_INSTANCE), Table 57and Table 58 list details. on page 190.

4. Set the SECUDIR environment variable to point to the sec directory created inCreate the SEC directory and copy the ticket file to this directory. onpage 199

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 Windows NT platforms, the SECUDIR variable is set in the adr3u.tra forUnicode adapter files.

On UNIX platforms, the SECUDIR variable is set in the adr3u_env.sh forUnicode adapter files.

If using the adapter tester, the SECUDIR variable is set in the adr3u.tra forUnicode adapter.

5. The SAP Cryptographic Library is now installed.

Install the PSEApply the appropriate method to create the PSE that the adapter will use for SNC.

1. Uss a Single PSE for All Components, page 199

2. Uss Individual PSE for All Components, page 200

Uss a Single PSE for All Components

In this scenario you create a single PSE for all server components.

1. Create the PSE on a single component.

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

Uss Individual PSE for All Components

In this scenario you create an individual PSE for each components. To establishthe necessary trust relationships between these components, you must exchangethe corresponding public-key certificates. For each of the servers, export theserver's public-key certificate and import it into its partners' PSEs.

Using Individual PSEs and Exchanging Public-Key Certificates

Use the following steps to create PSE for the client.

1. Create a directory on your system to store the PSE.

2. Copy the ticket license file and the SAP Certified Client CryptographicLibrary (for example: SECUDIR) to the directory you just created. Make sureyou set the SECUDIR environment variable to this directory, copy the library toa different directory, and add this path to your PATH environment variable.

3. Execute the following command to generate the PSE, the client PSE is namedas RFC.pse. From the command line, you can specify the DistinguishedName. For example: “CN=RFC, OU=IT, O=CSW, C=DE“> SAPgenpse gen_pse -v -p RFC.pseGot 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=DESupplied distinguished name: "CN=RFC, OU=IT, O=CSW, C=DE"Generating key (RSA, 1024-bits) ... succeeded.certificate creation... okPSE update... okPKRoot... okGenerating 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.crtOpening 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



5. Import the Client Certificate to Server PSE via the transaction STRUST. SeeFigure 114, Trust Manager, on page 194 for reference of step a to c.

a. Click the SNC (SAPCryptolib) folder, see for reference for step a to c.

b. Enter the SAPCryptolib password.

c. Click the Import Certificate button.

d. Import certificate file format to Base64 by select the Base64 radio buttonon the File tab, see Figure 117.

Figure 117 Import Certificate File Format Base64

e. Click the Add to Certificate List button.

6. Export the Server Certificate via the transaction STRUST.

a. Expand SNC (SAPCryptolib) > you own Certificate, see Figure 114, TrustManager, on page 194.

b. Click the Export certificate button.

c. Import certificate file format to Base64 by select the Base64 radio buttonon the File tab, see Figure 117.

d. Import the Server Certificate to the Client PSE.

On the command line run:> SAPgenpse maintain_pk -v -a SNC.crt -p RFC.pseOpening 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=DEIssuer : CN=IDS, OU=IT, O=CSW, C=DESerialno: 00KeyInfo : RSA, 2048-bitValidity - 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)



7. 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 sec login must be carried out underthe account of the <sid>adm.

8. Allow SNC RFC Connection.

9. Map the x.509 certificates that were created for the user accounts on the SAPServer.

a. Start Transaction SM30 and in the Table/View field, enter VSNCSYSACL, seeFigure 118.

Figure 118 Table/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 the OK button.

b. In the Type of ACL entry drop-down list, select E as Work Area, seeFigure 119.



Figure 119 Type of ACL Entry

c. In the System ID and SNC Name field, for example, enter respectivelyvalues of BAM and p:CN=BAM, OU=ENGG, O=TIBCO, C=US. Do not forgetthe p: in front of the CN.

d. Check both of the Entry for RFC activated and the Entry for CPICactivated checkboxes as shown in Figure 120.

Figure 120 Change View SNC ACL for Systems Details

e. Click the OK button to save you configuration.



Set 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 aninbound adapter instance to an AS ABAP server.

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 client or serverconnections available in the TIBCO Designer project.

The program may have an 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 making sure:

• You apply SNC protection to the communications between the RFC externalprogram and the AS ABAP.

• The external program uses the values you set in the TIBCO Designer.

Configure the runtime inbound connection parameters shown in Figure 121 in theTIBCO Designer project.

In the following sections of this chapter, the information provided on the screenshots are for example purpose only. You can follow the information we providebut only to help or guide you with the setup on you own installation.



Figure 121 Runtime Inbound Connection in TIBCO Designer

Setup the runtime inbound parameters lists in Table 62 in TIBCO DesignerTable 62 SNC Parameters for TIBCO Designer

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.

Parameter Description Required? Valid values Default Value

SNC MODE The SNC activation indicator Y 0,1

0 = SNCdisabled

1= SNCactivated

none

SNC PARTNERNAME The SNC name of thecommunication partner(application server)

Y string none

SNC QOP Quality of protection level) N 1,2,3,8,9 3

SNC LIB The path and file name of thegsSAPi library

Y string none



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.

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.

Use the following steps to maintain the SNC system access control list:

1. Map the SNC name to the User, see Figure 122

Figure 122 Map the SNC Name to the User

2. Initiate transaction SM30 then in the Table/View field enter VSNCSYSACL,see Figure 118, Table/View VSNCSYSACL, on page 202.

3. Choose E as Work Area for the Type of ACL entry, Figure 119, Type of ACLEntry, on page 203.

4. Enter the AGate's SNC name in the SNC name field. The System ID field isoptional.



5. Check the checkboxes for, see Figure 120, Change View SNC ACL for SystemsDetails, on page 203,:

— 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)

6. Click the OK button to save you configuration.

Set SNC Parameters Specific to Outbound ScenariosThe following SNC Parameters are 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.

Initiator (SAP System)

Use transaction SM59 to maintain RFC destinations and their SNC options.

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

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 Active 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.

• 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 the SAPrfc.inifile or use the program interface inrfclib. This section describes how to specify theinformation in SAPrfc.ini. For more information about using rfclib, see the SAPdocumentation.

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 63:Table 63 SNC Parameters for RFC


SNC LIB Path and file nameof the gsSAPi library

Y String None

SNC MODE Activationindicator

Y 0, 1

0=SNCdisabled

1=SNCactivated

None

SNC QOP Quality of protection

(protection level)

N 1,2,3,8,9 3



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. See Figure 123 for reference.

SNC MYNAME Name of the RFC serverprogram

You can use theparameterSNC_MYNAME tolocally define the namethat corresponds to thecredentials for the RFCserver program. If youdo, then make sure thatthis SNC namecorresponds to the SNCname as defined in theSNC options (SNCpartner name) for theRFC destination for thisserver program. If youdo not locally defineSNC_MYNAME, thenthe registered programuses the SNC namedefined in the RFCdestination.

N String The SNCnamecontained inthe RFCdestination'sSNC options.




Figure 123 RFC Destination ZPRALOG

Set SNC in TIBCO Designer for the Adaptershows the runtime outbound connection configuration in the TIBCO designer.

Figure 124 Runtime Outbound Connection in TIBCO Designer



Setup the SNC parameters lists in Table 64 in TIBCO Designer to set SNC inTIBCO Designer for the adapter.

Table 64 SNC Parameters for TIBCO Designer

Example shows that, in , the server's SNC name is p:CN=BAM, OU=ENGG,

O=myCompany, C=US and the SNC library directory is atC:\SAPUsr\Dev\Ongoing\SNC\SAPcrypto.dll.

Useful Transaction Codes in the SAP SystemThe following Transaction codes, Table 65, are used for the SNC setup.


SNC MODE The SNC activation indicator Y 0,1

0 = SNCdisabled

1= SNCactivated

none

SNC QOP Quality of protection level) N 1,2,3,8,9 3

SNC MYNAME The SNC name of the usersending the RFC.

N string The nameprovided by thesecurityproduct for thelogged-on user.

SNC LIB The path and file name of thegsSAPi library

Y string none

Table 65 Useful Transaction Codes in the SAP System

Transaction Code Description

STRUST Trust Manager page

RZ10 Edit Profiles page

SU01 User Maintenance: Initial Screen page

SM59 Configuration of RFC Connections page

SM30 Maintain Table Views: Initial Screen page




| 215

Chapter 10 Developing a Business Process

A process definition is a graphical representation of your business process model. You can develop process definitions by using TIBCO ActiveMatrix BusinessWorks within TIBCO Designer.

This chapter introduces how to develop a business process and how to map data between adapter activities and other activities.

See also:

• "TIBCO ActiveMatrix BusinessWorks" in TIBCO ActiveMatrix Adapter for SAP Concepts for a brief overview and important concepts of TIBCO ActiveMatrix BusinessWorks.

• TIBCO ActiveMatrix Adapter for SAP Examples for examples that demonstrate how the adapter interacts with a TIBCO ActiveMatrix BusinessWorks business process.

• The TIBCO ActiveMatrix BusinessWorks documentation.

Topics

• Overview of Business Process Development, page 216

• Activities for Communicating with Adapter Services, page 218

• Activity Configuration Tabs, page 219

• Mapping and Transforming Data, page 220

• Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services, page 223

• Testing a Process Definition, page 233


216 | Chapter 10 Developing a Business Process

Overview of Business Process Development

You can develop and test business processes by using TIBCO ActiveMatrix BusinessWorks in TIBCO Designer.

Figure 125 describes the general procedure for developing a business process.

Figure 125 Developing a Business Process

1. Create a process definition by dragging the Process Definition resource from the Process palette to the Design panel. Name the process definition and give the process a description.

2. Create any shared configuration resources you will require for your process definition. These items are located in the shared configuration palettes.

3. In the Project panel, select the process definition you created. A blank business process will be displayed in the Design panel, with a Start and an End activity by default.

4. Select the palette that has the activities you want to add to the business process. In particular, the ActiveEnterprise Adapter palette has activities for communicating with adapter services. See Activities for Communicating with Adapter Services on page 218 for detailed information.

Drag the activities from their palettes into the Design panel.

Configure the selected activities by clicking an activity and specifying the options available as tabs in the Configuration panel. See Activity Configuration Tabs on page 219 for detailed information.

5. Click the transition button on the tool bar to draw transitions between activities.

6. Perform mapping and transformation of data for each activity’s input. See Mapping and Transforming Data on page 220 for detailed information.


Overview of Business Process Development | 217

7. After you define the process, use the test mode tool to enter testing mode. In testing mode, you start a TIBCO ActiveMatrix BusinessWorks engine to perform the processing described in the process definition. Test and debug your process definition until it operates as expected.

See TIBCO ActiveMatrix BusinessWorks Process Design Guide for a more detailed discussion of each development phase.



Activities for Communicating with Adapter Services

The ActiveEnterprise Adapter palette contains activities for communicating with configured adapter services. Table 66 lists the adapter services and associated activities in the ActiveEnterprise Adapter palette.

See "ActiveEnterprise Adapter Palette" in TIBCO ActiveMatrix BusinessWorks Palette Reference for detailed information on when and how to use each of these activities.

Table 66 Adapter Services and Associated Activities in the ActiveEnterprise Adapter Palette

Adapter Service Associated Activities

Publication Service Adapter Subscriber (Process Starter1) Starts a process based on the receipt of a message from the Publication Service of the specified adapter.

Wait for Adapter Message Waits for the receipt of a message from the Publication Service of the specified adapter.

Subscription Service Publish to Adapter Publishes a message received by the Subscription Service of the specified adapter.

Request-Response Invocation Service

Adapter Request-Response Server (Process Starter1) Starts a process based on the receipt of a request from the Request-Response Invocation Service of the specified adapter.

Respond to Adapter Request Sends a response to a specified adapter for a previously received request from the Request-Response Invocation Service of the adapter.

Send Exception to Adapter Request Sends an exception to a specified adapter for a previously received request from the Request-Response Invocation Service of the adapter.

Wait for Adapter Request Waits for the receipt of a request from the Request-Response Invocation Service of the specified adapter.

Request-Response Service

Invoke an Adapter Request-Response Service Communicates as a client with the Request-Response Service of the specified adapter.

1. Process Starters are activities used to start a process when an event occurs. When a process starter isplaced into a process definition, it replaces the default Start activity, and becomes the first activity inthe process.


Activity Configuration Tabs | 219

Activity Configuration Tabs

When you select an activity added from the Design panel, its configuration options are available as tabs in the Configuration panel. In particular, for the activities that communicate with adapter services, two or more of the following tabs are available:

• Configuration Used for general configuration of the activity. For activities communicating with adapters, you specify the adapter service to use in this tab.

• Transport Normally, the activities of the ActiveEnterprise Adapter palette use the same transport configuration as the adapter service with which they are communicating. If you want to override the transport configuration of the adapter service, use this tab to specify different transport parameters.

• Misc Used for specifying the running order and a custom ID of the process.

• Event Used for specifying the timeout for the incoming event and a condition to determine whether the incoming event is the correct one for the specific process instance. This tab is useful for the Wait for Adapter Message and Wait for Adapter Request activities that wait for incoming events, such as HTTP requests and incoming TIBCO Rendezvous messages.

• Input The output data from all activities that precede this activity in the process definition is available for mapping to the input schema of this activity.

See Mapping and Transforming Data on page 220 for more information about how to use this tab for data mapping.

• Output The data of an activity is output to activities that follow in the process definition.

• Error Output Used to list the possible exceptions that the activity can throw.

See "ActiveEnterprise Adapter Palette" in TIBCO ActiveMatrix BusinessWorks Palette Reference for configuration options of each adapter activity.



Mapping and Transforming Data

This section introduces how to perform data mapping and transformation for an activity. The following topics are covered:

• Activity Input Tab, page 220

• Mapping and Transforming Process Data to Activity Input, page 221

• Mapping Data with Adapter Schemas, page 222

Activity Input TabUse the Input tab of an activity to supply the data that an activity expects as input.

Figure 126 illustrates the Input tab of an activity.

Figure 126 Input Tab of an Example Activity

On the Input tab, the available process data and the expected input of an activity are displayed in two panels:

• Process Data Panel The process data is the list of available data in the process definition at the point where the activity is located. An activity has access to all output data from any activity that has been previously executed in the process definition.


Mapping and Transforming Data | 221

• Activity Input Panel The input of an activity is an XSLT (Extensible Stylesheet Language Transformation) template that specifies how to transform process data into expected input. You can use any valid XPath (XML Path Language) expression in the XSLT statements to specify and process elements of the Activity Input schema, and to perform basic operation and comparison of strings, dates, numbers, and booleans.

Mapping and Transforming Process Data to Activity InputYou map data by selecting an item in the Process Data panel and dragging it to the schema element you want to map in the Activity Input panel. After you release the mouse button, simple mappings are then displayed in the formula area next to the input element.

If more mapping options are available, the Mapping Wizard dialog is displayed for you to select the mapping you want to perform.

For more complicated scenarios that require multiple steps, you can use the following tools in TIBCO ActiveMatrix BusinessWorks to achieve the mapping you want. You can use buttons and right-click menus available in the Process Data panel and Activity Input panel to invoke these tools.

• For process data:

— Coercions ( ) for specifying a type for the selected elements that are not of a specific data type.

— Type Documentation ( ) for specifying or viewing documentation for the selected element.

• For activity input:

— Mapper Check and Repair ( ) for verifying the XSLT template you have created for the expected input and fixing its simple problems.

— Edit Statement ( ) for modifying an XSLT statement for the selected element.

— XPath Formula Builder ( ) an easy to use graphical interface for creating an XPath statement for the selected element.

— Statement (the right-click context menu) useful shortcuts for creating XSLT statements for the selected element.

See "Mapping and Transforming Data" in TIBCO ActiveMatrix BusinessWorks Process Design Guide for a more detailed introduction about how to use these mapping tools.



Mapping Data with Adapter SchemasTIBCO Adapters manage data flow by using schemas. During service configuration, you fetch the schemas from the source or target application and apply it to an adapter service. You can then use the retrieved schemas when mapping data for an activity that communicates with the adapter service, either in its input or output, depending on its data flow. Table 67 shows the schema usage in each activity.

See "ActiveEnterprise Adapter Palette" in TIBCO ActiveMatrix BusinessWorks Palette Reference for configuration options of each adapter activity.

Table 67 Schemas Used in the Input and Output of Activities for Adapter Services

Adapter Service Activity Input Output

Publication Service Adapter Subscriber The schema specified for the adapter service.

Wait for Adapter Message

The schema specified for the adapter service.

Subscription Service Publish to Adapter The schema definition for the adapter service

The specified reply schema.

Request-Response Invocation Service

Adapter Request-Response Server


Respond to Adapter Request

The schema definition for the response of the adapter service

Send Exception to Adapter Request

The schema definition for the exception of the adapter service

Wait for Adapter Request


Request-Response Service

Invoke an Adapter Request-Response Service

The input parameters for the specified operation based on the schema definition for the adapter service.

The specified reply schema.


Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services | 223

Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services

This section introduces the details of mapping data for TIBCO ActiveMatrix Adapter for SAP services:

• For Subscription Service, page 223

• For Request-Response Invocation Service, page 224

• For Request-Response Service, page 225

• Data Type Mapping between the SAP System and Adapter, page 230

For Subscription ServiceWhen invoking a Subscription Service from TIBCO ActiveMatrix BusinessWorks, you need to use the Publish to Adapter activity as listed in Table 66 on page 218 and perform the mapping for the IDoc you want to send. Depending on whether you use tRFC or qRFC as the protocol, you need to map the segment name of the IDoc differently. Run the we31 transaction in the SAP system to check a segment. Figure 127 shows a segment of type E1MARAM that contains multiple segment definitions. The property for the segment name in the Input tab of the activity is SEGNAM. Figure 128 shows the SEGNAM property of one IDoc in the Input tab.

Figure 127 Segment Example in SAP System



Figure 128 IDoc SEGNAM Property in the Input Tab of the Publish to Adapter Activity

• tRFC If the SEGNAM property is left blank, the adapter will automatically populate the property by using the name from the AE Schema class and the format of the name will be the segment definition.

• qRFC You need to explicitly map the SEGNAM property. The format of the name is the segment type. If the property is left blank, the adapter automatically populates using the segment definition, which is incorrect, and the sent IDoc will fail the syntax check in the SAP system and remain in IDoc status 75.

For Request-Response Invocation ServiceThe Request-Response Invocation Service in the outbound adapter is invoked by the SAP system. To allow for the request from the SAP system to be completed, you need to use one or more of the following activities as listed in Table 66 on page 218:

• Adapter Request-Response Server

• Respond to Adapter Request

• Send Exception to Adapter Request



• Wait for Adapter Request

For Request-Response ServiceWhen invoking a Request-Response Service from TIBCO ActiveMatrix BusinessWorks, you need to use the Invoke an Adapter Request-Response Service activity as listed in Table 66 on page 218, and specify additional information in the request for some features.

This section introduces the required configuration for the activity:

• Configure an Invoke an Adapter Request-Response Service Activity, page 225

• RFCCLOSURE Properties, page 228

Configure an Invoke an Adapter Request-Response Service Activity

To configure the activity, you need to specify a closure class as part of the input schema and specify the relevant properties for the invocation. Use the Configuration panel and follow these steps for the configuration:

1. Click the Configuration tab, and browse and select the adapter service in the Adapter Service field. Click the Apply button.

2. Click the Input tab, as shown in Figure 129.

When the outbound adapter is invoked by the SAP system, any parameters not specified on the actual call will not be initialized by the adapter and forwarded as is to the TIBCO ActiveMatrix BusinessWorks business process.

When the inbound adapter is invoked by the TIBCO ActiveMatrix BusinessWorks business process, any parameters not specified on the actual call but exist in the SAP system will not be initialized by the adapter.



Figure 129 Invoke an Adapter Request-Response Service Activity - Input Tab

3. Select the __caret__userClosure__caret_ element in the Activity Input panel and click the Edit Statement button. Figure 130 shows the displayed Edit Statement dialog.

Figure 130 Edit Statement Dialog



4. Configure the schema for the selected element:

a. Click the Type tab and check the Type Substitution checkbox.

b. Click the Browse Resource button.

c. In the displayed Select A Resource dialog, click the By Location tab and expand the following folder under the project:

AESchemas > ae > SAPAdapter40 > classes

d. Select the RFCCLOSURE class in the list displayed in the Type panel.

e. Click the OK button in the Select A Resource dialog.

f. Click the OK button in the Edit Statement dialog.

Figure 131 shows the Select A Resource dialog with the RFCCLOSURE class selected.

Figure 131 Select A Resource Dialog

5. Expand the __caret__userClosure__caret_ element in the Activity Input panel and specify the properties based on features that you want to use.

Figure 132 shows the expanded element with the RFCCLOSURE properties.

See RFCCLOSURE Properties on page 228 for a description of the properties.



Figure 132 __caret__userClosure__caret_ element with the RFCCLOSURE Schema

RFCCLOSURE Properties

The following tables list the properties of the RFCCLOSURE class. The tables are sorted based on the list order of the properties in the class.

• For an inbound adapter, see Table 68 on page 228.

• For an outbound adapter, see Table 69 on page 229.

• Properties that are not applicable, see Table 70 on page 230.

You can use the obfuscate utility installed with TIBCO Runtime Agent to encrypt confidential information, such as passwords in property files, with an encryption key. See Password Handling on page 338 for more details.

Table 68 RFCCLOSURE Properties for an Inbound Adapter

Property Description

bTransactional Set the bTransactional property to true when using the tRFC protocol.

Note: Do not have both this property and the bQueue or qName property specified for the same activity.



sessionID Applicable for the dynamic logon and transactions features.

For the transaction feature, this value is not mapped for the first Invoke an Adapter Request-Response Service activity of the transaction. The subsequent Invoke an Adapter Request-Response Service activities need to map the sessionID with the sessionID returned from the first Invoke an Adapter Request-Response Service activity.

bQueue Only applicable for an inbound adapter when using the qRFC protocol.

Note: Do not set the bTransactional property when using qRFC. Otherwise, the call from TIBCO ActiveMatrix BusinessWorks will fail.

qName Only applicable for an inbound adapter when using the qRFC protocol.

DynamicConnection Only applicable for an inbound adapter when the connection information is required.

bInTransactionContext Only applicable for an inbound adapter when the usage of transactions is required.

Needed for all the Invoke an Adapter Request-Response Service activities in the same transaction. When the flag is true, a connection is reserved. The connection is released only after the bContextEnd flag is set to true.

bContextEnd Only applicable for an inbound adapter when the usage of transactions is required.

If the flag is set to true, after the current invocation of the Request-Response Service, the transaction will be closed and all resources including the connection will be released.

contextTimeout Only applicable for an inbound adapter when the usage of transactions is required.

You can override the value by using the adr3.contextTimeout TRA property. If the value is zero and no value is provided in TRA property adr3.contextTimeout, an error is returned.

Table 69 RFCCLOSURE Properties for an Outbound Adapter


TID The TID property will be populated in those cases where the message originates from a transaction call.

bTransactional Set the bTransactional property to true in those cases where the message originates from a transaction call.

Note: Do not set the bQueue or qName property when using tRFC.

Table 68 RFCCLOSURE Properties for an Inbound Adapter (Cont’d)




Data Type Mapping between the SAP System and AdapterTable 71 provides the mapping between the following data types:

• SAP data types used in the SAP system.

• Data types used in TIBCO Designer.

• Java data types used by the runtime adapter.

Table 70 RFCCLOSURE Properties Not Applicable


GUID Not applicable.

packetSize Not applicable.

bUseCache Not applicable.

bMore Not applicable.

bLogoutAferCall Not applicable.

qCount Not applicable.

bClearCache Not applicable.

cacheDirection Not applicable.

maxRowCount Not applicable.

currentRowCount Not applicable.

rfcBapiTimeout Not applicable.

Table 71 Data Mapping between SAP Data Types and Adapter Data Types

SAP Data Type AE Custom Schema Type Java Type

ACCP CHAR.X String

CHAR CHAR.X String

CLNT CHAR.3 String

CUKY CHAR.X String

CURR FIXED.X.Y BigDecimal



DATS CHAR.8 Date

DEC FIXED.X.Y BigDecimal

DF16_DEC FIXED.X.Y BigDecimal

DF16_RAW FIXED.X.Y BigDecimal

DF16_SCL FIXED.X.Y BigDecimal

DF34_DEC FIXED.X.Y BigDecimal

DF34_RAW FIXED.X.Y BigDecimal

DF34_SCL FIXED.X.Y BigDecimal

FLTP R8 Double

INT1 I1 Int

INT2 I2 Int

INT4 I4 Int

LANG CHAR.1 String

LCHR CHAR.X String

LRAW BINARY.256 Byte[]

NUMC CHAR.X String

PREC I2 Int

QUAN FIXED.X.Y BigDecimal

RAW BINARY.256 Byte[]

RAWSTRING BINARY Byte[]

SSTRING CHAR.X String

STRING STRING String

TIMS CHAR.6 Date

Table 71 Data Mapping between SAP Data Types and Adapter Data Types (Cont’d)




UNIT CHAR.X String

Table 71 Data Mapping between SAP Data Types and Adapter Data Types (Cont’d)



Testing a Process Definition | 233

Testing a Process Definition

To test a process definition:


2. Select the process definition you want to test in the Project panel.

3. Set breakpoints in the process definition at points where you want to stop a running process and examine its state:

a. Click the Set Breakpoints ( ) button or in the menu bar press Alt + F8 to open the Set Breakpoints dialog.

b. In the dialog, check the checkboxes for the breakpoints you want to set before or after an activity.

c. You can also specify a condition in the Condition field for each breakpoint. Click the XPath Formula Builder ( ) button to open the builder dialog and build a condition.

d. Click the OK button.

Figure 133 shows the Set Breakpoints dialog for a sample process with the breakpoints set before and after the Parse Vendor Input activity.

Figure 133 Set Breakpoints Dialog for a Sample Business Process

4. If the process begins with a Start activity and the Start activity has a schema defined, you can supply input data to the process before executing it.



5. Load and start one or more processes:

a. Click the Tester tab on the left of the Project panel. The Test panel is displayed.

b. From the Test panel, click the Start Testing Viewed Process ( ) button or press F9 to open the Select Processes To Load dialog.

c. Check the checkboxes for the processes you want to load.

d. To start the processes, click the Load Selected button.

Figure 134 shows the Select Processes To Load dialog for project Sample with the Using JMS process selected.

Figure 134 Select Processes To Load Dialog for a Sample Project

6. Examine the data of the process by selecting any of the activities in the process. The current state of the process data is displayed on the Process Data tab of each activity.

7. Use the toolbar buttons, such as Pause Testing, Step to Next Activity, and so on, in the Test panel to either continue through the process instance or to stop the current process instance.

See "Testing Process Definitions" in TIBCO ActiveMatrix BusinessWorks Process Design Guide for configuration options of each adapter activity.


| 235

Chapter 11 Deploying an Adapter Project

When you are ready to deploy your project, you must generate an Enterprise Archive (EAR) file, which contains the adapter configuration and process definitions you want to deploy. You can use TIBCO Designer to generate the archive, and upload the archive in TIBCO Administrator to deploy the associated application on the machine of your choice.

This chapter introduces how to set deployment options for an adapter project and how to deploy the project.

See also:

• "TIBCO Administrator" in TIBCO ActiveMatrix Adapter for SAP Concepts for a brief overview and important concepts of TIBCO Administrator.

• The TIBCO Administrator documentation.

Topics

• Generating an EAR File in TIBCO Designer, page 236

• Starting TIBCO Administrator, page 242

• Creating an Application, page 244

• Changing Application Properties, page 247

• Deploying an Application, page 254


236 | Chapter 11 Deploying an Adapter Project

Generating an EAR File in TIBCO Designer

This section introduces the following topics:

• Generating an EAR File in TIBCO Designer, page 236

• Generating an EAR File in TIBCO Designer for a Project Using SSL, page 236

• EAR Configuration Reference, page 238

See also: TIBCO Designer User’s Guide for detailed information.

Generating an EAR File in TIBCO DesignerIn TIBCO Designer, follow these steps to create an EAR file:

1. Select the project for which you want to create an archive.

2. Drag the Enterprise Archive resource from the General palette to the Design panel and specify the options in the Configuration tab for the resource, then click the Apply button.

3. For each adapter instance you want to deploy, drag the Adapter Archive resource from the Adapter Resources palette to the Design panel.

4. Specify the options in the Configuration tab and Advanced tab for the resource, then click the Apply button.

5. Create and configure the archives for other resources you want to add into the EAR file.

6. Click the Build Archive button to create the archive file.

Generating an EAR File in TIBCO Designer for a Project Using SSLThe EAR file generated as described in Generating an EAR File in TIBCO Designer does not include the certificate folders for a project using SSL. You need to manually add the certificate folder to the EAR file:

1. In the Project panel, click the Shared Archive folder of the EAR file.

If you make changes to the adapters or shared resources included in the archive, you must rebuild and redeploy the archive. Saving the project does not affect the archive.

If you want to create an archive for all the resources in your project, you can also select the Tools > Create Project EAR menu item, which creates the archive automatically for you.


Generating an EAR File in TIBCO Designer | 237

2. In the Configuration panel, click the Resources tab. Use the browse button to select the certificate folder from the project and add to the Resources tab, as shown in Figure 135. Click the Apply button.

Figure 135 Select A Resource Dialog for Shared Archive

After you add the certificate folder in the Resources tab, the certificates included in the folder will be displayed in the Dependencies (Resources) tab, as shown in Figure 136.



Figure 136 Dependencies (Resources) Tab with the Certificate Folder

3. Select the EAR file in the Project panel and click the Build Archive button in the Configuration panel to rebuild the EAR file.

After the rebuild, the EAR file will include the certificate directory for deployment.

EAR Configuration ReferenceYou can configure parameters for an EAR file and the archive resources it includes under the following tabs:

• Enterprise Archive Configuration Tab, page 238

• Adapter Archive Configuration Tab, page 239

• Adapter Archive Advanced Tab, page 240

Enterprise Archive Configuration Tab

Figure 137 shows the Configuration tab of an Enterprise Archive resource:



Figure 137 Enterprise Archive - Configuration Tab

Table 72 lists the fields in the tab.

Adapter Archive Configuration Tab

Figure 138 shows the Configuration tab of an Enterprise Archive resource:

Table 72 Enterprise Archive - Configuration Tab

Field Description

Name Name of the EAR file you are creating.

Description Description of the archive content.

Author Person creating the archive.

Archive Version Version of the archive.

Note: The user assigns this number. TIBCO Designer does not use this number.

File Location Location where this archive will be saved. Click the Browse button to select a different file location from the default.

Include All Service Level Global Variables

Check this checkbox to include all global variables in the archive.



Figure 138 Adapter Archive - Configuration Tab


Adapter Archive Advanced Tab


Table 73 Adapter Archive - Configuration Tab

Field Description

Name Name of the Adapter Archive.

Description Optional description of the Adapter Archive.

Author Optional author of the Adapter Archive.

Adapter Click the browse button and select the adapter you wish to associate with the archive.

Note: You need to create a new Adapter Archive for each adapter.

Deployment Plugin Deployment plugin class. This class must be an implementation of the com.tibco.tra.tsm.plugin.custom.CustomTSMPlugIn interface. TIBCO Administrator runs this code as part of the deployment process when it creates the TRA file.

In addition to providing a pointer to this class here, you must also add a JAR file to the Shared Archive that includes the class, so the class will be in the classpath.



Table 74 Adapter Archive - Advanced Tab

Field Description

Software Type Type of the associated adapter. This corresponds to the extension of the adapter project file (multi-file projects). This field is only available for Generic Adapter Configuration or for adapters that allow multiple software choices, such as the TIBCO Adapter for Tuxedo. This value must match the value set by the installer of the software or specified when custom software was added to the administration domain.

Update Version From Adapter

When you build the archive, TIBCO Designer includes the ActiveEnterprise version of the adapter associated with this archive by default. If you uncheck this checkbox, you can supply a different version instead.

Warning: If this checkbox is unchecked, the deployment ActiveEnterprise version value can go out of sync with the adapter’s value and result in serious compatibility issues.

Minimum Version Minimum version for the adapter. The value of this field is provided by the adapter and can be changed.



Starting TIBCO Administrator

You must start the administration server and TIBCO Hawk agent before starting the TIBCO Administrator GUI.

To start TIBCO Administrator, you can perform the following tasks in sequence:

• Task A Start the Administration Server and TIBCO Hawk Agent, page 242

• Task B Start the TIBCO Administrator GUI, page 243

For more starting options, see "Starting TIBCO Administrator" in TIBCO Administrator Admin User’s Guide.

Task A Start the Administration Server and TIBCO Hawk AgentTo start the administration server and TIBCO Hawk agent:


— Start the administration server by invoking the following commands:% cd TIBCO_ADMIN_DOMAIN_HOME\domainName\bin

% tibcoadmin_domainName.exe

— Start the TIBCO Hawk agent by invoking the following commands:% cd TIBCO_TRA_DOMAIN_HOME\domainName

% hawkagent_domainName.exe

• Under UNIX:

— Start the administration server by invoking the following commands: % cd TIBCO_ADMIN_DOMAIN_HOME/domainName/bin

% tibcoadmin_domainName

— Start the TIBCO Hawk agent by invoking the following command:% cd TIBCO_TRA_DOMAIN_HOME/domainName

% hawkagent_domainName


Starting TIBCO Administrator | 243

Task B Start the TIBCO Administrator GUITo start the TIBCO Administrator GUI:

1. Open a web browser and connect to the following URL: http://hostName:port/administrator/servlet/tibco_administrator

— hostName is the name of the machine on which the administration server has been installed. If this is the same machine you are currently on, you can use localhost as the machine name.

— port is 8080 by default. If you have used TIBCO Domain Utility to assign a different port, use that port number instead. If you created multiple domains on one machine, the port is incremented by 10 for each domain. For example, the second domain will use 8090.

2. Select the administration domain and log in as the domain administrator.



Creating an Application

To create an application, you need to import the EAR file generated in TIBCO Designer. See Generating an EAR File in TIBCO Designer on page 236 for more details. You can use the same EAR file to create multiple applications, and configure and deploy each application separately with different deployment options. You can also modify a deployed application, redeploy, and then revert to an earlier deployment if the changes you made do not have the desired result.

You can create an application by following these steps:

1. Select either the Application Management module, All Applications in the Application Management module, or a previously created folder.

2. In the displayed screen, click the New Application button.

Figure 139 shows the Application Management > Application Management screen.

Figure 139 Application Management > Application Management Screen

3. In the displayed Upload EAR File dialog, click the Browse button and select an EAR file. Click the OK button.

4. In the displayed New Application Configuration dialog, verify the information in the Application Archive pane, and specify options in the Application Parameters and Services pane. Figure 140 shows the New Application Configuration dialog.


Creating an Application | 245

Figure 140 New Application Configuration Dialog


Application Creation Choices

The Services pane provide you the following choices when creating an application:

• If the Quick Configure checkbox is checked, the services are bound to the targets that you select in the target field.

• If the Quick Configure checkbox is checked, the Deploy On Save checkbox is enabled:

— If the Deploy On Save checkbox is checked, when you click the Save button, the application is created and immediately deployed to the target machines specified in the Target column of the Services pane. All variables, logging and other configuration values will use defaults defined in the archive file. The Configuration Console will display the deployment status.



• If the Deploy On Save checkbox is unchecked, you must explicitly deploy the application by using the Configuration Console. You can use the console to change settings, such as global variable settings before deploying.

For more details about the configuration, see "Creating an Application" in TIBCO Administrator Admin User’s Guide.


Changing Application Properties | 247

Changing Application Properties

When you create an application, the EAR file you import has values defined for global variables, runtime properties, and so on. The adapter service in the archive have configuration properties set as well. When you deploy the application, you can use the property values set in the archive, or change the values.

This section explains how to manage the configuration properties at deployment for an adapter application:

• Overview of Configuration Console, page 247

• Tuning Performance Factors, page 248

• Working with Global Variables at Deployment, page 250

• Changing Adapter Properties, page 252

For more deployment options, see "Setting Deployment Options" in TIBCO Administrator Admin User’s Guide.

Overview of Configuration ConsoleYou can use the Configuration console for the application you created to:

• Manage the properties of the application at the application level, service level, and service instance level.

• Perform the following deployment operations:

— Deploying and undeploying an application.

— Updating an application.

— Reverting a deployment: choosing an earlier deployment configuration if there was one.

— Viewing the deployment history.

To open the console, select the application from either the Application Management module, All Applications in the Application Management module, or the folder which includes the application.

The console consists of two panes, Configuration Builder and Deployed Configuration. Each pane contains applications, service configurations, and service instances. Figure 141 shows the Configuration console.



Figure 141 Application Configuration Console

• Configuration Builder Use this pane to change properties for the deployment.

• Deployed Configuration View the deployment properties after deploying an application. When you select an application, service or service instance in the Deployed Configuration panel, the displayed dialog is read-only.

Tuning Performance FactorsThis section describes the memory and throughput considerations to be made, while tuning factors affecting the performance of the adapter.

For Publication Service

When the publishing mode is configured to Explode or Exploded Batch, additional memory overhead will be added to the adapter and this will affect the number of connections that may be used for processing messages.

For Exploded Batch publishing mode, the packet size property maintained in the Outbound partner profile needs to be maintained accordingly based on the size of the IDoc message and the number of connections being used for processing the messages.

Java Virtual Machine Parameters

TIBCO ActiveMatrix Adapter for SAP runs in a Java Virtual Machine (JVM). The JVM settings affect the overall performance of the adapter. Java provides some parameters to tune the memory usage and optimize adapter performance:

• Heap Size

ApplicationService

Service Instance



You can use the following parameters to set the heap size for the adapter. These properties can be maintained in TIBCO Administrator or in the TRA file:

— Initial Heap Size (MB)

— Maximum Heap Size (MB)

— Java Thread Stack Size (MB)

TIBCO ActiveMatrix Adapter for SAP 7.0 is configured to either use the Client JVM or ServerJVM, which is maintained in the adapter TRA file. While sizing and tuning your environment, consider the following:

— The total memory used by the JVM (memory footprint) is dependent on the type of JVM used (Server JVM or ClientJVM), JVM version, and the JVM vendor.

— A ServerJVM occupies a higher memory footprint and may result in higher performance when compared to a ClientJVM.

— A ClientJVM can have a lower startup time and memory footprint.

for detailed information on tuning the JVM to suit your business needs, see the JVM Tuning Guide of the JVM used in your environment. You may also consult your JVM vendor for details about the exact memory footprint and heap management in the JVM version used in your environment.

• Garbage Collection

During the processing of message, a created Java object occupies memory from the time it is created to the time it is destroyed. Java provides garbage collection, an automated mechanism to clean up objects that still exist but are no longer used.

To retrieve garbage collection metric for the adapter, you can specify the Java memory parameters by using the Java extended properties option in the adapter TRA file:

java.extended.properties=-Xloggc:FileName

As part of the installation of the adapter, template TRA files with recommended settings are provided for running the adapter. The location of the template TRA files is: TIB_ADR3_HOME/bin.



Working with Global Variables at DeploymentThe EAR file of an application contains global variables with values set at design time. Depending on the definition of the global variables at design time, you can redefine the variables in TIBCO Administrator at:

• Application level.

• Service level (as runtime variables).

• Service instance level (as runtime variables).

This section gives an overview of how to change and use global variables at deployment:

• Changing Global Variables, page 250

• Precedence of Global Variables, page 251

See Working with Global Variables at Design Time on page 63 for details on defining global variables at design time.

See also:

• "Variable Substitution" in TIBCO Adapter SDK Programmer’s Guide for the variable substitution mechanism.

• "Global Variables" in TIBCO Administrator Admin Server Guide for detailed information about changing and using global variables at deployment.

Changing Global Variables

Whether a global variable is configurable at deployment and at the service or service instance level depend on the definition of the variable at design time. See Specifying Global Variables on page 63 for detailed information.

To change the value of a global variable, use the Configuration and Builder pane and follow these steps:

1. Select the level at which you want to change the variable:

— Application In the displayed Edit Application Configuration dialog, click the Advanced tab and change the variable in the Global Variables pane.

— Service In the displayed Edit Service Configuration dialog, click the Advanced tab and change the variable in the Runtime Variables pane.

Service level variables are only included in the service archive (AAR) file.

— Service Instance In the displayed Edit Service Instance dialog, click the Advanced tab and change the variable in the Runtime Variables pane.




After making the changes, you need to redeploy the application to use the new values. When you deploy the application and run the configured components, all occurrences of a global variable name are replaced with the value of that variable, unless it was overridden in a way that had higher precedence. For example, if you defined the value for the RvServiceTest global variable as 7800, the variable will be replaced with 7800 at runtime.

Precedence of Global Variables

A variable value set at the service instance level overrides the same variable value set at the service level. Similarly, a variable value set at the service level overrides the same variable set at the application level.

The rules for resolving global variable values are as follows:

• If the variable value is set at the service instance level and the value is different than the variable value set in the EAR file or the variable is not deployment configurable, the value set at the service instance level is written to the TRA file of the deployed service instance and used at runtime.

• If the value at the service instance level is the same as the value inside the EAR file, but the value set at the service level is different, that value at the service level is written to the repository of the application, not to the TRA file of the deployed service instances. At runtime, the service instance gets the value from the repository of the application.

• If the variable value set at the service instance level and the variable value set at the service level are the same as the value in the EAR file, but the value set at the application level is different, that value at the application level is written to the repository of the application, not to the TRA file of the deployed service instances. At runtime, the service instance gets the value from the repository of the application.

• If the value of the variable at all the three levels, application, service and service instance, is identical to the one inside the EAR file, the behavior is the same as that described in the previous bullet. However, if the variable is not deployment configurable, the default value will be written to the TRA file of the deployed service instances.

See "Changing Global Variables at Deployment" in TIBCO Administrator Admin User’s Guide for more details and examples of the rules.

Click the Reset To Defaults button to reset all the global variables to the default values defined in the EAR file.



Changing Adapter PropertiesTIBCO ActiveMatrix Adapter for SAP includes a set of adapter properties to set defaults as runtime variables for deployed services. The property substitution mechanism can override property values predefined in the project repository in a restricted manner at runtime. For the adapter properties supported in TIBCO ActiveMatrix Adapter for SAP, see Appendix C, Adapter Properties File, on page 335.

This section gives an overview of how to change and use adapter SDK properties at deployment:

• Changing Adapter Properties, page 252

• Precedence of Adapter Properties, page 253

Changing Adapter Properties

You can change adapter properties in TIBCO Administrator at the service level, in the adapter template TRA file, or in the TRA file of the deployed service instances.

To Change Adapter Properties in TIBCO Administrator (Recommended)

TIBCO recommends you maintain adapter properties by using TIBCO Administrator.

To change a property value in TIBCO Administrator:

1. Select the service in the Configuration and Builder pane for the application.

2. In the displayed Edit Service Configuration dialog, click the Advanced tab and change the variable value in the Adapter SDK Properties pane.


After making the changes, you need to redeploy the application to use the new value. When you deploy the application and run the configured components, the changed values will be used, unless they were overridden in a way that had higher precedence.

To Change Adapter Properties in the Adapter TRA File

To change a property value in the Adapter TRA file:

1. Open the TRA file under the TIB_ADR3_HOME/bin directory.

Click the Reset To Defaults button to reset all the adapter properties to the default values defined in the EAR file.



2. Add or edit the properties, and save the file.

After making the changes, you need to redeploy the application to use the new values. When you deploy the application and run the configured components, all occurrences of an adapter’s properties are replaced with the value of that variable, unless it was overridden in a way that had higher precedence.

To Change Adapter Properties in the TRA File of a Deployed Service

To change a property value in the TRA file of a deployed service:

1. Open the TRA file for the deployed service under the TIBCO_TRA_DOMAIN_HOME/domainName/application/applicationDeploymentName directory.

2. Add or edit the properties, and save the file.

After making the changes, you need to redeploy the application to use the new values. When you deploy the application and run the configured components, all the changed property values will be used.

TIBCO recommends you maintain property values by using TIBCO Administrator, not the TRA file of a deployed service. Changes in the TRA file will be lost if you redeploy the application.

Precedence of Adapter Properties

The rules for resolving adapter property values are as follows:

• A property value set in the TRA file of a deployed service overrides the same property set in TIBCO Administrator.

• A property value set in TIBCO Administrator overrides the same property set in the EAR file.

• A property value set in the EAR file overrides the same property set in the adapter TRA file in the TIB_ADR3_HOME/bin directory.

• If you do not set the property value in any way, the default value of the property will be used.

TIBCO recommends you maintain property values by using TIBCO Administrator, not the TRA file of a deployed service. Changes in the TRA file will be lost if you redeploy the application.



Deploying an Application

When you create an application, you can check the Deploy On Save checkbox to deploy the application when saving. The application then uses the global variables and other options set in the EAR file. If you do not use the Deploy on Save option, you must explicitly deploy the application after changing deployment configuration options.

To deploy an application:

1. Select the application in the Application Management module.

2. Before deploying, you can change deployment options. See Changing Application Properties on page 247 for details.

3. Click the Deploy button. The Deploy Configuration dialog is displayed. Use the dialog to add a description and specify the deployment options. See Deployment Choices on page 255 for details. Figure 142 shows the Deploy Configuration dialog.

Figure 142 Deploy Configuration Dialog

4. Click the OK button to deploy the application.

If you redeploy an application, all the current running services with configuration changes in this application will be stopped.

During deployment, TIBCO Administrator dynamically builds a DAT file for the deployed application and TRA files for the deployed services:

• DAT file for application:


Deploying an Application | 255

TIBCO_TRA_DOMAIN_HOME/domainName/data/applicationDeploymentName.dat

• TRA files for deployed services of the application:

TIBCO_TRA_DOMAIN_HOME/domainName/application/applicationDeploymentName/applicationDeploymentName-ServiceName.tra

Deployment ChoicesYou can make changes to a deployed application, and then deploy the changed application. The currently deployed application can continue to run while you make changes. When you deploy the updated application, the current application is automatically undeployed. You can revert to a previously deployed application, if the changes you made need to be rolled back.

You can:

• Select Stop Running Services Before Deployment to stop all running services before deploying the application. All services that should be redeployed are stopped. If, however, a service instance is in sync and Force Redeployment Of All Services is not enabled, the running instance is not stopped. This option is disabled if any target machine has a TIBCO Hawk agent version lower than 5.3.

• Indicate how many seconds can elapse after a stop request before a service is killed, using the Stop command, in Kill Services That Haven't Stopped After (Seconds).

• Select Start Successfully Deployed Services to stop and restart the services in the application after they have been successfully deployed. If you do not select this option, you can explicitly start the services later.

• Select Force Redeployment Of All Services to redeploy all services even if a service is in a synchronized state. This is useful if you have manually changed deployment files, or if you need to define NT Services for multiple hosts in a Microsoft Cluster.

• Select Dynamic Symmetric Key to encrypt sensitive application data using a dynamically generated encryption key.

If the Stop Running Services Before Deployment option is cleared, service instances in a deployable state are not stopped while they are redeployed. However, they will be stopped after a successful deployment. This option has no impact on the service instances that are in a synchronized state unless the Force Redeployment Of All Services option is selected.

If the Start Successfully Deployed Services option is enabled and the Stop Running Services Before Deployment option is cleared:



• Existing service instances in the running state are first stopped then restarted after TRA and CMD files on the target machines are updated.

• Existing service instances not in the running state are restarted when they are deployed.

• Newly added service instances are restarted.

• Removed service instances are stopped before they are removed.


| 257

Chapter 12 Managing and Monitoring an Adapter Project

After you deploy your project to an application by using TIBCO Administrator, you can use TIBCO Administrator to start, stop, and perform more management functions with the application. You can use TIBCO Hawk for more monitoring options.

This chapter introduces how to manage and monitor an adapter application.

See also:

• "TIBCO Administrator" in TIBCO ActiveMatrix Adapter for SAP Concepts for a brief overview and important concepts of TIBCO Administrator.

• The TIBCO Administrator documentation.

• "TIBCO Hawk" in TIBCO ActiveMatrix Adapter for SAP Concepts for a brief overview and important concepts of TIBCO Hawk.

• The TIBCO Hawk documentation.

Topics

• Starting and Stopping a Service Instance, page 258

• Viewing Log File Information, page 260

• Configuring Monitoring Options for Using TIBCO Hawk, page 262

• Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator, page 264

• Monitoring a Service by Using TIBCO Hawk Display, page 269


258 | Chapter 12 Managing and Monitoring an Adapter Project

Starting and Stopping a Service Instance

This section explains how to start or stop a service instance for an adapter application in TIBCO Administrator:

• Overview of Service Instances Console on page 258

• Starting and Stopping a Service Instance on page 259

For more management options, see "Managing and Monitoring Process Engines and Service Instances" and "Deploying, Starting and Monitoring an Adapter" in TIBCO Administrator Admin User’s Guide.

Overview of Service Instances ConsoleYou can use the All Service Instances console of the Application Management module or the Service Instances console for the application you created to:

• View the information of each service instance.

• Perform the following management operations:

— Starting a service instance.

— Restarting a service instance.

— Stopping a service instance.

— Killing a service instance.

To open the All Service Instances console, select the Application Management module. To open the Service Instances console for the application you created, select the application from the All Applications console in the Application Management module, or the folder which includes the application.

Figure 143 shows the All Service Instances console.


Starting and Stopping a Service Instance | 259

Figure 143 All Service Instances Console

Starting and Stopping a Service InstanceAfter you have deployed an application, you can start or stop the service instances in different ways by using the All Service Instances console or the Service Instances console in the TIBCO Administrator GUI:

• In the Application Management > All Service Instances console, check the checkbox next to a service, and then click the appropriate buttons that are enabled.

• In the Application Management > All Service Instances console, click the service instance name. In the displayed View Service Instance dialog, click the General tab. Click the clickable link next to the State field to start or stop the service instance.

• In the Application Management > ApplicationName > Service Instances console, check the checkbox next to a service instance, and then click the appropriate buttons that are enabled.

• Explicitly start services after deployment. See Deployment Choices on page 255 for information about starting services when deploying.



Viewing Log File Information

For each deployed service instance, TIBCO Administrator dynamically saves tracing information for the instance into a separate log file located in the TIBCO_TRA_DOMAIN_HOME/domainName/application/log directory.

Based on the tracing options you set in TIBCO Designer, you can view the tracing information for a service instance and set search parameters to display only a subset of a log file. You can also export the log to a file.

For more monitoring functions using TIBCO Administrator, see "Managing and Monitoring Process Engines and Service Instances" in TIBCO Administrator Admin User’s Guide.

To view the tracing information for a service instance:

1. Select the service instance from either the All Service Instances console or the Service Instances console for the application.

2. In the displayed View Service Instance dialog, click the Tracing tab.

3. Specify the log file in the "File Is" drop-down list and customize the number of lines to return in the Lines To Fetch Less Than field.

To add more search conditions, click the Add Search Condition link.

4. Click the Search button. The tracing information table with the filtered log is displayed. With the table, you can view the details of each tracing message, and export the selected tracing messages.

Figure 144 shows the Tracing tab of the View Service Instance dialog for a service instance.


Viewing Log File Information | 261

Figure 144 View Service Instance - Tracing Tab



Configuring Monitoring Options for Using TIBCO Hawk

Before using TIBCO Hawk, you need to configure monitoring options in TIBCO Designer and save the configuration to your project. This section introduces the following configuration options:

• Enabling TIBCO Hawk, page 262

• (Optional) Defining a TIBCO Hawk Session, page 262

Enabling TIBCO HawkBefore using TIBCO Hawk with TIBCO ActiveMatrix Adapter for SAP, you must enable the TIBCO Hawk microagents in TIBCO Designer. To do this, set the HawkEnabled global variable to true. You can only set this variable for deployed adapter services. Services in the test environment are not normally monitored and administered.

If you are using non-default transport parameters for TIBCO Hawk, you must also set the TIBHawkDaemon, TIBHawkNetwork, and TIBHawkService global variables to the values for the transport you are using.

See Appendix C, "Predefined Global Variables", in TIBCO Designer User’s Guide for detailed information about the global variables for TIBCO Hawk.

(Optional) Defining a TIBCO Hawk SessionTo use TIBCO Hawk to monitor the adapter, you must first define a TIBCO Rendezvous session in TIBCO Designer. A preconfigured default TIBCO Hawk session is available. The default session is created when you add an adapter instance in TIBCO Designer. You can modify the settings of the preconfigured session provided or define a new one.

To define a TIBCO Hawk session:

1. Select the adapter instance in the Project panel. Select Advanced > Sessions folder of the instance.

2. If you want to configure the default TIBCO Hawk session:

a. Select the R3HawkDefault session.

b. Configure the session in the Configuration panel.

Make sure you have set the correct parameter value for the global variables that correspond to the TIBCO Hawk configuration. If the session


Configuring Monitoring Options for Using TIBCO Hawk | 263

parameters are not set properly, the microagents will not be displayed in the TIBCO Hawk monitoring console.

Figure 145 shows the Configuration tab for a TIBCO Hawk session.

Figure 145 TIBCO Hawk Session Configuration Tab

3. If you want to define a new TIBCO Hawk session:

a. Drag the GenericSession icon from the Palettes panel to the Design panel.

b. In the Configuration panel, select the RV item from the Session Type drop-down list. Click the Apply button.

c. Configure the session in the Configuration tab, which is similar to the Configuration tab shown in Figure 145:

In the Name field, enter the name previously assigned in the Default MicroAgent Session field under the Monitoring tab. See Monitoring Tab on page 95 for details.

In the Service field, enter 7474 (the default used by TIBCO Hawk).

In the Daemon field, enter tcp:7474 (the default used by TIBCO Hawk).

Make sure you have set the correct parameter value for the global variables that correspond to the TIBCO Hawk configuration. If the session parameters are not set properly, the microagents will not be displayed in the TIBCO Hawk monitoring console.

4. Click the Apply button and save the project.

See Appendix C, "Predefined Global Variables", in TIBCO Designer User’s Guide for detailed information about the global variables for TIBCO Hawk.



Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO

Administrator

This section explains how to invoke a microagent method for a service instance and how to add a rulebase at the service level by using TIBCO Hawk Plug-in for TIBCO Administrator.

See Appendix E, Adapter Microagents and Methods, on page 439 for the microagent methods supported for TIBCO ActiveMatrix Adapter for SAP.

See also:

• TIBCO Hawk Plug-in For TIBCO Administrator in the TIBCO Hawk documentation set for detailed information about the plug-in.

• "Setting Deployment Options" in TIBCO Administrator Admin User’s Guide for detailed information about how to use the plug-in in TIBCO Administrator.

Invoking a Microagent MethodAfter deploying TIBCO Hawk Plug-in for TIBCO Administrator, you can access the microagent methods for a running service instance in different ways:

• In the Monitoring Management > Hawk console, select the appropriate domain, the appropriate agent in the Agents tab, and the appropriate microagent for the running service instance.

• In the Monitoring Management > Hawk console, select the appropriate domain, the appropriate agent in the Microagents tab, and the appropriate microagent for the running service instance.

• In the Application Management module, from either the All Service Instances console or the Service Instances console of the application, select the running service instance, and click the Methods tab.

• In the Resource Management module, select the appropriate machine, and the appropriate microagent in the Agent tab.

Figure 146 shows the available methods of an adapter microagent displayed in the Microagent dialog from the Hawk console.


Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator | 265

Figure 146 Hawk Console - Microagent Dialog

Click the method you want to invoke, the displayed Method dialog shows a Method pane with the detailed definition of the method and an Invocation pane for you to invoke or subscribe to the method.

Figure 147 shows the Method dialog for the getAdapterServiceInstance method of an adapter microagent.



Figure 147 Hawk Console - Microagent Dialog - Method Dialog

Enter the values in the Parameters fields and click the Invoke button to invoke the method. The method results will be displayed.

You can also subscribe the method by checking the Subscribe checkbox.

Adding a Rulebase to a ServiceThe TIBCO Hawk agent in the administration domain monitors managed objects by processing rulebases.

Using TIBCO Hawk Display, you can create rulebases with specialized rules. With TIBCO Hawk, you can specify a very large number of alert conditions and alert results. See TIBCO Hawk Administrator’s Guide for how to create a rulebase using TIBCO Hawk Display.

You can add rulebases to an application at the service level by using TIBCO Hawk Plug-in for TIBCO Administrator. You can load the same rulebase to a single service, or multiple services.

Multiple rules defined in the same rulebase can monitor a particular application or system function. For example, an application rulebase can include one rule for issuing a medium-level alert if disk space or CPU usage exceeds certain thresholds. Another rule can issue a high-level alert and send a pager message to the system administrator if the application process terminates.

TIBCO Hawk Display is not included in TIBCO Runtime Agent. You must purchase the full TIBCO Hawk product to create TIBCO Hawk rulebases.


Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator | 267

To add a custom rulebase at the service level:

1. In the Application Management module, from the Configuration console of the application, select the appropriate service.

2. Click the Monitoring tab.

3. In the Rulebases pane, click the Add button.

4. In the displayed Upload Rule Base File dialog, click the Browse button and select a rulebase.



When you deploy the service, the TIBCO Hawk agent saves the rulebase file in the TIBCO_TRA_DOMAIN_HOME/domainName/rulebase folder. If you change the original rulebase, you must reload it into the service and redeploy the application.

When the conditions specified in the rulebase occur, you can view the alerts in different ways:

• In the Resource Management > Machines console, select the appropriate machine, and click the General tab.

• In the Monitoring Management > All Alert console, search the alerts based on specified conditions.

Figure 148 shows several alerts that have been generated based on a rulebase in the View Machine dialog.



Figure 148 Machine Console - View Machine Dialog


Monitoring a Service by Using TIBCO Hawk Display | 269

Monitoring a Service by Using TIBCO Hawk Display

This section explains how to invoke a microagent method by using TIBCO Hawk Display.

See Appendix E, Adapter Microagents and Methods, on page 439 for the microagent methods supported for TIBCO ActiveMatrix Adapter for SAP.

See TIBCO Hawk Administrator’s Guide for detailed information about using TIBCO Hawk Display.

Enabling TIBCO HawkBefore using TIBCO Hawk with TIBCO ActiveMatrix Adapter for SAP, you must enable the TIBCO Hawk microagents in TIBCO Designer. To do this, set the HawkEnabled global variable to true. This can only be set for deployed adapter services. Services in the test environment are not normally monitored and administered.

If you are using non-default transport parameters for TIBCO Hawk, you must also set the TIBHawkDaemon, TIBHawkNetwork, and TIBHawkService global variables to the values for the transport you are using.

See "Predefined Global Variables" in TIBCO Designer User’s Guide for detailed information about the global variables for TIBCO Hawk.

Starting TIBCO Hawk DisplayTo start TIBCO Hawk Display:


From the Start menu, select All Programs > TIBCO > [ENV_NAME >] TIBCO Hawk n.n > Hawk Display

or

Invoke USER_HOME\ENV_NAME\tibco\cfgmgmt\hawk\bin\tibhawkdisplay.exe in a command prompt.

• Under UNIX:

Invoke tibhawkdisplay in a command console.



Invoking a Microagent MethodTo invoke a microagent method:

1. In TIBCO Hawk Display, right-click on the agent icon and select Get Microagents from the context menu.

If TIBCO Hawk security is implemented on your system and you do not have access to microagents on this agent, an error dialog displays. Select another agent, or contact your system administrator to obtain access.

The Microagents, Methods And Arguments dialog is displayed. The panel on the upper left lists microagents you can access on the current agent. Figure 149 shows the dialog.

Figure 149 Microagents, Methods And Arguments Dialog

2. Click a microagent name to display a list of associated methods and text descriptions in the panels below.

Click the name of the method to invoke, for example, the getMicroAgentInfo method. If the method accepts arguments, fields for each argument will be displayed in the upper right panel. Detailed help text will be displayed in the lower panel. Figure 150 shows the method information for the getMicroAgentInfo method.


Monitoring a Service by Using TIBCO Hawk Display | 271

Figure 150 Microagents, Methods And Arguments Dialog - getComponentInfo method

3. Specify any arguments for the method.

4. Select the Invoke radio button and click the Invoke button to invoke the selected method. The displayed Invocation Results dialog shows the results returned by the method. Figure 151 shows the results of the getMicroAgentInfo method as an example.



Figure 151 Invocation Results - getComponentInfo method

5. Click the Done button to close the dialog.


| 273

Chapter 13 Advanced Topics

This chapter introduces the advanced configuration and deployment topics for TIBCO ActiveMatrix Adapter for SAP.

Topics

• Configuring Advanced Logging Options for an Adapter Instance, page 274

• Setting TIBCO Messaging Encoding, page 280

• Connecting with the SAP System, page 282

• Password Handling, page 288

• Compressing JMS Messages, page 289

• Inbound BAPI Transactional Support, page 290

• Invoking BAPI/RFCs Using Transactional Semantics in SAP, page 296

• Multithreading, page 301

• Multiple Connections, page 303

• Event Driven Inbound Connections, page 310

• Connecting an Adapter Instance to Two SAP Systems with a Single Connection, page 312

• Using JMS Destination Bridges, page 314

• Saving an IDoc to a Directory, page 315

• Load Balancing Using Distributed Queue, page 317

• Configuring Valid Destinations, page 323


274 | Chapter 13 Advanced Topics

Configuring Advanced Logging Options for an Adapter Instance

TIBCO ActiveMatrix Adapter for SAP supports a few different logging mechanisms:

• Using TIBCO Adapter SDK for Logging, page 274

• Using Log4J for Logging, page 277

The basic and advanced logging features are provided by TIBCO Adapter SDK. The adapter also supports logging through the Log4J utility.

Using TIBCO Adapter SDK for LoggingLogging by using TIBCO Adapter SDK has two main features which are:

• Use Basic Logging Features, page 274

• Using Advanced Logging Features, page 275

Use Basic Logging Features

You can use the Logging tab of the configuration resource for an adapter instance to configure the logging options. See Logging Tab on page 91 for the options available in the tab.

By default, all error, warning, and information messages are printed in the console window in which the configuration was started and to a default log file. The log file can be located anywhere on your file system.

The adapter will trace to any sink in your adapter instance configuration. If you have the default stdioSink and fileSink sinks, the adapter will write to both the file and stdout.

Log File Size

When a log file name is specified in the Logging tab, the adapter instance does the following:

1. The adapter instance creates a file with no extension, using the file name specified in TIBCO Designer.

Only errors that originate in the adapter instance itself are logged in the log file. Errors from other sources, for example TIBCO Rendezvous APIs or TIBCO Adapter SDK APIs, are not logged to a log file, but are printed to the console window where the configuration started.


Configuring Advanced Logging Options for an Adapter Instance | 275

2. The adapter instance redirects all trace statements generated by this configuration to that file until it reaches the default file size of 30 KB.

3. When this file size is reached (that is, as soon as the file is greater than or equal to the limit), the adapter instance renames the current file to filename.1 and creates a new file with no extension.

4. The adapter instance repeats this process of rolling log files and renaming files each time a new file is generated, until three log files exist.

With these default settings, the adapter instance overwrites the oldest file after three files have been created and the last file reaches 30 KB. For instructions on changing the default settings, see Using Advanced Logging Features.

Using Advanced Logging Features

When you check the Use Advanced Logging checkbox in the Logging tab, you have complete control selecting the destinations and associating desired roles with each of the destinations.

To access advanced logging features and configure the file sink for logging, follow these steps:

1. Check the Use Advanced Logging checkbox in the Logging tab, then click the Apply button. The logging tab displays the information as shown in Figure 152.

Figure 152 Adapter Instance - Logging Tab for Advanced Logging

2. In the Project panel, expand adapter_instance_name > Advanced > Log Sinks > fileSink.

The log file can be slightly larger than the limit because the new file is only created after the limit has been reached.



Figure 153 File Sink for an Adapter Instance

Three types of logs that you can configure to hold trace messages, corresponding to three levels (roles) of trace messages are available by default: Information, Warning, and Error.

You can also include trace messages of Debug level in the log sink. This option writes much debugging information to the log file and significantly reduces the speed of the adapter. Do not select this level unless requested by the TIBCO Product Support Group.

3. Configure the Log Sink in the Configuration panel.

In addition to the predefined file sink or STDIO sink, you can also create additional sinks of any of the following types by dragging a Generic Log Sink resource from the Palette panel to the Design panel.

— File A file sink sends logging information to files.

— Hawk A HAWK sink uses the TIBCO Hawk session, created and used by the adapter for monitoring purposes, to send logging information to TIBCO Hawk.

For details on Hawk sessions, see (Optional) Defining a TIBCO Hawk Session on page 262.

— Network A Network sink sends logging information on TIBCO Rendezvous.

— STDIO A STDIO sink sends logging information to standard I/O.

See “Custom Log Sink Reference” in TIBCO Designer Palette Reference for configuration options of each type of sink.



Using Log4J for LoggingIn addition to the logging features provided by TIBCO Adapter SDK, you can also configure the adapter to use Log4J for the following logging features:

• Dynamically change log levels without having to recycle or re-deploy the adapter.

• Maintain logging at the adapter service level and adapter service instance level.

This section introduces how to use Log4J for adapter logging:

• Enable Log4J for Logging, page 277

• Change the Log Level of the Adapter, page 278

• Maintain Logging at the Adapter Service Level, page 278

• Maintain Logging at the Adapter Service Instance Level, page 279

Enable Log4J for Logging

To enable the adapter to use Log4J for logging, you need to set the following TRA properties in TIBCO Administrator or in the TRA files.

• Set adr3.trace.extended to ON.

• Set adr3.trace.log4j.properties to a Log4J properties file.

See Changing Application Properties on page 247 for how to change the properties at runtime.

TIBCO ActiveMatrix Adapter for SAP provides a default log4j.properties file and template file for the adapter, TIDManager, and Discovery Agent respectively. The properties files are located in the TIB_ADR3_HOME/bin directory and contain the following lines, see Figure 154.

Figure 154 Log4j Properties



Change the Log Level of the Adapter

To effectively change log levels at runtime, it is recommended that you select all roles in the Logging tab of the adapter instance in the TIBCO Designer project.

The default log level of the adapter is INFO. With the exception of DEBUG trace messages, all trace messages related to log level INFO, WARN, and ERROR are provided in the adapter log.

To change the log level of the adapter dynamically, follow these steps:

1. Modify the log level of the log4j.rootLogger property in the Log4j properties file. The log levels can either be DEBUG, ERROR, WARN, or INFO.

2. Save the modified Log4J properties file.

3. Invoke the refreshExtendedLogging() TIBCO Hawk method available from the custom microagent of TIBCO ActiveMatrix Adapter for SAP. After the method is invoked successfully, the changes take effect.

Maintain Logging at the Adapter Service Level

You can configure the Log4J logging at the adapter service level, if an adapter contains multiple adapter services and different logging is required at the adapter service level.

Table 75 lists information on the various adapter services supported by the adapter.

The following example demonstrates how to set different logging options for the Publication Services and Subscription Services of an adapter:

log4j.rootLogger=info, defaultlog4j.renderer.com.tibco.SAP.trace.SAPMessage=com.tibco.SAP.trace.SAPMessageRenderer

To disable logging entirely, set the log level to OFF.

Table 75 Adapter Services Supported by TIBCO ActiveMatrix Adapter for SAP

Adapter Service Package Class

Publication Service com.tibco.SAP.adapter.services SAPPublisherImpl

Subscription Service com.tibco.SAP.adapter.services SAPSubscriberImpl

Request-Response Invocation Service com.tibco.SAP.adapter.services SAPReqRespInvocImpl

Request-Response Service com.tibco.SAP.adapter.services SAPReqRespImpl



log4j.appender.default=com.tibco.SAP.trace.SAPSDKLog4JAppenderlog4j.logger.com.tibco.SAP.adapter.services.SAPSubscriberImpl=debuglog4j.logger.com.tibco.SAP.adapter.services.SAPPublisherImpl=error

In the above example, the root logger is set to INFO. This means that all adapter services with the exception of Publication Services and Subscription Services will behave the same way and be set to INFO. All Publication Services will be set to level ERROR. All Subscription Services will be set to level DEBUG.

Maintain Logging at the Adapter Service Instance Level

If you want different logging behaviors for each instance of an adapter service, you need to enable the adr3.trace.service TRA property and set it to ON.

Logging at the adapter instance level is useful in cases where you have similar adapter services but the amount of logging is different for each service. For example, you have a MATMAS05Subscriber Subscription Service that runs frequently and another DEBMAS04Subcriber Subscription Service that runs once per day. In this example, you can configure the service that runs frequently to a log level of WARN or ERROR only, and configure the service that runs once per day to INFO:

log4j.rootLogger=info, defaultlog4j.renderer.com.tibco.SAP.trace.SAPMessage=com.tibco.SAP.trace.SAPMessageRendererlog4j.appender.default=com.tibco.SAP.trace.SAPSDKLog4JAppenderlog4j.logger.com.tibco.SAP.adapter.services.SAPSubscriberImpl.MATMAS05Subscriber=errorlog4j.logger.com.tibco.SAP.adapter.services.SAPSubscriberImpl.DEBMAS04Subscriber=info

The trace messages controlled by the configuration are only relevant to the packages and classes used by the specific adapter service. Other trace messages are still output to the adapter log.



Setting TIBCO Messaging Encoding

Unicode is a way to represent characters of all known languages of the world. TIBCO Adapters support data transmission in all languages by taking advantage of Unicode. The data conversion is achevied in two separate phases, between the the adapter and the TIBCO messaging bus and between the adapter and the target application. This section introduces the following topics related to the data conversion between the adapter and the TIBCO messaging bus:

• TIBCO Messaging Encoding Options, page 280

• Setting Encoding at Design Time, page 280

• Setting Encoding at Runtime, page 281

See TIBCO ActiveMatrix Adapter for SAP Concepts for an introduction to the multilingual support by TIBCO ActiveMatrix Adapter for SAP.

TIBCO Messaging Encoding OptionsTwo encoding options are available for TIBCO messaging encoding as listed in Table 76.

Although the value is set to ISO8859-1 by default, for TIBCO ActiveMatrix Adapter for SAP, it is recommended that you set the message encoding to UTF-8, even in cases where the SAP system is not a Unicode system.

Setting Encoding at Design TimeIf the project's configurations are saved in a local project file, which is the normal case when the project is in design stage before deployment, the TIBCO Messaging encoding is determined by the encoding property saved in the local project file.

To set the encoding option, follow these steps:

1. Start TIBCO Designer and open a project.

2. Click the root project folder in the Project panel, then click the Project Settings tab in the Configuration panel.

Table 76 TIBCO Messaging Encoding Options

Adapter Encoding Description

ISO8859-1 ISO8859-1 (Latin-1), West European

UTF-8 Unicode Transformation Format-8


Setting TIBCO Messaging Encoding | 281

3. Select the encoding value from the TIBCO Messaging Encoding drop-down list. See Figure 155.

Figure 155 Setting TIBCO Messaging Encoding Options

Setting Encoding at RuntimeThe TIBCO administration server setting is used when the project is exported to a server repository or deployed using TIBCO Administrator Enterprise Edition.

For a server-based project, the TIBCO messaging encoding is set by the repo.encoding property in the server's tibcoadmindomain_name.tra configuration file (located in TIBCO_HOME\administrator\domain\Admin\bin\).

The encoding is set when using the TIBCO Domain Utility to create the domain or by editing the repo.encoding property in the TRA configuration file.

Each adapter or TIBCO application that uses the same server for storing and retrieving configuration data uses this encoding setting when communicating to each other. This assures that all TIBCO components (including adapters and other TIBCO applications) that belong to the same project use the same encoding value to communicate.



Connecting with the SAP System

This section introduces how to manage connectivity with the SAP system and how to configure multiple connections for an adapter instance:

• Managing the Connectivity with the SAP System, page 282

• Adapter Reconnection with the SAP System, page 283

• Adapter Connecting to Multiple Client Connection Pools, page 283

• Configuring Multiple Connections for Inbound Instance, page 283

• Configuring Multiple Connections for Outbound Instance, page 284

• Connecting to the SAP System Using bgRFC, page 285

Managing the Connectivity with the SAP SystemAlthough you can continue to use the same connection parameters for the SAP server at design time and runtime, you also have the option to specify different design-time and runtime connection parameters. This ensures that you can migrate from one SAP system to another by specifying different system details in the Design-time Connection and the Runtime Connection tabs. Since the schemas are generated at design time using the server details specified in the Design-time Connection tab, the references are not broken if you change the SAP system details in the Runtime Connection tab. However, for the adapter to work, the schemas on both systems must be identical.

Additionally, you can specify the global variables for the server details in the Runtime Connection tab, and provide the values at runtime or by using the TRA properties file of the adapter. This allows you to migrate the project from one SAP system to another without modifying the project file. You only need to modify the properties file.

To specify global variables for runtime connection parameters:

1. Open the project file in TIBCO Designer and select the adapter configuration you want to modify.

2. Click the Design-time Connection tab and uncheck the Use Design-time Connection For Runtime checkbox.

3. Click the Runtime Connection tab and specify global variables for the SAP system details. You can provide the values for these global variables at runtime or by using the properties file of the adapter.

This ensures that schema references are not broken when the runtime connection parameters of the SAP system are changed.


Connecting with the SAP System | 283

Adapter Reconnection with the SAP SystemFor outbound connections, the adapter will automatically try to connect to the SAP Gateway server if any connection errors occur. If connectivity is not re-established within the maximum interval configured in the project, the corresponding server connection pool will be suspended and the adapter will be stopped if needed. See Setting Server Connection Advanced Options on page 169 for configurationn details.

For inbound connections, the adapter will automatically try to connect to the SAP system if any connection errors occur. If connectivity is not re-established within the maximum number of attempts configured in the project, the corresponding client connection pool will be suspended and the adapter will be stopped if needed. See Setting Client Connection Advanced Options on page 158 for configurationn details.

Adapter Connecting to Multiple Client Connection PoolsWhen configuring an inbound adapter instance, adapter services reference the same client connection pool by default; however, this can be changed if needed.

An inbound adapter instance can refer to one client or a client connection pool. The following are possible reasons for needing multiple client connection pools.

— Adapter service requires specific user credentials. For example, the service is creating financial documents in the SAP system and requires a specific user id when the documents are created.

— Adapter service is using a client connection pool based on Logon Groups and requires a specific group. For example, the SAP system maintains several Logon Groups and one of those groups is required for processing.

— If the SAP schemas are the same across the SAP system then the adapter service is using a client connection pool referencing a different SAP system.

Configuring Multiple Connections for Inbound InstanceFor an inbound instance the connections are specified at the service level. This means, you can have different connections for different services. When the adapter instance is configured all the services have a default connection. You can add new connections to the adapter and then for each service specify one of the newly added connections.

Use the following steps to add a new connection.

For the third scenario, you can have various adapter services refer to multiple SAP systems but an adapter service can only refer to one SAP system.



1. Configure an inbound adapter instance.

In the Project panel, select your project name > R3Connections > ClientConnections to view the default client connection.

The name of the connection will contain the adapter instance name. Similarly there will be a reference created for this connection in the ActiveConnections folder of that particular adapter instance. This is the default connection and you can modify parameters of this connection when required.

2. In the Project panel, select R3Connections>ClientConnections. Drag the ClientConnection icon from the palette panel to the design panel.

3. Select the Client connection type and click the Apply button.

4. Enter all the parameters for the second connection in the Inbound Connection tab. You can specify advanced connection parameters in the Advanced tab. Click the Apply button.

5. Select ActiveConnection for the adapter instance. Drag a ConnectionReference icon from the palette panel to the design panel.

6. Enter an appropriate name in the Name field. Click the Browse Resource button to display the Select a Resource window.

7. Select the newly created Client Connection resource. Click the OK button to attach the client connection you created to this reference resource.

8. Click the Advanced tab of the service for which this connection was created. In the Client Connection Reference field, click the Browse Resource button to display the Select a Resource window.

9. Select the client connection for this service and click the Apply button to save the adapter instance.

10. Start the adapter. The adapter dispatches the calls to SAP on the connections configured for each service.

Configuring Multiple Connections for Outbound InstanceServer connections are specified at the instance level. The configured services can use all the connections created for the instance.

Use the following steps to add a new server connection to the adapter.

1. Configure an outbound adapter.

Select the R3Connections>ServerConnections to view the default connection. The name of the connection will contain the adapter instance name. Similarly there will be a reference created for this connection in the ActiveConnections



folder of that adapter instance. This is the default connection and if needed the parameters of this connection can be modified.

2. Select the R3Connections>ServerConnections and drag a ServerConnection icon from the palette panel to the design panel.

3. Select the Server connection type and click the Apply button. Enter all the parameters for the second connection in the Outbound Connection tab. Specify advanced connection parameters in the Advanced tab.


5. Select the ActiveConnection for the adapter instance. Drag a ConnectionReference icon from the palette panel to the design panel.

6. Enter an appropriate name in the Name field. Click the Browse Resource button to display the Select a Resource window.

7. Select the newly created Server Connection resource. Click OK to attach the server connection you created to this reference resource.

8. Save and start the adapter instance. Now whenever you start the adapter it will act as an RFCServer and create connections for all SAP application servers.

Connecting to the SAP System Using bgRFCThe bgRFC transfer protocol provides a unified protocol between the SAP system and the adapter. It was originally introduced by SAP with the initial release of SAP ECC6.0. The bgRFC protocol has undergone several changes across SAP releases.

The adapter supports bgRFC protocol for an outbound adapter and type T for transaction type only.

Configuring SAP System for bgRFC

You can use the following steps to configure an SAP system for bgRFC:

1. Configure the RFC Destination.

a. Log in to the SAP system.

b. Run transaction SM59.

c. Click the Create button in the Configuration of RFC Connections page.

d. Enter applicable values accoording to your requirements into the RFC Destination page as Figure 156 shows.



Figure 156 RFC Destination Configuration

e. Click the Yes button in the Warning about selection of protocol dialog.

f. Click the Save button.

The transfer protocol for the RFC Destination requires basXML.



2. Configure the interface of the RFC/BAPI

a. Run transaction SE37.

b. Enter a function module in the Function Module field in the Function Builder: Initial Screen page.

c. Click the Display button.

d. Check the BasXML supported checkbox on the Function Builder page as shown in the Figure 157.

Figure 157 Function Builder Page



Password Handling

At design time, the adapter uses a password to connect to the backend application and fetch metadata. At runtime, the adapter uses a password to connect to the back-end application and interoperate with it.

If you plan to run the adapter locally, define the runtime password value to be a global variable. Before starting the adapter, include the runtime password as a client variable in the TRA properties file of the adapter and obfuscate it using the obfuscate utility installed with TIBCO Runtime Agent. For example, if the password value is defined as %%myPassword%%, create a global variable named myPassword in the global variables section with no value and include the following entry in the TRA file of the adapter:

tibco.clientVar.myPassword

See Password Handling on page 338 for how to use the obfuscate utility.

If you plan to deploy the adapter by using TIBCO Administrator, follow these steps:

1. In TIBCO Designer, check the Service checkbox of the password global variable in the Global Variables editor.

2. In the TIBCO Administrator GUI, before deploying the adapter, click the Advanced tab of the adapter archive and set the password value under the Runtime Variables section.

Do not set the password to type Password in the Global Variables editor in TIBCO Designer. If your password is obfuscated, you should set the password to type Password.


Compressing JMS Messages | 289

Compressing JMS Messages

JMS message compression is an instance-level option. It is especially useful when messages are to be stored on the TIBCO Enterprise Message Service server, including persistent queue messages, or topics with durable subscribers. Enabling compression ensures that messages take less memory space in storage and are handled faster by the TIBCO Enterprise Message Service server. When JMS messages are compressed and stored, they are handled by the server in the compressed form.

The compression option only compresses the body of a message. Headers and properties are never compressed. It is best to enable compression when the message bodies are large and the messages are to be stored on a server.

When messages are not to be stored, compression is not as useful. Compression normally takes time, and therefore the time to send or publish and receive compressed messages is generally longer than the time to send the same messages uncompressed. There is little purpose to message compression for small messages that are not to be stored by the server.

You can enable or disable this feature for message senders with the following adapter property:

• adr3.jmscompress: Either ON or OFF. The default value is ON, which indicates that messages will be compressed.

JMS message compression is only for Publication Services with JMS transport type.



Inbound BAPI Transactional Support

An external system invoking a BAPI Request-Response service in the adapter has the choice to explicitly commit or rollback the changes applied to one or more business objects by the BAPI transaction in the SAP system. The explicit commit or rollback is not a mandatory requirement for all BAPI transactions but is needed wherever the underlying BAPI transaction in the SAP system is implemented in this way.

For example, an invocation of BAPI_SALESORDER_CREATEFROMDAT1Server instance in the SAP system from the adapter does not result in permanent changes to the database until an explicit commit invocation is made with BAPI_TRANSACTION_COMMITServer instance.

To maintain the context for an individual BAPI invocation service, the Request-Response service for the BAPI transaction requires explicit committing which needs additional configuration in TIBCO Designer. Before configuring a BAPI Request-Response service for explicit committing, you need to run through the checklist given below to ensure that the service really requires configuration for explicit commit.

Explicit configuration for this feature is required only when one or more of the following conditions are satisfied:

• The BAPI transaction requires explicit commit/rollback in the SAP system.

• Multiple connections (maxConnections > 1) are configured for the client, which invokes the BAPI transaction in the SAP system and can be used to scale the number of concurrent transactions.

See Table 77 for descriptions of the two BAPI transactions within the context of the SAP system.

Inbound BAPI transactional support is available only when using a single adapter instance.

Table 77 Description of BAPI Transaction

BAPI Transaction Name Description of Transaction Task

BAPI_TRANSACTION_COMMIT • Ends current transaction

• Commits changes

• Initiates new transaction


Inbound BAPI Transactional Support | 291

Sample ScenarioAssume a scenario where you want to create a sales order. Depending on the result of whether you created a sales order, the sales order will either be committed or rolled back using the appropriate external BAPI transaction. When a BAPI transaction created by a sales order is sent to the adapter, the adapter instance generates a session ID which is passed in the user closure (RFCclosure) argument of the reply schema. This session ID needs to be mapped to the request event of BAPI_TRANSACTION_COMMIT or BAPI_TRANSACTION_ROLLBACK and sent to the SAP system.

Procedure

1. Open the example of Chapter 2, Dynamic Logon and Transactions, on page 7 that is provided with the adapter.

2. Follow Task A Create SalesOrder on page 9 of the above example.

3. Click Tools > Show Adapter Tester, in the TIBCO Designer.

4. Select the Transaction > R3AdapterConfiguration, in the Adapter Tester - R3AdapterConfiguration dialog.

5. Enter a working directory associated with the Working Directory field, under the Run Setting tab.

6. Click the Start button to start the adapter.

7. Click the Start testing viewed process F9 button, in the Test panel.

8. Click the Load Selected button to run the Create SaleOrder process, in the Select Processes to Load dialog. See Figure 158 for an example of successfully running the Create SaleOrder process.

BAPI_TRANSACTION_ROLLBACK • Ends current transaction

• Discards changes

• Initiates new transaction

Table 77 Description of BAPI Transaction

BAPI Transaction Name Description of Transaction Task

The session ID is generated either using the SAP connectivity information provided at the time of the call to the adapter or from existing connections created during adapter startup. For the example referred to in this section, the session ID is generated from the SAP connectivity information provided at the time of the call to the adapter.



Figure 158 Create SaleOrder Process Running Successfully

9. Go to your DynamicLogonExternalCommit file directory, open the newly created file OrderStatus.xml. See Figure 159 for example.

Figure 159 Sample OrderStatus File

10. Log in to the SAP system, run transaction VA03.

11. Enter 0000014398 in the Order field which is shown in Figure 159 and click the Search button.

12. Check the details on the Display Standard Order 14398: Overview page, see Figure 160 for example.



Figure 160 Display Standard Order 14938: Overview

Configuring Multiple Transactional RFC Calls Follow this process to configure multiple transaction calls within the same TIBCO ActiveMatrix BusinessWorks process:

1. Create the RFC/BAPI Request-Response service required for the transaction.

2. Create the RFC/BAPI Request-Response service commit transaction.

3. Create the RFC/BAPI rollback transaction.

4. Configure process definitions for the RFC/BAPI Request-Response service in the order required for a transaction.

5. Configure an Invoke an Adapter Request-Response Service Activity on page 225

6. Provide the SessionID from the first service output invocation to the input of the following service. Smilarly, provide the SessionID of the second service, RFC_CLOSURE_DATA, as the input of the next service. Repeat this for all subsequent services.



7. Enter the number of connections in the Advanced tab of the adapter connections.

8. In the Advanced tab of the adapter service, enter the number of threads for the service.

9. Click the Save button to save the project.

Invoking Multiple RFC/BAPI Transactions as One Transaction in SAPThis section provides information on how multiple RFC/BAPI transactions in the SAP system can be treated as one transaction.

The following two steps invoking such a transaction.

1. Invoking the first RFC/BAPI transaction, see Figure 161 for example.

To start a transaction, the property bInTransactionContext in the RFCClosure class is set to a value of 1.

If the transaction requires a dynamic connection then you need to populate the properties in the DynamicConnection structure accordingly.

Set the contextTimeout to a value accordingly. If the next RFC/BAPI transaction is not made within the time specified by the contextTimeout then the transaction held inside the adapter would timeout and the resources tied up by the transaction are released.

Figure 161 Create Sales Order

2. Invoking the last RFC/BAPI transaction, see Figure 162 for example.

To invoke the next RFC/BAPI transaction, the sessionID returned from the first RFC/BAPI transaction is passed on the RFCCLOSURE class. If the sessionID is not passed on the call then a new transaction is created.

Similar to step 1, the property bInTransactionContext is set to a value of 1.

To mark the end of the transaction, the property bContextEnd is set to a value of 1.



Figure 162 Get Status

When the transaction feature is in use, the adapter’s load balancing functionality, RVCMQ and multiple instances of the adapter cannot be used.



Invoking BAPI/RFCs Using Transactional Semantics in SAP

BAPI/RFCs can be invoked using transactional semantics in the SAP system.

In case of exceptions (network outages or system failures) in SAP while the call is being executed, the transactional semantics in SAP ensures data consistency and exactly-once execution.

Transactional RFCs (tRFCs) are always executed as one-way invocations and are best suited for transferring transactional data into SAP in real-time. To execute a BAPI/RFC in transactional mode, the BAPI/RFC transaction has to be downloaded and saved to the adapter configuration as a one-way operation.

Any one-way Request-Response service can be executed as a tRFC in SAP. To execute a one-way BAPI/RFC as a tRFC, each invocation of the BAPI/RFC should be accompanied by userClosure information, as defined in the class RFCCLOSURE under /tibco/public/classes/ae/SAPAdapter40/RFCCLOSURE.

The parameter needs to be set in the RFCCLOSURE class and sent along with each tRFC request as:

— bTransactional — This boolean variable determines whether the call must be invoked transactionally or not in SAP. Set this to true for a tRFC invocation..

By default, the messaging protocol for one-way BAPI/RFC services is set to Certified messaging.

Support for qRFCsqRFC is an enhancement on tRFC. qRFC allows tRFC invocations to be handled sequentially in the target SAP system. The adapter allows external systems in the TIBCO environment to invoke tRFCs as qRFCs in SAP systems.

When a BAPI/RFC is invoked as a tRFC, the TID is automatically generated by the adapter using the SAP system required.

It is strongly recommended to use the Certified Messages protocol for one-way BAPI/RFC invocations to handle any exceptions (like network outages) during the execution of the call in SAP.


Invoking BAPI/RFCs Using Transactional Semantics in SAP | 297

Inbound qRFC

Any tRFC can be invoked as a qRFC in the inbound adapter. No design-time configuration is required. All parameters necessary to invoke a tRFC as a qRFC can be provided at run-time as part of the RFCCLOSURE class discussed in the previous section.

The qRFC parameters that have to be set in the RFCCLOSURE for performing a qRFC invocation in the SAP system are discussed below:• bQueue

This boolean variable determines whether the call must be invoked as a qRFC or not in SAP. When defining bQueue as “true”, the property bTransactional cannot be set to “true”. If both properties are set to “true”, an error is generated.• qName

Every qRFC invocation is made in the SAP system for a specific queue defined in the system. Set this field to indicate which queue the qRFC call is to be inserted into.

Outbound qRFC

Outbound qRFC calls can be invoked in the adapter from the SAP system. The adapter extracts the queue parameters for each qRFC invocation from the SAP system and appends them in the request's RFCCLOSURE class that is passed on to the TIBCO environment.

This allows receiving systems in the TIBCO environment to recognize tRFC/qRFC invocations made by the outbound adapter.

When invoking a BAPI/RFC as qRFC, the qCount required is automatically generated by the SAP system and cannot be passed by the adapter. When using qRFC, do not configure adapter service using more than one connection since the order is not guaranteed.

For outbound qRFC calls, the properties qName and counter associated to the message are not available in the RFCCLOSURE class. The property bQueue is set to “true” only.



Sending IDoc through qRFCAn IDoc can be sent to the SAP system using qRFC invocation which allows the IDocs to be processed in the system in the order they are received. Since the adapter sends the IDocs in a sequence, multiple threads and load balanced adapters cannot be used to enhance the performance of the Subscription adapter service.

The following transaction codes are used for monitoring IDocs sent to the SAP system using qRFC.

• WEINBQUEUE To view all inbound queues that are configured or created. When an IDoc is sent to a queue, the IDoc will be inserted into that queue.

a. Log on to the SAP system.

b. Run transaction WEINBQUEUE.

c. In the Monitoring Program for IDoc Inbound Queue page, enter search values to the listed fields and click the Execute button.

• SMQ2 To monitor the status of the LUWs in the inbound queue and start any queues manually.

a. Log on to the SAP system.

b. Run transaction SMQ2.

c. In the qRFC Monitor (Inbound Queue) page, enter search values to the listed fields and click the Execute button.

d. The qRFC Monitor (Inbound Queue) page lists all the inbound queues based on your search criteria. Queues and corresponding IDocs are displayed.

When configuring a subscription service to use qRFC invocation service, if the subscription service co-exists with other inbound adapter services then configure the subscription service to use a different session to avoid multiple messages being processed in parallel.

When multiple IDocs are sent to the SAP system using qRFC, an IDoc cannot be processed fully. If the prior IDoc was not processed successfully then the current IDoc is updated with the IDoc status of 75.


Invoking BAPI/RFCs Using Transactional Semantics in SAP | 299

Receiving IDocs through qRFCThe qRFC invocations (including IDocs) from SAP are handled sequentially by the SAP system. Hence all qRFCs are sequenced by the adapter as well. Consequently, multiple threads and load balancing will not contribute to enhanced performance of qRFC in the adapter.

The adapter supports outbound IDocs sent through qRFCs. The following transaction codes are used for configuring qRFCs for the SAP system and for the monitoring activities:

• WE20 To configure an outbound message type for qRFC on a specific destination.


b. Run transaction WE20.

c. In the Partner profiles page, select Partner > Partner Profiles > Partner Type LS Logical system. Choose one of your logical systems, for example ZTIBCO.

d. In the Outbound parmtrs table, choose one outbound parameter from the Message Type column. For example, click the MATMAS outbound parameter.

e. In the Partner profiles: Outbound parameters page, check the Queue Processing checkbox.

f. An information dialog pops up stating that qRFC is successfully communicating with an external system. Click the Continue (Enter) button.

g. Choose a rule name for queue processing, and click the Save button to save the update.

• WEOUTQUEUE To view all Queues that are configured or created. You can start a queue so that all the IDocs in the queue will be delivered to the corresponding port. When the IDocs are delivered to the port, the status of the IDocs is updated.


b. Run transaction WEOUTQUEUE.

c. In the Monitor Program for IDoc Outbound Queue page, enter search values to the listed fields and click the Execute button.

• SMQ1 To monitor the status of the LUWs in the outbound queue and restart any hanging queues manually.




b. Run transaction SMQ1.

c. In the qRFC Monitor (Outbound Queue) page, enter search values to the listed fields and click the Execute button.

d. The qRFC Monitor (Outbound Queue) page lists all the outbound queues under your defined search criteria. Undelivered message are marked in pink. Subsequent messages are not delivered until previous messages have been successfully delivered.


Multithreading | 301

Multithreading

Multithreading of an application allows the application to simultaneously process multiple, independent events. Multithreading is supported in both inbound and outbound instances.

Multithreading in Outbound AdapterThe scalability of the outbound adapter is accommodated through the number of connections configured in the Server Connection pools. If a Server Connection pool is configured with Max Connections of three, three threads will be available to potentially receive messages from the SAP system. If the number of messages processed by the adapter needs to increase, adjust the Max Connections property accordingly. You can configure this property in one of the following ways:

• Set the value for the Max Connections field in the Advanced Tab present in the R3Connections > ServerConnections folder.

• Set the number of threads through the adr3.maxconnections property in the adr3.tra file.

• Set the system:maxconnections argument from the command line.

The number of threads should be equal to the number of connections required. The maximum limit is eight threads per server connection.

The maximum limit is 99 threads per server connection pool. To configure the maximum number of connections allowed, modify the profile parameter GW/MAX_CONN for the SAP application server.

For details on setting up the number of threads, see Setting Server Connection Advanced Options on page 169.

Multithreading in Inbound AdapterThe scalability of the inbound adapter is accommodated through the thread count configured in the Advanced tab of the adapter service. If an adapter is configured with a thread count of three, three threads will be available to potentially receive messages from the JMS or RV destination. If the number of messages processed by the adapter service needs to increase, maintain the thread count property accordingly.

To take advantage of the number of connections available in the Server Connection pool, it is recommended that you maintain the connection count available in SAP transaction SMQS for the corresponding RFC Destination.



The maximum limit is 99 threads per adapter service.

Multithreading with Distributed QueuesBAPI/RFC Request-Response services and IDoc Subscription services may be run in load-balanced Distributed Queue (or RVDQ) mode. For multithreading to be enabled for such configurations, ensure that the worker tasks for worker instances are set to values greater than 1. The number of threads active in each instance is equal to the worker task set for that instance, provided sufficient connections are created for the configuration.

When an adapter instance is configured in TIBCO Designer, all adapter services having the same messaging transport configuration would share the same session configuration. For example, if there are two Subscription Services and the message transport is set to JMS queue, both of these services share the same JMS session by default and will share all threads associated with that session. Even though the services each have their own respective thread count, if the services share the same session, the total number of threads is actually used.

When configuring the thread count for an adapter service, it is recommended that you configure accordingly based on the number of connections available and the number of concurrent messages.

In the case of Subscription Service, to receive optimal performance, it is recommended that you set the inbound partner profile in the SAP system to “Trigger by background program”. If the inbound partner profile is set to “Trigger immediately”, the client connection used by the adapter service can be potentially blocked until the processing in the SAP system is completed and will prevent the adapter service from processing and sending the next message to the SAP system.


Multiple Connections | 303

Multiple Connections

The adapter can connect to multiple gateways/program IDs on the outbound side and 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 application servers or between an application server and an external program. See Figure 163 for demonstration.

The host machine on which the SAP gateway resides is called the Gateway Host. Each SAP application server can communicate to external systems through its own gateway often residing on the same machine as the application server. Alternatively, the gateway process may also reside on a machine entirely different from the one where the application server runs. In such cases, multiple application servers can share the same gateway and the gateway host acts as a centralized gateway server.

The outbound adapter can service requests to invoke or post BAPIs/RFCs/IDocs in the TIBCO environment from one or multiple SAP gateways. This is achieved by configuring the adapter for multiple outbound connections. See Load Balancing Using Distributed Queue on page 317 for details.

Figure 163 Outbound Adapter Connecting to Multiple SAP Gateways



Posting BAPIs/RFCs/IDocs from Multiple RFC Destinations in the Outbound Adapter

From within a single SAP gateway, RFCs/BAPIs/IDocs are passed on to the outbound adapter from RFC destinations. When an RFC/BAPI or an IDoc is executed on a specific RFC Destination, the SAP system passes on the request to the adapter registered on the Program ID that is mapped to the RFC Destination. See Figure 164 for demonstration.

A single instance of the outbound adapter can service RFCs/BAPIs/IDocs from multiple RFC destinations. This is achieved by configuring the adapter for multiple outbound connections in TIBCO Designer palette. See Load Balancing Using Distributed Queue on page 317 for details.

Figure 164 Outbound Adapter Registering on Multiple Program IDs on One Gateway

Responding to Dynamic Changes in the Application Server Environment Load-balancing outbound messaging on the SAP system is achieved by clustering multiple application servers under a central SAP Instance.

The outbound adapter can respond to dynamic changes to such clustered environments in terms of detecting addition or removal of application servers to or from the cluster. The outbound adapter automatically registers itself with all active application servers in a cluster and receives and processes messages from the servers.



To achieve this, the Outbound adapter is to be run in conjunction with a discovery agent that is supplied with the adapter Run-time environment installation. Figure 165 explains the steps involved in this dynamic discovery scenario, for gw1 and gw2 are the gateway hosts through which the SAP application servers communicate to the Outbound adapter.

Figure 165 Clustering Multiple Application Servers under a Central SAP Instance

The Discovery Process

The Discovery Agent is a special pre-configured inbound adapter. The discovery process involves the following steps, also schematically presented in Figure 163, Figure 164, and Figure 165.

1. Discovery agent polls the central SAP instance, retrieves the list of application servers connected to the central Instance.

2. The discovery agent publishes the list as a message to the TIBCO environment.

3. The outbound adapter configuration(s) pick up the discovery message.

4. The outbound adapter configuration(s) register on the gateway hosts of discovered application servers.

If the adapter and the discovery agent span different network subnets, use of Rendezvous Enterprise Daemon is required. You must obtain a separate license for the Rendezvous Enterprise Daemon that is appropriate for your usage.



The outbound adapter automatically disconnects from application servers that have gone down and cleans up connections after all attempts to retry connecting to the application server are exhausted. The outbound adapter does not create a new connection to a gateway host, if a connection is already connected to a gateway host.

Configuring of Discovery Agent

The discovery agent is a configured inbound adapter instance. This section contains information on the steps needed in order to configure the actual discovery agent using TIBCO designer. Once these steps are maintained, the project can be deployed.

• Create a project and add an R3 Adapter Configuration resource.

• Change the R/3 Connection type to Inbound.

• Configure the necessary connection information for a client connection.

• Create a Request-Response service using the function module RFC_GET_LOCAL_SERVERS. Once the module has been downloaded, configure the necessary transport protocol and destination.

• Create a new session using the necessary transport protocol.

• Using the new session that was created a Publisher endpoint and assign the required destination to it.

• Using the new session, create a client and assign the same destination entered as a Request-Response service for function module RFC_GET_LOCAL_SERVERS.

• Maintain the Discovery Agent plugin properties in the General tab of the adapter instance in the TIBCO designer project.

• In the General tab, check the Enabled checkbox.

• In the Polling Client Reference field, enter the client that was created for the session.

• For the Polling Interval field, change the value accordingly. The default value is 60000 and it is maintained in milliseconds. This value is used by the

When you specify a list of Program IDs using the TRA property in the adr3.discovery.pid, if the list of Program IDs is not comma-delimited then only the first Program ID will be taken into effect.

The destination entered must match the destination maintained in the TRA property adr3.discovery.listenerSubject in the outbound adapter instance.



discovery agent as the interval for polling the available list of SAP application servers. If the value is 6000 then the discovery agent refreshes the list of SAP application servers every 60000 milliseconds or 60 seconds. You can use global variable to configure this field.

• For the Polling Publisher Reference field, enter the publisher that was created for the session.

• For the Application Server Domain Name field, maintain the domain name accordingly. We recommend to maintain this field so that Domain Name Services (DNS) is used for host name resolution. You can use global variable to configure this field.

For information on the General tab, see General Tab on page 89.

Running the Discovery Agent

You can start the discovery agent with the following command from the command line.adr3Discoverer --propFile adr3Discoverer.tra

Then specify the following values:

— tibco.repour <repourl>

— tibco.configurl <configurl>

You also can deploy the Discovery Agent by using TIBCO Adaministrator as any ordinary adapter.

Configuring the Outbound Adapter

The Outbound adapter does not need additional configuration in TIBCO Designer to be able to respond to dynamic changes to the application server environment.

The following properties need to be set in the adapter launcher file to enable this feature for an Outbound adapter configuration.

• adr3.discovery — Use this property to turn on or off the dynamic discovery feature.

The feature is commented by default. To turn it on, uncomment the property.

• adr3.discovery.pid — Use this property to specify program IDs on which to register the gateway of the discovered application server.

The Discovery Agent is configurable in TIBCO Designer by creating a project. When the project is created, you cannot add another adapter service or remote TIDManager adapter service.



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 property is not specified.

You can specify multiple program IDs as comma-separated values.

For example:

adr3.discovery.pid=tibcotest

adr3.discovery.pid=tibcotest,IDoctest

• adr3.discovery.listenerSubject — Use this property to specify the subject to listen on to subscribe to the discovery message published by the discovery agent. The discovery message contains the list of active application servers. Ensure that the adr3.discovery.listenerSubject matches the publishing subject on the discovery agent side.

For example:adr3.discovery.listenerSubject=APPSERVER.DISCOVERY.DYNAMIC

If not specified, this property defaults to R3.APPSERVERS.ACTIVE.

• adr3.discovery.listenerSession — Use this property to specify the TIBCO Rendezvous or JMS session to use for the discovery listener.

A valid session by this name should be available in the project.

For example:adr3.discovery.listenerSession=MyDiscoverySession

If not specified, this property defaults to R3RVSession.

• adr3.discovery.maxconnections — Use this property to specify the maximum number of connections that can be established to the gateway of each discovered application server.

If not specified, it defaults to 1.

• adr3.discovery.maxretryinterval — Use this property to specify the maximum number for the retry interval. This property defines the behavior of the outbound adapter in the event of connection to the SAP Gateway server. Connection loss can result from network glitches or a planned shutdown. Because the adapter cannot distinguish between the two causes, it will behave in exactly the same way in both situations.

Discovery Agent: The outbound adapter log does not give any error when it establishes a connection to a ProgramID sent by the discovery message, and this ProgramID does not exist in the SAP System.



If an SAP Gateway server has been brought down because of a planned shutdown, it will still continue to establish a valid connection until the maximum retry interval is reached.

For example:adr3.discovery.maxretryinterval=120

Note that the maximum retry interval must be specified in seconds.

If not specified, maxretryinterval defaults to 60 seconds. If the value supplied is less than 1 second then maxretryinterval would default to 1 second.

• adr3.discovery.appserver.suffix — This property is appended with the server names returned back by the discovery agent.

For example, if the server name returned by the discovery agent is tibdemo and the value specified is na.tibco.com, then the server connection will use server name tibdemo.na.tibco.com.

It is recommended to use this property when DNS services are required for connectivity.

Configuring the Inbound Adapter for multiple application serversTypically, an Inbound adapter is configured to connect to a messaging server belonging to a central SAP instance, which distributes the load across multiple application servers.

The Inbound adapter can also establish dedicated connections to multiple application servers that may not be part of a messaging server configuration. To achieve this, the Inbound adapter should be configured for multiple Inbound Connections in the TIBCO Designer palette. During configuration, ensure that each BAPI/RFC/IDoc Service configured points to that application server to which Inbound messages for that service are posted. Refer to Load Balancing Using Distributed Queue on page 317 for details.



Event Driven Inbound Connections

This feature allows users to dynamically establish connections to the SAP system in an inbound adapter configuration. This feature provides flexibility to external systems and the following advantages accrue:

• The inbound adapter need not be connected to the SAP system always, if the RFC/BAPI Request-Response services or IDoc Subscription services configured in the adapter are not invoked frequently.

• External systems can login with specific authorizations in SAP after authentication and execute RFCs/BAPIs in SAP through the inbound adapter with these authorizations.

• Request-Response and/or Subscription services configured in the adapter will make 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)

Disabled Connection Pooling Inbound ConfigurationIn order to use a dynamic connection, you need to configure connection pooling by using the login parameters provided at design-time.

Any Inbound adapter can be configured to start up where connection pooling is disabled. Such an Inbound adapter configuration does not establish any connections to the SAP system unless a call is required.

Once the call is completed, the connection to the SAP system is closed automatically.

Based on the Logon Parameters Defined at Design-time

In this case, the adapter opens and closes connections on a per-message basis. The connection parameters for opening connections are picked up based on the Connection references configured for the corresponding Request-Response or Subscription services.

You must open your project in TIBCO Designer and save your project to refresh project class in order to use the Dynamic Logging feature in TIBCO ActiveMatrix Adapter for SAP 7.0.


Event Driven Inbound Connections | 311

Configuration

To enable this feature, instruct the adapter not to establish connections on startup by selecting R3Connections > ClientConnections for the particular configuration and checking the Disable Connection Pooling checkbox in the Advanced tab for each of the configured Client connections. For more information on the Advanced tab see Setting Client Connection Advanced Options on page 158.

Performing Explicit Logon for RFCs/BAPIsAn RFC/BAPI Request-Response Service can be enabled for explicit logon by passing the SAP connection information at the time of the RFC/BAPI transaction. The SAP connection information is passed to the inbound SAP adapter by using the DynamicConnection property available in the RFCCLOSURE class. The RFCCLOSURE class is found under the /Schemas/Classes/ae/SAPAdapter40/classes directory in the TIBCO Designer project. Depending on the information provided on the connection, the connection to the SAP system could either be a Dedicated connection, Logon Group connection, or an SNC connection.

If the logon operation is successful and a valid client connection to the SAP system is obtained through the inbound adapter instance, a Session ID is sent back in the reply to the calling system. The reply contains the Session ID in its RFCCLOSURE class. To obtain details of the RFCCLOSURE class use the Schemas folder in the project panel. The path is as follows:Schemas/Classes/ae/SAPAdapter40/classes

The external system invokes the RFC/BAPI with this Session ID to be serviced by the inbound adapter instance. Unless the session ID is used as part of a transaction, the connection to the SAP system is closed automatically.

If the external system requires a separate connection for each invocation, each invocation should be accompanied by the SAP connection information so the connection is created.

When the explicit logon feature is in use, the adapter’s load balancing functionalities, RVCMQ and multiple instances of the adapter cannot be used.



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 SAP systems with a single connection.

Sample Scenario Assume a scenario that you are working on two SAP systems, one SAP system is named CER and the other SAP system is named LCM.

Both SAP systems are assigned RFC destinations as RFCTEST and ProgramID as RFCTEST.

Assume you configured an outbound instance running on the CER SAP system. Refer to the following procedure to configure the LCM SAP system to let it use the same SAP adapter instance.

Procedure

1. Log in to the second SAP system, LCM, run transaction sm59.

2. In the Configuration of RFC Connections page, select RFC Connections > TCP/IP connections > RFCTEST.

3. In the RFC Destination RFCTEST page, click the Technical settings tab.

4. Click the Display <-> Change (Ctrl + F1) button.

5. Enter the same values for the Gateway host and Gateway service field as the other SAP system, which is the CER SAP system.


7. Click the Connection Test button to test the connection.

8. Save the destination.

Now, you're ready to run the adapter from the second SAP system which is the LCM in our scenario.

When assigning a specific gateway host to an RFC destination, you must ensure that this gateway host is available at all times. Regardless of whether or not you are able to make an RFC request from another host, if the specified gateway host is unavailable, then the RFC request to the adapter will not be successful.


Connecting an Adapter Instance to Two SAP Systems with a Single Connection | 313

However, the disadvantage in this scenario is that if the CER SAP system goes down, the adapter instance cannot obtain messages from the LCM SAP system. In a scenario where one instance of the adapter can connect to multiple program IDs of multiple SAP systems the problem does not arise.

For more information on registering a program ID under RFC destination see Registering program ID under RFC Destination on page 44.



Using JMS Destination Bridges

A Destination bridge can be used to specify one or more destinations for services using JMS transport. The destination can be either a topic or a queue. Within the context of the adapter, the adapter service is one such destination.

The destination bridge is configured using the bridges.conf file. See the TIBCO Enterprise Message Service documentation for more information.

Examples

Consider the scenario where you have an Adapter subscriber configured with a JMS queue and destination name SAP_Sub and a TIBCO ActiveMatrix BusinessWorks project with a publisher with a JMS topic and destination BW_Pub. The bridges.conf file would be:

[topic:BW_Pub]queue=SAP_Sub

The adapter subscriber on receiving the IDoc posts it to the SAP system.

In the above example, if the publisher was configured with a JMS queue, the bridges.conf file would be:

[queue:BW_Pub]queue=SAP_Sub

When using a Request-Response or a Request-Response Invocation Service make sure you do not specify different destination bridges.

For example, do not configure an Adapter Request-Response Invocation Service with a JMS topic and a TIBCO ActiveMatrix BusinessWorks project with a Request-Response Service using a JMS queue.


Saving an IDoc to a Directory | 315

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 whose destination is not in the list of valid destinations.

• A Subscription service configuration will write an IDoc message to a file, if an exception ocurred from an SAP application that is returned from the SAP system. In this case, the data may be manually changed in the file and replayed later using a TIBCO BusinessWorks process.

Configuring IDoc Logging DirectoryUse the following steps to configure an IDoc logging directory.

1. Click the Advanced tab of your subscription service

2. In the Destination drop-down list, select Log to file.

3. In the Format drop-down list, select the appropriate format. The format can either be None or XML. If None is selected then the actual IDoc data is written to the file. No metadata is provided and the IDoc data is only provided. If XML is selected then the IDoc is written to the file in XML format and the metadata for the function module, the adapter instance, invoked is used when writing to the file.

4. In the Log IDoc To Directory field, enter the directory in which these files are to be saved.

Each of the IDocs will be written to a unique file. The name of the file is created according to the following syntax:

Filename = IDocType_DateTimeStamp_IDocCount.IDoc

For example, MATMAS01_20030825114438762_1.IDoc

These ASCII files may be manually replayed, if necessary. For more information, see Advanced Tab on page 129.

For the Publication service, the adapter publishes the IDoc using RV or JMS messaging. The valid destination feature can be used for writing the IDoc to a file if needed.

Validation of the directory will not be done during design-time. If this field is not populated, the ASCII text file will be logged in the current working directory of the adapter.



If no directory is supplied in the Log IDoc to Directory field then the adapter either uses the TRA property adr3.IDocLogDirectory or the current working directory. The following is the logical order for the above precedences.

1. TRA property adr3.IDocLogDirectory.

2. Log IDoc to Directory field in TIBCO designer project.

3. Current working directory.


Load Balancing Using Distributed Queue | 317

Load Balancing Using Distributed Queue

Load balancing allows message loading to be balanced or shared by multiple adapter instances. Load balancing ensures no single instance is over-loaded, and minimizes stress-failures.

It also allows fault-tolerance by avoiding a single point of failure. The adapter can run in load-balanced configurations both on the Inbound side as well as the Outbound.

Configuring Inbound Load-Balanced InstancesThis section outlines the steps to configure inbound load-balanced instances containing subscription services and request-response services. During the configuration of the services, the Quality of Service must be configured as a Distributed Queue. For more detailes on the subscription service options see Transport Type: Rendezvous on page 127

This section outlines the steps used to configure inbound load-balanced instances containing Subscription services (Inbound IDocs) and/or Request-Response services (Inbound RFC/BAPI.)

During the configuration of the adapter services, the Quality of Service must be configured as type Distributed Queue.

Configuration of inbound load-balanced instances can be done either by:

• Creating multiple inbound instances where the CMQ names are the same across 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 be set with care. For more detailed information, see the TIBCO Rendezvous Concepts manual and TIBCO Designer SDK Resource Guide for details on configuring an RVCM Session. You can access TIBCO Designer documentation using the Help menu by selecting Help > Help for > Adapter Resources

It is recommended that you have a good grasp of the concepts listed below and discussed in TIBCO Rendezvous Concepts manual before you finalize the configuration of any inbound instance running in RVCMQ mode.



— 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

Multiple Inbound ConfigurationsUse the following steps to configure an inbound instance as part of a group of load balanced instances:

1. Assign one of the instances as the master or root.

2. Provide a unique RVCMQ session name for this instance.

3. Obtain the RVCMQ session using these steps:

a. Click the Advanced tab of one of the inbound services.

b. Click the Go to referenced resource... button corresponding to the Endpoint Reference field.

The Configuration tab for the endpoint reference displays.

See Figure 166 for the RVCMQ Session linked to the endpoint reference, which the endpoint IDocCMQSubscriber-IDocInbound is linked to the RVCMQ session DefaultRVCMQSession. All the instances should have the same CMQ Name to achieve load balancing using Distributed Queue.

Before changing the Quality of Service, make sure that no network sinks have a Session Reference, referring to the Default Sessions (DefaultRVSession, DefaultRVCMSession, DefaultRVCMQSession) created by the palette. To avoid this, have a Custom Session associated with the Network Sink.

To avoid message loss after activation of a suspended RVCMQ service, assign CompleteTime to a value greater than Zero.When the completeTime is assigned Zero the scheduler does not set a timer and does not reassign tasks when the task completion confirmation is not received. So after activation of a suspended service the scheduler does not reassign the task to the worker member. For more information on RVCMQ parameters, refer to TIBCO Rendezvous documentation.



Figure 166 Default RVCMQ Session

c. For other instances that have not been assigned as the master or root, the CMQ name property of the RVCMQ sessions used by those instances must be changed to reflect the name in step 1.

d. To Change the CMQ Name property, use the following options:

See step 1 to identify the RVCMQ sessions used by the instances.

For each instance, change the CMQ Name property of the session as shown in Figure 167.



Figure 167 RVCMQ Configuration Tab

Single Inbound ConfigurationConfigure an inbound instance with RVCMQ quality of service and invoke it multiple times.

Use global variables to specify different log file names for each invocation of the instance otherwise all trace messages will be written to the same file.

In the project panel, select your project name > your instance name > Advanced > Log Sinks > fileSink.

In the File Name field, enter %%LOG_FILENAME%%. It is assumed that a value is passed along with the tra file.

Configuring Outbound Load-balanced InstancesThis section outlines the steps necessary to configure Outbound Load-balanced instances containing Publication services (Outbound IDocs) and/or Request-Response Invocation services (Outbound RFC/BAPI). The steps outlined in this section are applicable for any adapter instance configured with the R/3 Connection type Outbound or Both.

The global variable LOG_FILENAME is used to illustrate how to configure filenames at run-time. As long as the client variable is unique, you can use any name.



Outbound Load-balanced instance can be configured either by

1. Creating multiple outbound instances using the same Program ID for the Server Connections.

Or

2. Creating one outbound instance that can be invoked multiple times.

The subsequent section focuses on the second option where one outbound instance is created using global variable substitution as the means for providing unique names for both the RVCM session name and File Sink filename during each invocation of the adapter instance.

Single Outbound Instance

To invoke the same adapter instance multiple times, use the following steps to configure the instance using TIBCO Designer.

1. In the Project panel, select your session and in the CM Name field enter %%PASSED_CM_NAME%%. The value of Ledger File should be changed to reflect the usage of the same global variable. It is assumed that a value would be passed along with the .tra file for the adapter instance.

2. The File Name field for a file sink is not editable.

To change the value of the file name for the file sink, in the Project panel, select your project > your instance.

In the Configuration panel, click the Logging tab.

In the Log File field enter %%LOG_FILENAME%% global variable.

This change will be then reflected in the File Name 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.

When creating multiple instances, make sure that the TIDManager Client references the same remote TIDManager instance.

The global variable LOG_FILENAME is used to illustrate how to configure filenames at run-time. Any unique client variable name can be used.



For information on global variables refer to your TIBCO Repository Documentation.


Configuring Valid Destinations | 323

Configuring Valid Destinations

The Adapter Services tab can also be used to specify a list of destinations to which the IDocs will be sent. This list of destinations apply to all IDoc types that are sent from the SAP system or to the SAP system. Typically, these destinations are SAP logical SAP system names, but they can be a bank identifier, a customer 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 not configured as a valid destination, the IDoc is not published to the TIBCO environment. The IDoc will be logged (saved) into an ASCII text file under the configured directory. For details on how to save IDoc under a directory, see Saving an IDoc to a Directory on page 315.

To configure valid destinations,

1. Make sure you have the publication or subscription services defined before configuring any valid destinations.

2. In the Adapter Services tab, enter the valid destinations in the Valid Destinations field. For detailed information on Adapter Services parameters see Adapter Services Tab on page 86.

3. To add a new entry in the list, enter the name of the valid destination in the list separated by commas.


5. Click the Apply button to apply your changes.

As entries get saved, they are automatically converted to uppercase. This is done to ensure consistency with the syntax of logical systems in SAP.




| 325

Appendix A Frequently Asked Questions

This appendix lists answers to the frequently asked questions.

Topics

• Frequently Asked Questions


326 | Appendix A Frequently Asked Questions

Frequently Asked Questions

A partner profile in our SAP system is configured to 'collect IDocs' to push the IDocs out in a batch. How can I configure the adapter to publish IDocs in batches?

The explode batch format of IDoc publication allows you to bunch and publish IDocs in completely self-describing format in one batch, the size of the batch being equal to the packet size configured in SAP for the partner profile.

At times the adapter throws 'CPIC Error', but after some time, it continues processing the message. Is this something to worry?

CPIC error usually occurs when the adapter is unable to obtain connection to SAP. This may due to network overload or glitches. It may also due to some transient network problems. To verify this issue, you can try to connecting the SAP system from the SAP GUI installed on the same machine on which the adapter is throwing the error.

Can an adapter configuration connect to different SAP systems?

As needed, the adapter can connect to different SAP system from one adapter configuration; however, if the schema across those SAP systems is different than it is recommended that different adapter configurations be configured.

For inbound processing of message, how can I take advantage of multiple application servers in SAP landscape?

When connecting inbound to the SAP system, it is recommended that Client Connection pools be configured using type Load Balancing along with the Advanced property Disable Connection Pooling to make maximum use of multiple application servers.

How can I debug my ABAP code when executing the program using the adapter?

The adapter provides an option called Use_SAPGUI flag. This flag has to be set to 1 or 2 during adapter configuration. See Adding a Client Connection on page 150 for details. Thus once that ABAP program is called, the adapter opens up the SAP GUI then you can debug your ABAP code. To use ABAP debug, you should have SAP GUI installed on the machine on which the adapter is being executed.

How can I update my repository, when there is a change in the schema for IDoc in the SAP


Frequently Asked Questions | 327

system, without losing my mappings?

Whenever there is a change in IDoc, the IDoc has to be downloaded again. The configured service for the IDoc should be deleted and recreated with a new IDoc.

If the change in IDoc does not disturb the mapped parameters then the mappings will not be affected. For example, if you add additional fields to an existing segment.

In your mappings you will be able to find the additional fields along with the other mappings.

If you delete a field being mapped from the schema, then the mapping for that field will be lost.

How can I turn on RFC trace for outbound communications without having to make changes to the TRA properties file or TIBCO Designer project?

RFC trace can be turned on by enabling it in SAP by turning RFC trace ON using SAP transaction SM59.

How can I use the Load Balancing feature of the adapter on the Inbound side?

For Inbound Load balancing use the Distributed Queue feature of the adapter. For more information on configuration and its usage refer to Load Balancing Using Distributed Queue on page 317.

How can I use the Load Balancing feature of the adapter on the Outbound side?

For Outbound Load balancing use Manager to configure. To set up Manager, during the adapter instance configuration, in the Adapter Services tab of the Adapter Instance select Remote from the Outbound Management drop-down list. For more information on this configuration, see Configuring TIDManager Options on page 171. Make sure that you bring up the Manager first before you bring up the adapter instances.

How do I know what version and patch level of the adapter, TIBCO Runtime Agent, and TIBCO Designer I am using?

For the exact TIBCO Runtime Agent build, you can look up the version.txt file under TIBCO_HOME/TRA/ReleaseNumber. When you start the adapter, you will see a banner giving you the adapter version and patch level. When you open TIBCO Designer, select Help > About, a page that displays the TIBCO Designer version and the build will prompt out.



How many connections are possible for each SAP ID?

Maximum connections for each SAP ID must not exceed 300. This limit is imposed by SAP. SAP licensing is based on user names, not number of connections.

I am subscribing to an IDoc using an inbound instance to post into the SAP system. What happens to the IDoc if the connection to the SAP system goes down just before the adapter receives the IDoc or while processing the IDoc?

On receipt of an IDoc, the Subscriber Instance checks for validity of the connection to SAP before posting. If the connection is invalid, the adapter immediately starts a timer to check for connections to SAP periodically and suspends the IDoc subscriber so that no further messages are received. The IDoc message 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 mechanism is also available for inbound oneway Request-Response messages.

I want to open a Support Call. What information should I include in my request so as to avoid unnecessary delays?

If you are planning to open an SR just for information purpose, then include the adapter version and patch level, the platform on which the adapter is running and the version of SAP system.

If you are opening an SR because you are facing some problems and getting errors, then do not forget to include the following:

• TIBCO ActiveMatrix Adapter for SAP version and patch level

• TIBCO Runtime Agent version and patch level

• TIBCO Designer version and patch level

• Platform on which the adapter is been running

• Fresh adapter log files (if error occurs during adapter execution) or Designer Log files and Designer Console Output (if error is occurring during configuration)

• The repository in which you are getting the error and the adapter properties file (adr3.tra)

• The SAP version



• Additional information regarding other components such as TIBCO IntegrationManager or TIBCO ActiveMatrix BusinessWorks if acting as source of message to the adapter. Also include your contact information.

IDoc is created in SAP system and is in status 03, but IDoc is not received by outbound adapter.

Review transactions currently in queue using SAP transaction SM58. If the transaction is in error, it can either be retried manually or retried automatically by the SAP system using the configuration defined for the corresponding RFC destination. It is not recommended to retry manually unless the outbound adapter is running. If the manual retry is unsuccessful then the automated SAP retry would cease and manual intervention is required.

The number of server connections in the outbound adapter was increased, but there is no improvement in performance or inactivity of connections is observed.

When changing the maxConnections property of a Server Connection pool in an outbound adapter instance, change the connection value maintained for the corresponding RFC Destination using SAP transaction SMQS.

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 mandatory to run it. You can start TIBCO Designer from the command line.

What should I do if I do not want to have a permanent connection to SAP, but would like to have a connection established by the adapter when required?

You can dynamically set up connection to SAP when the adapter receives the message. When using Dynamic Logon, your user credentials can be passed at the time the request is sent to the adapter. For information regarding its configuration, see Event Driven Inbound Connections on page 310.

When an error occurs in a Subscription Service adapter service, where is it displayed?

Errors that occur in an Request-Response Service are sent to the client. Errors that occur in a Subscription Service are logged to a trace file. The log file path and name is set in the .tra file corresponding to the adapter instance. All logs are sent to <install_path>\adapter\<adapter name>\<version>\logs unless otherwise specified.



When can I use Remote Management?

Management can be used to avoid duplication on the outbound side when you have more than one adapter instance publishing the same IDoc or tRFC.

When posting IDocs to SAP, the processing of IDocs is shown to be slow in the adapter logs.

If the inbound partner profile is set to immediate processing, processing in SAP would block the thread sending the IDoc from processing the next IDoc. It is recommended that the inbound partner profile be set to trigger by background program and processing be managed by SAP.

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 and designer.log under the TIBCO_HOME\Designer\ReleaseNumber\logs directory.

When sending IDocs from SAP, the adapter does not receive the IDocs but the SAP system shows that the IDocs were sent without any errors. Why is not the adapter receiving the IDocs?

This might because you have more than one adapter listening to the same program ID. Ensure that each adapter is configured for a separate program ID. Check you program ID is not used by any other adapter at any given time, in the SAP system go to transaction SM59. Go to your program ID under TCP/IP connection folder then click Test Connection button. The test connection should fail if the adapter instance is not running otherwise other adapter listens to this program ID.

When starting the adapter, what if the repository is not found?

Start the repository server before starting the adapter. If you are starting a remote repository ensure that TIBCO Administrator Repository is installed on the remote location. Ensure that a properly configured .dat file is available in the path specified (local or remote). Ensure that the RepoUrl has been specified accurately in the adapter’s .tra file.

When the outbound adapter receives data from SAP, the data looks garbled or the call to the adapter fails.

Check to make sure that the port type for the RFC Destination using SAP Transaction SM59 is correct. When a new RFC Destination is created, SAP defaults to Non-Unicode even though the DB is Unicode. The port type should always reflect the same type as the DB.



Why does the adapter fail to respond to a request?

The subject name may be inconsistent. The subject name to which the adapter listens may be different from that of the subject name of the client, keep them consistent.

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 from class mismatch, records not being available in the target application or, connectivity problems with the target application.

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, and give the following error, 'Failed to enable CM transport'?

The possibilities of this error are:

• 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 re-start the adapter. If you find a corrupted ledger file, then delete the file. But you might miss some messages.

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 remote repository ensure that the RepoUrl syntax has been specified accurately in the TRA properties file of the adapter. Ensure that the path specified for the TRA file is correct.

What do the following console messages mean when I start the adapter?

When the adapter initializaes upon startup, the following will be observed:

Processing /tibco/private/adapter/R3AdapterConfiguration/SAPAdapter ...

This message is informational only. You can observe the message on all platforms when running the adapter from the command line or the adapter tester of TIBCO Designer. Because it is a console message, you cannot see it in the TIBCO Administrator logs.



80 [main] INFO com.tibco.security.impl.np.SecurityVendor - Initializing JSSE's crypto provider class com.sun.net.ssl.internal.ssl.Provider in default mode

This message is informational only and will be observed based on the classpath specified in the TRA properties file of the adapter as well as the platform where the adapter is run. You can observe the message on all platforms when running the adapter from the command line or the adapter tester of TIBCO Designer. Because it is a console message, you cannot see it in the TIBCO Administrator logs.


| 333

Appendix B Predefined Global Variables

Table 78 lists and explains the predefined global variables specific to TIBCO ActiveMatrix Adapter for SAP. Some global variables are automatically used within the system when an adapter configuration is defined.

For the global variables predefined in TIBCO Adapter SDK, see "Predefined Global Variables" in Chapter 2, "Adapter Configuration", in TIBCO Designer User’s Guide.

Table 78 Predefined Global Variables

Variable Description

AppServer Network name of the SAP application server host machine.

Client SAP client number.

CodePage SAP application server code page. Set this to view IDoc/RFC /BAPI schema descriptions in non LATIN-1 character sets in TIBCO Designer.

The selected value is only used by the non-unicode adapter at runtime.

GatewayHost Gateway host name, IP address or router string. If no machine is specified as a gateway host, the value of this variable is the same as the AppServer value.

GatewayService 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 Server program for the SAP system.

SystemNumber SAP database instance number.

UserName Valid user name to log into the SAP client specified.


334 | Appendix B Predefined Global Variables

You can only maintain the predefined global variables listed in Table 78 at the root level of an adapter project. You cannot move the variables elsewhere in the project. If you want to maintain the variables in other locations, you need to create the global variables by yourself.


| 335

Appendix C Adapter Properties File

The runtime adapter service parses a properties file at startup.

This appendix introduces the TRA properties file and the adapter properties defined in TIBCO ActiveMatrix Adapter for SAP

Topics

• Overview of Adapter Properties File, page 336

• Properties File Format, page 337

• Password Handling, page 338

• Adapter Properties, page 339


336 | Appendix C Adapter Properties File

Overview of Adapter Properties File

The runtime adapter parses one or more properties files at startup. The default runtime adapter properties files for TIBCO ActiveMatrix Adapter for SAP are:

• adr3.tra

• adr3TIDManager.tra

• adr3Discoverer.tra

The default properties file is located in the TIB_ADR3_HOME\bin directory.

The adapter also provides template TRA files for each properties file, when the actual properties file is corrupted or deleted by mistake.

Each line in a properties file is a single property. Each property consists of a key and a value. The key starts with the first non-whitespace character and ends at the first occurrence of these characters:

(space) : =

The value starts at the first character after any of the three characters listed above.

For example:

tibco.configurl=/tibco/private/adapter/test/config/config1tibco.repourl=tibcr://TEST_PROJECTtibco.username=admintibco.password=samplePasswordtibco.clientVar.service=7600tibco.clientVar.daemon=tcp:7600

Properties defined in the properties file of a deployed service override the same properties defined in the project. The properties file for a deployed service is located in the following directory:

TIBCO_TRA_DOMAIN_HOME/domainName/application/applicationDeploymentName


Properties File Format | 337

Properties File Format

The following restrictions apply to properties:

• Do not use the exclamation point (!) as a comment line indicator. Instead, use the number sign (#).

• The line continuation character is ignored, and you cannot define a property with multi-line values.

• A key cannot contain any of the termination characters. Although you can use termination characters by escaping the value with a preceding backslash (\) in Java, TIBCO ActiveMatrix Adapter for SAP does not support this syntax.

• All paths inside a properties file, including Microsoft Windows directory names, must use forward slashes.



Password Handling

You can use the obfuscate utility installed with TIBCO Runtime Agent to encrypt confidential information, such as passwords in property files, with an encryption key. The obfuscate utility rewrites a Java property file by encrypting property values that start with a #!! or #! prefix. The utility is located in TIB_TRA_HOME/bin.

If you plan to run the adapter locally, define the runtime password value as a global variable. Before starting the adapter, include the runtime password as a client variable in the properties file and obfuscate it using the obfuscate utility.

For example, follow these steps to encrypt the password:

1. Define the password myPassword as a global variable with no value.

2. Include the following entry in the TRA file of the adapter at runtime:tibco.clientVar.myPassword=#!!passwordValue

3. Invoke the following command:

TIB_TRA_HOME/bin/obfuscate TRAFileName

for detailed information about how to use the obfuscate utility, see "Obfuscate Utility" in TIBCO Runtime Agent Installation.


Adapter Properties | 339

Adapter Properties

Properties are in two categories: Required Properties and TIBCO ActiveMatrix Adapter for SAP Properties. This section explains these properties.

Required PropertiesTable 79 lists the properties required by a runtime adapter.

Most required properties are predefined by TIBCO Adapter SDK. See "Properties Files" in TIBCO Adapter SDK Programmer’s Guide for detailed information.

Table 79 Required Runtime Adapter Properties File Parameters


tibco.repourl repository_url Absolute path name to the local repository where the adapter instance is defined. For example: C:/TIBCO/LocalRepositories/repo.dat

For a remote project, the repourl value should use the form tibco.repourl tibcr@name where name is the repository name. For example: tibco.repourl tibcr@AdapterRepoDefault

For UNIX platforms, the path separator should include a single forward slash (/). For example: /local/tibco/repo/repo.dat

tibco.configurl relative_path

or

tibco.configurl absolute_path

Location of the adapter service inside the project file. If a relative path is specified, the adapter service is assumed to be under the default area in the project file (/tibco/private/adapter/). For example, the following value connects to an adapter service named adapterpub in the /tibco/private/adapter/ directory:tibco.configurl adapterpub

If an absolute path is specified, the adapter instance is looked up in the repository as defined by the argument. For example: tibco.configurl /tibco/private/adapter/adapterpub

tibco.instanceid instance_name Name of the adapter instance.

The length of the name cannot be larger than 80 characters.

application.args arguments Properties (TRA) file to pass to the running adapter. For example:

application.args -system:propFile TIBCO_TRA_DOMAIN_HOME/domainName/application/applicationDeploymentName/applicationDeploymentName-ServiceName.tra

application.start.dir adapter_path_name

The path name of the adapter to start. For example:

application.start.dir TIB_ADR3_HOME/bin



TIBCO ActiveMatrix Adapter for SAP PropertiesThis section introduces the TRA properties predefined in TIBCO ActiveMatrix Adapter for SAP:

• For adapter properties, see Table 80 on page 340.

• For TIDManager properties, see Table 81 on page 345.

• For Discovery Agent, because it is a specially-configured inbound adapter instance, TIBCO ActiveMatrix Adapter for SAP does not have any properties that are specific to its use. Properties that can be relevant to Discovery Agent are as follows, but you need to maintain them in a separate TRA file for Discovery Agent:

— adr3.trace.extended

— adr3.trace.thread

— adr3.trace.log4j.properties

— adr3.stopJMSEndpoint

— adr3.stopSubject

— adr3.MACHINE_NAME

Table 80 Adapter Properties in TIBCO ActiveMatrix Adapter for SAP (Sheet 1 of 6)

Property Default Description

adr3.contextTimeout Commented out. If specified, this property will override the contextTimeout property defined in the closure class during an inbound transaction from TIBCO ActiveMatrix BusinessWorks.

adr3.discovery ON

Commented out.

Turns on or off the dynamic discovery feature.

adr3.discovery.appserver.suffix Commented out. The property is appended with the server names returned by the discovery agent.

For example, if the server name returned by the discovery agent is tibdemo and the value specified is na.tibco.com, then the server connection will use server name tibdemo.na.tibco.com.

It is recommended to use this property when DNS services are required for connectivity.



adr3.discovery.listenerSession Commented out. Session used by the subscriber created internally in the adapter.

Required when using the dynamic discovery feature for the outbound adapter.

adr3.discovery.listenerSubject R3.APPSERVERS.ACTIVE

Commented out.

Destination used by the subscriber created internally in the adapter.


adr3.discovery.maxconnections 1

Commented out.

Maximum number of connections that can be established to the gateway of each discovered application server.


Note: The adr3.discovery.maxconnections property will overwrite adr3.maxconnections when both of them are used.

adr3.discovery.maxretryinterval Commented out. Maximum retry interval in seconds when re-establishing the connection with the discovered application server.


adr3.discovery.pid Commented out. Program IDs on which to register with the gateway of the discovered application server.

Specify multiple program IDs as comma-separated values.






adr3.expiration_check_period Commented out. The interval in seconds for checking idled inbound connections to the SAP system. If not specified, an idled connection is checked every 60 seconds and closed automatically based on the configuration mentioned using property adr3.expiration_time. It is recommended that this property be used only in cases where it is required.

Note: This property is not configurable by using TIBCO Administrator.

Note: This property is used to control SAP JCo property jco.destination.expiration_check_period. For more information on the usage of this property, see the SAP JCo documentation.

Note: The time observed when the connection is closed may not exactly match the time configured.

adr3.expiration_time Commented out. The amount of idle time allowed in seconds for inbound connections to the SAP system. If not specified and if a connection is idled for more than 60 seconds, the connection to the SAP system is closed automatically.

It is recommended that this property be used only in cases where it is required.

Note: This property is not configurable by using TIBCO Administrator.

Note: This property is used to control SAP JCo property jco.destination.expiration_time. For more information on the usage of this property, see the SAP JCo documentation.

adr3.idocLogDirectory Commented out. Directory to log the IDoc to a file.

The value overrides the directory specified in the project.





adr3.jmscompress ON Turns on or off the feature of compressing messages by using TIBCO Adapter SDK, when the Publication Service is using JMS transport.

adr3.MACHINE_NAME TIBCO Universal Installer populates the machine name at the time of installation.

If the stop subject is not specified in property adr3.stopSubject, then the adapter dynamically builds the stop subject with this property. The convention for the stop subject when using this property is value of (adr3.MACHINE_NAME) + "." + value of (instanceID) + "." STOPADAPTER. The result is then converted to all uppercase.

adr3.maxconnections Commented out. The value of maxConnections for all connection pools in the adapter instance. including server connection pools and client connection pools.

adr3.operationName.invocationTimeout

Not specified by default.

Timeout value for the invocation. This property is dynamic and based on the name of the RFC or BAPI that is used for the invocation. If a property exists for a given RFC or BAPI then it overrides the invocation timeout specified for the corresponding endpoint. If no timeout is specified for the endpoint and this property is not specified for the RFC or BAPI, then the adapter defaults to 300000 ms, which is the default time allowed by the SAP system.

Note: This property is not configurable in TIBCO Administrator.





adr3.rfcBapiReplaceNullFieldsWithSpace

Commented out. This property was introduced in TIBCO ActiveMatrix Adapter for SAP 6.2 to prevent the TIBCO ActiveMatrix BusinessWorks mappings from being changed when you migrate a project from a non-Unicode adapter version to a Unicode version. Since the Java based adapter continues to behave as the prior Unicode adapter, the adapter continues supporting the property.

Note: You need to specify this property only in one of the following conditions:

- When migrating from a prior release of the adapter where the property was being used.

- When migrating from a prior release of the adapter where the non-Unicode adapter was used and the TIBCO Designer project was set to the ISO8859_1 message encoding.

adr3.stopJMSEndpoint Commented out. JMS endpoint used as the stop subscriber for the adapter.

adr3.stoponsubscribersaperror Commented out. Turns on or off the adapter behavior that when the adapter sends an IDoc to the SAP system and receives an exception back from the system, it will stop.

adr3.stopSubject Commented out. Destination of the stop subscriber in the adapter.

Note: TIBCO Administrator relies on TIBCO Hawk and TIBCO Adapter SDK for the feature of using a stop subscriber to stop the adapter.

adr3.trace.extended OFF

Commented out.

Controls the logging of the adapter:

- ON The logging uses Log4J.

- Commented out or OFF The logging uses services from TIBCO Adapter SDK.





adr3.trace.log4j.properties The adr3.log4j.properties file in the TIB_ADR3_HOME/bin folder.

Commented out.

Configuration information required by Log4J.

This property is required when adr3.trace.extended is ON.

adr3.trace.service OFF

Commented out.

Turns on or off the option to configure logging at the adapter service level.

If both adr3.trace.extended and this property are ON, you can configure logging at the adapter service level.

adr3.trace.thread OFF

Commented out.

Turns on or off the option to print the thread ID in the adapter logs.

Table 81 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP (Sheet 1 of 2)


adr3TIDManager.MACHINE_NAME TIBCO Universal Installer populates the machine name at the time of installation.

If the stop subject is not specified in property adr3TIDManager.stopSubject, then the adapter dynamically builds the stop subject with this property. The convention for the stop subject when using this property is value of (adr3TIDManager.MACHINE_NAME) + "." + value of (instanceID) + "." STOPADAPTER. The result is then converted to all uppercase.

adr3TIDManager.stopJMSEndpoint Commented out. JMS endpoint used as the stop subscriber for the remote TIDManager.

adr3TIDManager.stopSubject Commented out. Destination of the stop subscriber in the remote TIDManager.

Note: TIBCO Administrator relies on TIBCO Hawk and TIBCO Adapter SDK for the feature of using a stop subscriber to stop the adapter.

adr3TIDManager.threadPool 1

Commented out.

Number of threads used by TIDManager for responding to requests.





adr3TIDManager.tidFile Commented out. File name of the tidFile for the remote TIDManager.

adr3TIDManager.trace.extended OFF

Commented out.

Controls the logging of the remote TIDManager:

- ON The logging uses Log4J.

- Commented out or OFF The logging uses services from TIBCO Adapter SDK.

adr3TIDManager.trace.log4j.properties

The adr3.log4j.properties file in the TIB_ADR3_HOME/bin folder.

Commented out.

Configuration information required by Log4J.

This property is required when adr3TIDManager.trace.extended is ON.

adr3TIDManager.trace.thread OFF

Commented out.

Turns on or off the option to print the thread ID in the TIDManager logs.

The following properties are no longer applicable and removed from the TRA properties file and TIBCO Administrator:

• adr3.addCustomHawkMethodsToClassMAgent

• adr3.commitid

• adr3.createRefreshTimer

• adr3.disableTransactionalIDoc

• adr3.eventtimeoutms

• adr3.Hawk500

• adr3.keeprfcalive

• adr3.locale

• adr3.perfMon

• adr3.preserveFieldBlanks

• adr3.requireSlashReplacement

• adr3.stacksize

• adr3.traceOldMessages

Table 81 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP (Sheet 2 of 2)



| 347

Appendix D Trace Messages

This appendix explains the trace messages that are logged to a location specified at configuration time.

Topics

• Overview of Trace Messages, page 348

• Fields of Trace Message, page 349

• Status Messages of TIBCO ActiveMatrix Adapter for SAP, page 352


348 | Appendix D Trace Messages

Overview of Trace Messages

Trace messages provide information about adapter activities. The messages are logged 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, or sent 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 Fields of Trace Message on page 349. The following diagram shows an example trace message and calls out the fields.

Example of Trace Messages

The following trace messages were written during a session where the adapter received a message from the SAP system.

The first message indicates that the adapter has started. The timestamp indicates when the adapter started, and the role indicates that the trace message is informational, which means the activity is normal for the adapter. The category is identified, and the corresponding status code is displayed. The status code indicates 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 the SAP system. The #-0Y--C--DX1ALUbc--4zzzw-TEzzw# tracking identifier included 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 for BAPI_SALESORDER_CREATEFROMDAT1 from SAP R/3 System tracking=#-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.....


Fields of Trace Message | 349

Fields of Trace Message

Each trace message includes the following fields:

Table 82 Trace Message Fields

Field Name Description

Timestamp Timestamp of occurrence. For example, 2010 Feb 22 20:14:51:718 GMT -8.

Adapter Identifier Name of the adapter that wrote the trace message. This is a combination of the adapter acronym and adapter configuration name. For example, the application identifier, AER3.publisher1 identifies a TIBCO ActiveMatrix Adapter for SAP system service named publisher1.

Role A role can be:

• Debug Indicates a developer defined trace message. In normal operating conditions, debug messages should not display.

• Error Indicates an unrecoverable error occurred. Depending on the error severity, the adapter may continue with the next operation or may stop altogether.

• Info Indicates normal adapter operation. No action is necessary. A trace message tagged with info indicates that a significant processing step was reached and has been logged for tracking or auditing purposes. Only info messages preceding a tracking identifier are considered significant steps.

• Warn Indicates an abnormal condition was found. Processing will continue, but special attention from an administrator is recommended.

When configuring the adapter you define what roles should or should not be logged. For example, you may decide not to log Info roles to increase performance.



Category Trace message can be grouped as one of the following categories:

• Adapter The adapter is processing an event.

• Application The adapter is interacting with the SAP system.

• Configuration The adapter is reading configuration information.

• Connection This is an application connection related trace message.

• Data The area of adapter responsible for the marshaling of data to and from the SAP system.

• Database The adapter is interacting with a database.

• DTA The Design Time Adapter retrieves SAP schema.

• Hawk The area of adapter responsible for Hawk monitoring and custom methods.

• Palette The adapter is interacting with the palette.

• Publication The Publication Service is reporting this trace message.

• Repository The configuration of designer project.

• Request-Response The Request-Response Service is reporting this trace message.

• Request-Response Invocation The Request-Response Innvocation Service is reporting this trace message.

• Schema The adapter is retrieving metadata from the SAP system.

• Shutdown The adapter is shutting down.

• Startup The adapter is starting.

• Subscription The Subscription Service is reporting this trace message.

• System This category is not linked to a specific event process. The trace message may be related to a Windows Service related messages, memory allocation, file system error, and so on.

• TibRvComm The adapter is communicating with TIBCO Rendezvous.

• XML The adapter is parsing XML documents.

Table 82 Trace Message Fields (Cont’d)



Fields of Trace Message | 351

Status Code Unique code for the message and description. Status codes are identified by an unique number and description. If a trace message includes an error or warn role, the status code documentation includes a resolution. See Status Messages of TIBCO ActiveMatrix Adapter for SAP on page 352 for details.

Tracking Identifier An unique identifier that is “stamped” on each message by the originating adapter. The tracking identifier remains in effect from a message’s beginning to its completion as it is exchanged by TIBCO applications. If the adapter is the termination point of the message, the tracking identifier is not displayed in the trace message.

You cannot modify the tracking identifier format or configure what information to be displayed.

Application Information Application specific information added to the tracking info to trace the message back to its source. Set initially by the originating adapter and carried forward. It is augmented by each intermediate component.

Table 82 Trace Message Fields (Cont’d)




Status Messages of TIBCO ActiveMatrix Adapter for SAP

In this section we listing status messages of TIBCO ActiveMatrix Adapter for SAP, based on the nature of these status messages we categorizes them in to the following groups:

• Trace Messages of TIBCO ActiveMatrix Adapter for SAP, page 352

• Design-Time Trace Messages, page 391

• Trace Messages Discontinued, page 400

Trace Messages of TIBCO ActiveMatrix Adapter for SAPTrace messages are categorized in to the following groups.

• Trace Messages for Adapter Category, page 352

• Trace Messages for Application Category, page 378

• Trace Messages for Configuration Category, page 378

• Trace Messages for Data Category, page 386

• Trace Messages for Hawk Category, page 386

• Trace Messages for Publication Category, page 387

• Trace Messages for Request-Response Category, page 387

• Trace Messages for Request-Response Invocation Category, page 388

• Trace Messages for Subscription Category, page 389

• Trace Messages for System Category, page 390

Trace Messages for Adapter Category

In adapter category there are four groups of trace messages detailed as the following.

• Debug Messages, page 353

• Error Messages, page 353

• Info Messages, page 363

• Warn Messages, page 374


Status Messages of TIBCO ActiveMatrix Adapter for SAP | 353

Debug Messages

For details of debug messages for adapter category, see Table 83.

Error Messages

For details of error messages for adapter category, see Table 84.

Table 83 Debug Messages for Adapter Category

Status Code Role Category Description Resolution

AER3-DEBUG-ADAPTER Debug Adapter %1 Adapter debug messages. No action required.

Table 84 Error Messages for Adapter Category


AER3-000001 Error Adapter Invalid closure data for operation %1

Create a correct instance of RFC_CLOSURE defined in SAPAdapterSchema.xml and set it as closure data in the request to be sent to the inbound adapter. To find out more about closure, refer to TIB Adapter SDK documentation and TIBCO 2.0 ActiveEnterprise wire format.

AER3-000031 Error Adapter Unsupported data type %1

The datatype is unsupported by SDK or SAP or both.

AER3-000033 Error Adapter Class name invalid for IDoc

The adapter received an IDoc but could not determine its class. If you are creating the IDoc meant to be consumed by the adapter, ensure that you are creating it correctly.

AER3-000044 Error Adapter Unable to create function imply for %1

Look at earlier error messages in the log file(s) for possible causes.

AER3-000045 Error Adapter RFC function initialization failure: %1; function name: %2

Look at the error description for the cause of the failure.

AER3-000046 Error Adapter Cannot create publisher proxy for %1




AER3-000068 Error Adapter Cannot create IDoc data instance from received IDoc tree

The adapter subscriber received MTree data but the received data could not be converted to an MInstance. Because a MInstance is a MTree bounded by a class, the error implies that the received MTree is incorrect. If it is your application that is sending the offending data to the adapter subscriber, make sure that your data is valid.

AER3-000072 Error Adapter Client connection %1 is invalid

Ensure that the login parameters are correct and that the Adapter can reach the SAP system.

AER3-000102 Error Adapter Operation timed out %1

Make sure Manager is running and is accessible from the Adapter. Also, ensure that subject names match.

AER3-000122 Error Adapter The IDoc %1 does not contain a control record

Make sure that the IDoc contains a control record.

AER3-000124 Error Adapter The received IDoc tree in exploded form is null

Make sure that the Tree (MTree in SDK) is created correctly and corresponds to an IDoc.

AER3-000131 Error Adapter Cannot get EDIDD header attribute from the fields for segment %1

Check the data. It must include the EDIDD header.

AER3-000136 Error Adapter The %1 record sequence does not contain a valid control record

Check the data first. Make any changes. Check the configuration for an appropriate definition.

AER3-000138 Error Adapter The %1 record does not contain attribute %2

Indicates normal adapter operation. No action necessary.

Table 84 Error Messages for Adapter Category (Cont’d)




AER3-000141 Error Adapter Subscriber: %1, the message could not be recovered


AER3-000200 Error Adapter Failed to update state for transaction %1.

Ensure that the user has write permission for tidfile.

AER3-000207 Error Adapter The class %1 does not specify attribute %2

The attribute is invalid for the named class. Check the repository. Re-create the class definition (if you suspect it has been incorrectly created) or modify the class definition to include the named attribute.

AER3-000273 Error Adapter Invalid Connection for pool %1

Check the pool definitions to ensure that they are valid.

AER3-000282 Error Adapter Receive reply failed for: %1

Refer to the accompanying error messages for additional details.

AER3-000310 Error Adapter Received Error Advisory Message: %1, Subject: %2

This is an error advisory thrown by a TIBCO Infrastructure component. The message %1 is context-sensitive. Report the error to TIBCO Support.

AER3-000431 Error Adapter Unable to create marshaller for operation %1

Look at earlier error messages in the log-file(s) for possible causes.

AER3-000460 Error Adapter Failed to active service %1

SDK Error: %2

AER3-000461 Error Adapter Connection Error Unable to create a connection with the target application %1 using connection parameters %2 and the target application error is %3.





AER3-000472 Error Adapter adr3 The TRA property adr3.discovery.pid is not defined in the adapter TRA file. Property needs to be maintained using TIBCO Administrator if configuration is deployed or in the TRA file if adapter is being running in adapter tester inside TIBCO Designer or from command line.

AER3-000474 Error Adapter Error creating discovery listener with session %1 and listen-subject %2

Look at the error description for the cause of the error.

AER3-000483 Error Adapter Function is a queue RFC

Request-Response adapter service received property bQueue = "true" in the RFCLOSURE but no queue name was provided using property qName. If not using qRFC then set bQueue = "false" or supply a queue name using qName property.

AER3-000486 Error Adapter Invalid Destination %1 specified

Specify a valid destination.

AER3-000500 Error Adapter Unsupported datatype: class %1. Parameter: %2

This datatype is not supported.

AER3-890006 Error Adapter Connection Error. Adapter stopping due to persistent connection errors to the SAP R/3 system(s).

AER3-910005 Error Adapter Exception: %1 Verify your repository settings.

AER3-950013 Error Adapter Marshaller exception at %1


AER3-950014 Error Adapter Unmarshaller exception at %1






AER3-970009 Error Adapter No publisher found for IDoc: %1

An IDoc was sent to the outbound adapter from SAP system but no Publication adapter service exists for the IDoc received. Verify that the Program ID and the configuration of the adapter is correct.

AER3-970010 Error Adapter Unable to set auto confirmation to OFF for service: %1


AER3-970014 Error Adapter Error decrypting password for connection %1, message: %2

Adapter was unable to decrypt the password supplied on the RFCCLOSURE class used for the feature dynamic connections. Verify that the password was encrypted by the obfuscation tool available from TRA.

AER3-970015 Error Adapter Error adding %1, message: %2

Adapter was unable to add adapter service due to the error message provided. Verify that the service refers to the correct schema and client connection in the case of inbound services.

AER3-970016 Error Adapter Cannot get server connection %1

Server Connection pool %1 does not exist in the adapter configuration or is invalid. Verify the configuration of the pool.

AER3-970017 Error Adapter Cannot get client connection %1

Client Connection pool %1 does not exist in the adapter configuration or is invalid. Verify the configuration of the pool.

AER3-970018 Error Adapter Cannot create Publisher %1, invalid connection %2






AER3-970019 Error Adapter Cannot create Subscriber %1, %2

Verify that server connection pool(s) are correct in configuration.

AER3-970021 Error Adapter Cannot create RPC Server %1, %2


AER3-970031 Error Adapter Server connection pool: gatewayHost=%1 gatewayService=%2 programID=%3 update error: %4

Hawk method setOutboundThreadPool was invoked and error occurred. Look at the error description for the cause of the error.

AER3-970033 Error Adapter Client connection pool name: %1 update error: %2

None

AER3-970035 Error Adapter Log4J refresh error: %1 Hawk method refreshExtendedLogging generated error. Verify the Log4J configuration exists and configuration is correct.

AER3-970036 Error Adapter Deactivation of subscriber for Discovery Agent failed due to error: %1


AER3-970250 Error Adapter Subscriber not found for IDoc %1

No subscription adapter service exists for IDoc mentioned. Verify adapter configuration.

AER3-970251 Error Adapter Cannot read RFCClosure class: %1

Adapter is expecting the closure class RFCCLOSURE but received a different class instead. Verify that the closure class being used during the invocation is RFCCLOSURE.





AER3-970256 Error Adapter Error in Transaction with SessionID: %1

No response was provided within the configuration defined for context timeout. The context timeout can be modified accordingly during the invocation or defined using the TRA property adr3.contextTimeout.

AER3-970257 Error Adapter Transaction with SessionID: %1 timed out

Look at earlier error messages in the log file(s) for possible cause of error

AER3-970258 Error Adapter Cannot find transaction with SessionID: %1 to Continue

No activity within the timeframe of context timeout. Modify the context timeout accordingly as needed.

AER3-970259 Error Adapter Encountered: %1, in transaction with SessionID: %2


AER3-970260 Error Adapter Subscriber %1, received error: %2


AER3-970261 Error Adapter Error encountered during on Event of Discovery Agent: %1


AER3-970262 Error Adapter Unable to create additional servers: %1


AER3-970267 Error Adapter Error invoking inbound RFC Request Response: %1


AER3-970268 Error Adapter One way invocation error One way invocation service %1 listening on subject %2 failed to create reply Error: %3






AER3-970269 Error Adapter Adapter Error: %1 Look at the error description for the cause of the error.

AER3-970271 Error Adapter Error occurred while changing dispatcher count for service name: %1 error: %2

Hawk method setInboundThreadPool wa invoked with error. Look at the error description for the cause of the error.

AER3-970272 Error Adapter Error creating GUID: %1


AER3-970273 Error Adapter SDK error %1 : %2 Look at the error description for the cause of the error.

AER3-970277 Error Adapter Server connection %1 is invalid: %2


AER3-970278 Error Adapter Serialization failed for publisher: %1 operation/class: %2


AER3-970281 Error Adapter Error creating stop Subscriber, code: %1, Message: %2


AER3-970285 Error Adapter One way invocation error One way invocation service %1 listening on subject %2 failed due to target application invocation error %3 Target application is %4 and inbound event is %5


AER3-970288 Error Adapter Invalid Error Destination for service %1 Error: %2






AER3-970292 Error Adapter Initialization of Discovery Agent failed, received error: %1 Attempting to stop the adapter


AER3-970293 Error Adapter Context timeout is Zero, cannot continue RFC invoke in context

Specify a context timeout during the invocatin of Request-Response adapter service or maintain the TRA property ad3.contextTimeout.

AER3-970500 Error Adapter Unmarshall of table for parameter: %1 failed, error: %2


AER3-970501 Error Adapter Unmarshall of table for parameter: %1 failed at row index: %2, error: %3


AER3-970502 Error Adapter Unmarshall of instance: %1 for field: %2 failed, error: %3


AER3-970503 Error Adapter Unmarshall for parameter: %1 of instance: %2: for field: %3 failed, error: %4


AER3-970504 Error Adapter Set of instance: %1 for field: %2 failed, error: %3


AER3-970505 Error Adapter Set of parameter: %1 on request failed, error: %2


AER3-970506 Error Adapter Set of parameter: %1 on reply failed, error: %2






AER3-970507 Error Adapter Unable to retrieve SDK value for field: %1: error: %2


AER3-970508 Error Adapter Marshaling error for %1, value %2, exception: %3, message: %4


AER3-970509 Error Adapter Unmarshaling error for %1, value %2, exception: %3, message: %4


AER3-970510 Error Adapter Error unexpected Marshaling exception: %1 at %2, message: %3


AER3-970511 Error Adapter Error unexpected Un-Marshaling exception: %1 at %2, message: %3


AER3-970512 Error Adapter Error Parsing schema at %1 : %2


AER3-970513 Error Adapter Data type conversion error, The supplied SDK data is null

Verify schema of adapter service against supported SAP data types.

AER3-970514 Error Adapter SDK Data %1 type conversion to SAP Type not supported, check metadata

Verify schema of adapter service against supported SAP data types.

AER3-970516 Error Adapter Error setting attribute %2 for class %1, message: %3


AER3-970517 Error Adapter Error getting sequence data for class attribute %1, message: %2






Info Messages

For details of info messages for adapter category, see Table 85..

AER3-970518 Error Adapter Error constructing instance for class %1, message: %2


AER3-970519 Error Adapter Error occurred while setting sequence data for class %1, message: %2


AER3-970520 Error Adapter Error constructing sequence for class %1, message: %2


AER3-970521 Error Adapter Unable to set field %1 in structure: %2 error: %3


AER3-970522 Error Adapter No control records found in packet of IDocs

IDoc received contained no EDI_DC/EDI_DC40 records. Verify the IDoc sent to the adapter.

AER3-970523 Error Adapter No data records found in packet of IDocs

IDoc received contained no EDI_DC/EDI_DC40 records. Verify the IDoc sent to the adapter.

AER3-970524 Error Adapter Creation of MInstance failed for operation: %1 error: %2




Table 85 Info Messages for Adapter Category


AER3-000000 Info Adapter The request does not contain closure data for operation %1




AER3-000040 Info Adapter Adding RFC function "%1"

For an inbound configuration, the message means that the adapter can serves as an RFC Client.

For an outbound configuration, the message means that the Adapter can serve as an RFC Server.

AER3-000078 Info Adapter Successfully added RFC function %1

The Adapter successfully added the named RFC function. Depending on the configuration, the adapter can function as an RFC client, RFC Server, or both.

AER3-000082 Info Adapter Successful initialization of Adapter


AER3-000085 Info Adapter IDoc sent in %1 mode Indicates normal adapter operation. No action necessary.

AER3-000086 Info Adapter IDoc received in %1 mode

Indicates normal adapter operation. No action necessary

AER3-000091 Info Adapter Total IDocs processed: %1


AER3-000093 Info Adapter IDoc Message confirmed to sender


AER3-000094 Info Adapter Posting IDoc to client %1


AER3-000095 Info Adapter IDoc posted to client %1 successfully


AER3-000103 Info Adapter Adding %1 parameter %2, Type %3


AER3-000106 Info Adapter Adapter", " %1 = { %2 } Indicates normal adapter operation. No action necessary.

Table 85 Info Messages for Adapter Category (Cont’d)




AER3-000107 Info Adapter Adapter", "Number of records in table %1 = %2


AER3-000108 Info Adapter Invoking function: %1 Indicates normal adapter operation. No action necessary.

AER3-000109 Info Adapter Successfully invoked function: %1


AER3-000110 Info Adapter Reply sent for function: %1


AER3-000111 Info Adapter Received reply for: %1 Indicates normal adapter operation. No action necessary.

AER3-000112 Info Adapter Data sent back to SAP R/3 System


AER3-000113 Info Adapter Performing one way invocation on the server


AER3-000114 Info Adapter Received invocation request for %1 from SAP R/3 System


AER3-000115 Info Adapter Performing invocation on the server


AER3-000116 Info Adapter Function call is transactional, TID: %1


AER3-000117 Info Adapter Received invocation request for %1


AER3-000118 Info Adapter Invoking RFC function %1 in SAP System


AER3-000119 Info Adapter Received one way invocation request for %1






AER3-000120 Info Adapter Invoking transactional RFC function %1 in SAP R/3 System


AER3-000121 Info Adapter Cannot get class descriptions for control record of IDoc class %1


AER3-000133 Info Adapter The segment instance %1 does not contain attribute %2


AER3-000134 Info Adapter The default values will be used


AER3-000135 Info Adapter Segment name: %1 added


AER3-000139 Info Adapter trying to recover the received message


AER3-000140 Info Adapter Subscriber: %1, Exception occurred on receiving the message


AER3-000146 Info Adapter Function called transactionally but Transaction Identifier (TID) not supplied


AER3-000156 Info Adapter Writing IDoc %1, Number %2 to file: %3, ServiceName %4 SubjectName %5


AER3-000164 Info Adapter Connection disconnected


AER3-000165 Info Adapter Connection re-established


AER3-000166 Info Adapter Connection State: Available






AER3-000167 Info Adapter Connection State: Pending invocation


AER3-000172 Info Adapter Adapter stop method called


AER3-000173 Info Adapter Subscriber %1 suspended


AER3-000177 Info Adapter Stopping Adapter %1 instance on host %2


AER3-000178 Info Adapter Stop notification received via StopSubscriber


AER3-000186 Info Adapter Transaction %1 skipped

The Adapter did not execute this transaction because it was already executed.

AER3-000188 Info Adapter Failed to %1 Tid The Adapter could not perform the named /Manager function. Check the /Manager display for possible causes.

AER3-000195 Info Adapter Transaction created %1 Indicates normal adapter operation. No action necessary.

AER3-000196 Info Adapter Transaction skipped %1


AER3-000197 Info Adapter Transaction committed %1


AER3-000198 Info Adapter Transaction confirmed %1


AER3-000199 Info Adapter Transaction rolled back %1


AER3-000201 Info Adapter Starting inbound transaction %1






AER3-000202 Info Adapter Inbound transaction %1 completed


AER3-000240 Info Adapter Adapter received stop notification

Adapter was stopped either intentionally or by error during startup. Refer to prior log messages for any errors.

AER3-000263 Info Adapter Using Logon Groups Indicates normal adapter operation. No action necessary.

AER3-000264 Info Adapter Using a dedicated connection


AER3-000265 Info Adapter Creating a Server connection


AER3-000312 Info Adapter Received Info Advisory Message: %1, Subject: %2

Adapter received an informational advisory message. No action is required.

AER3-000412 Info Adapter Obtaining connection for R/3 client %1 for %2


AER3-000430 Info Adapter Total requests processed for operation %1 : %2


AER3-000441 Info Adapter TID management is remote


AER3-000448 Info Adapter Suspended service %1 None.

AER3-000450 Info Adapter Activated timer to check connectivity to R/3 for connection-pool %1

None.





AER3-000458 Info Adapter Activated services associated to connection-pool %1

Adapter connected successfully to the SAP system and all suspended services related to the connection are restarted. No action is required.

AER3-000459 Info Adapter Activated service %1 Inbound adapter service was activated. No further action is required.

AER3-000463 Info Adapter Invoking queue RFC function %1 in SAP R/3 System

Request-Response adapter service received request to send data to SAP system using qRFC protocol. No action is required.

AER3-000464 Info Adapter Inserting the RFC function %1 to the queue %2

Request-Response adapter invoking the function module in SAP as qRFC using the queue name mentioned. No action is required.

AER3-000465 Info Adapter Successfully inserted the RFC function %1 to the queue

Request-Response adapter successfully invoke the function module in SAP as qRFC. No action is required.

AER3-000473 Info Adapter Dynamic appserver discovery turned on

Discovery agent tuned on for outbound adapter. No action required.

AER3-000475 Info Adapter Received discovery message from discovery agent

Outbound adapter received message from Discovery Agent. No action required.

AER3-000476 Info Adapter Attempting to create connection with ProgramID %1, GatewayHost %2, GatewayService %3

Outbound adapter attempting to connect to the SAP system. No action required.





AER3-000477 Info Adapter Connection already exists: ProgramID %1, GatewayHost %2, GatewayService %3

Outbound adapter already connected to the SAP system. No action is required.

AER3-000497 Info Adapter Suspending subscription services

Inbound adapter unable to connect to the SAP system and all Subscription services related to SAP system are suspended. Resolve connectivity issues with SAP system.

AER3-000498 Info Adapter Activating subscription services

Inbound adapter re-connected to the SAP system all suspended Subscription services related to SAP system are being activated. No action is required.

AER3-890001 Info Adapter Reconnect attempt %1 for service %2

Adapter attempting to re-connect to the SAP system. No action is required.

AER3-890002 Info Adapter Reconnect succeeded on attempt %1 for service %2

Adapter re-connected to the SAP system. No action is required.

AER3-890007 Info Adapter Service %1 suspended due to reconnect failure

Adapter failed to re-connect to the SAP system. Refer to custom Hawk methods for re-establishing connectivity.

AER3-970001 Info Adapter Initialized SAP Repository: %1

Indicates the repository used for starting the adapter. No action required.

AER3-970002 Info Adapter Application : %1 Indicates the repository used for starting the adapter. No action required.

AER3-970003 Info Adapter RepoURL : %1 Indicates the repository used for starting the adapter. No action required.





AER3-970004 Info Adapter ConfigURL : %1 Indicates the repository used for starting the adapter. No action required.

AER3-970005 Info Adapter Version : %1 Indicates the repository used for starting the adapter. No action required.

AER3-970006 Info Adapter InstanceID : %1 Indicates the repository used for starting the adapter. No action required.

AER3-970007 Info Adapter AppInfo : %1 Indicates the repository used for starting the adapter. No action required.

AER3-970012 Info Adapter Number of connections: %1

Indicates the repository used for starting the adapter. No action required.

AER3-970013 Info Adapter No adapter services configured Stopping adapter

No adapter services configured for adapter. Create required adapter services and restart adapter.

AER3-970022 Info Adapter Service Name: %1 Thread Count: %2

Number of threads for inbound adapter service. No action required.

AER3-970025 Info Adapter TID: %1 TID %1 represents the TID associated to the IDoc or transaciton sent to SAP system. No action required.

AER3-970026 Info Adapter Restarting Remote TID Manager services for gatewayHost: %1 gatewayService: %2 programID: %3

Connectivity to Remote TID Manager was disabled and Hawk method resumeTIDManager was invoked. No action required.





AER3-970027 Info Adapter No server connection pools require restart

Hawk method resumeOutboundServices was invoked but no Server Connection pools exist requiring restart. No action required.

AER3-970029 Info Adapter Connection Manager stopped

Connection services of the adapter are stopped during shutdown. No action required.

AER3-970038 Info Adapter Suspending request/response services

Look at earlier error messages in the log file(s) for possible causes of loss of connectivity for client connection pool. All subscription and request-response (oneway invocation) are disable until connectivity is established. Verify the configuration of the client conneciton pool and network connectivity to the SAP system.

AER3-970039 Info Adapter Activating request/response services

Connectivity to client connection pool was re-established and all inbound services correspond ing to the pool were activated again. No action required.

AER3-970040 Info Adapter Restarting services for gatewayHost: %1 gatewayService: %2 programID: %3

Restarting services for gatewayHost: %1 gatewayService: %2 programID: %3

AER3-970252 Info Adapter Creating dynamic log-on connection

Dynamic connection created for a request-response adapter service. No action required.

AER3-970253 Info Adapter Starting new transaction with SessionID: %1

A new transaction was created using the session ID in the log file. No action required.





AER3-970254 Info Adapter Invoking RFC %1 in transaction for SessionID: %2

None

AER3-970255 Info Adapter Transaction context end for %1

Transaction in inbound adapter ended. No action required.

AER3-970266 Info Adapter Sending IDoc %1, Number %2 to destination: %3, ServiceName %4

In the case of Invalid Destination, adapter is logging IDoc to either file or an endpoint. No action required.

AER3-970270 Info Adapter Successfully changed dispatcher count for service name: %1 to count: %2

Hawk method setInboundThreadPool was invoked successfully. No action required.

AER3-970274 Info Adapter Using SNC connection Server Connection or Client Connection pool of type SNC used by the adapter. No action required.

AER3-970280 Info Adapter StopSubscriber message is %1 and transport is %2

Adapter can be stopped using the destination %1 and transport protocol %2

AER3-970289 Info Adapter Request sent to Error Destination: %1 for operation: %2

Error received from SAP system for a request-response adapter service configured using oneway invocation protocol. Message processed would be sent to the destination %1

AER3-970290 Info Adapter IDocs being saved to file using format: %1

IDoc being saved to file using text or XML format. No action required.

AER3-970294 Info Adapter Context timeout for transaction is %1 ms

Context timeout is set to %1. No action required.

AER3-970297 Info Adapter Restarting connection with ProgramID %1, GatewayHost %2, GatewayService %3

Server Connection pool is suspended and being restarted. No action required.





Warn Messages

For details of warn messages for adapter category, see Table 86..

Table 86 Warn Messages for Adapter Category


AER3-000061 Warn Adapter The IDoc %1 could not be exploded

See AER3-000059.

AER3-000067 Warn Adapter Invalid MTree data received for subscriber

See earlier error messages in the log file(s) for possible causes.

AER3-000169 Warn Adapter Subscriber %1 could not be suspended

The named subscriber could not be suspended. No action necessary.

AER3-000187 Warn Adapter Invalid transaction state received from TID Manager for transaction %1

The Adapter received an invalid stated from Manager. Check the tidmanager display for possible causes.

AER3-000311 Warn Adapter Received Warn Advisory Messages: %1, Subject: %2

Adapter received a warning advisory messages. Review prior log messages to determine if action is required.

AER3-890003 Warn Adapter Reconnect failed on attempt %1 for service %2 will retry in %3 ms

Adapter failed to re-connect to the SAP system multiple times. Adapter will re-try in %3 ms. If issue persists, resolve connectivity issues with SAP system.

AER3-970011 Warn Adapter Unable to deactivate service: %1 error: %2


AER3-970020 Warn Adapter Warning no user defined service is up and running

No adapter services are configured and adapter would stop. Verify the configuration of the adapter.



AER3-970023 Warn Adapter Disabling remote TID manager for server connection: %1, Program ID: %2

Outbound adapter configured to use remote TID Management is unable to communicate with the Remote TID Manager. Adapter configured to disable connectivity to remote TID Manager to avoid timeouts. Verify that the Remote TID Manager is available. If available, invoke custom Hawk method resumeTIDManager to resume connectivity.

AER3-970024 Warn Adapter Remote TID Manager is disabled TID operation: %1 skipped for TID: %2

Remote TID Manager is unavailable the connectivity has been disabled. If Remote TID Manager is available, invoke custom Hawk method resumeTIDManager to resume connectivity.

AER3-970037 Warn Adapter Mismatch found for service: %1, thread count: %2, connection count: %3

The number of threads for inbound adapter service does not match the number of connections defined in the used client connection pool. Modify the number of connections and the thread count accordingly.

AER3-970263 Warn Adapter Dynamic connection warning: Given type is %1, Realized type is %2

Mismatch in connection type supplied in RFCCLOSURE class. Verify the connection type supplied.

AER3-970275 Warn Adapter Server Error: %1 Look at the error description for the cause of the error.

AER3-970276 Warn Adapter Server Exception: %1 Look at the error description for the cause of the error.

Table 86 Warn Messages for Adapter Category (Cont’d)




AER3-970279 Warn Adapter Server Exception: %1 The context timeout provided during the call of trransaction is overriden by the context timeout provided by TRA property adr3.contextTimeout.

AER3-970282 Warn Adapter No connection Reference found for service %1

Inbound adapter service does not refer to a client connection pool. Verify the configuration of the adapter.

AER3-970283 Warn Adapter No Error Destination reference defined for service: %1, defaulting to log to file

Publication or Subscription adapter service configured to publish messages to an endpoint reference in the case of invalid destination error but no valid destination exists. Validate configuration of the adapter.

AER3-970284 Warn Adapter No transaction properties defined during oneway invocation, defaulting to tRFC call for operation: %1

Request-Response adapter service was invoked with no transactional properties defined in the RFCCLOSURE class. Modify the RFCCLOSURE class on the invocation as needed.

AER3-970286 Warn Adapter Operation: %1 for inbound adapter service: %2 configured as one way and Error Destination not defined, error recovery is limited

Request-Response adapter service configured using invocation protocol oneway and no endpoint reference exists in the case of errors returned from SAP system. Modify configuration as needed.

AER3-970287 Warn Adapter Unable to send message to Error Destination: %1 Error: %2, saving message to file






AER3-970291 Warn Adapter Directory specified for logging IDoc is invalid: %1

Directory specified in adapter configuration or in the TRA file is invalid. Current working directory would be used for logging the IDoc.

AER3-970295 Warn Adapter Initialization of Discovery Agent, received warning: %1

Look at the warning description to determine if further action is needed.

AER3-970296 Warn Adapter No services require restart for pool: %1

Custom Hawk method resumeInoundServices was invoked and no inbound services required restart.

AER3-970298 Warn Adapter Server connection pool: %1 suspended due to exceeded attempts to connect to SAP system

Server Connection pool is unable to connect to the SAP system and is being stopped. Verify connectivity to the SAP system.

AER3-970299 Warn Adapter Client connection pool: %1 suspended due to exceeded attempts to connect to SAP system

Clint Connection pool is unable to connect to the SAP system and is being stopped. Verify connectivity to the SAP system.

AER3-970525 Warn Adapter Set of instance: %1 for field: %2 skipped


AER3-970526 Warn Adapter Unable to convert string "%1" to %2 for %3 in %4, data suppressed


AER3-970527 Warn Adapter Parameter %1 does not exist in reply of operation schema

Schema in adapter configuration does not match schema in SAP system. If parameter %1 is required, perform a refresh schema for the particular service.





Trace Messages for Application Category

In application category there is one group of trace messages detailed as the following


Info Messages

For details of info messages for application category, see Table 87.

Trace Messages for Configuration Category

In configuration category there are four groups of trace messages detailed as the following:





Error Messages

For details of error messages for configuration category, see Table 88.

Table 87 Info Messages for Application Category


AER3-000084 Info Application Received IDoc Name/Number/Receiving Partner: %1, Count: %2


AER3-000098 Info Application IDoc RFC Function invoked: %1


Table 88 Error Messages for Configuration Category


AER3-000123 Error Configuration Cannot get class descriptions for data record of IDoc class %1

During configuration ensure that you are downloading the class descriptions.



AER3-000125 Error Configuration Class descriptions cannot be obtained for received IDoc tree

During configuration ensure that you are downloading the class descriptions.

AER3-000126 Error Configuration %1 is not of a sequence type

The named sequence does not have a valid definition. Check the configuration.

AER3-000127 Error Configuration Sequence %1 does not have a contained class description

A sequence is a sequence of objects of type T. The adapter could not determine T, probably because the definitions don’t exist in the configuration.

AER3-000128 Error Configuration Sequence %1 for the segment holder could not be obtained

Check configuration and make sure that a valid definition exists for the named sequence.

AER3-000129 Error Configuration Segment %1 does not have attribute: %2

The data mentioned contains the named attribute, but the class definition does not. Check the configuration and how the IDoc is being created.

AER3-000130 Error Configuration Cannot obtain field class description for IDoc Segment

Check configuration.

AER3-000132 Error Configuration Cannot obtain class description for segment %1 attribute %2

Check the segment name as well as the attribute and make sure that a definition exists in the configuration.

AER3-000137 Error Configuration The %1 record of the IDoc does not have a valid class description

Check the data first. Make any changes. Check the configuration for an appropriate definition.

Table 88 Error Messages for Configuration Category (Cont’d)




AER3-000145 Error Configuration The class descriptions for IDoc base classes cannot be obtained from the registry

During configuration ensure that you’ve downloaded the class definition.

AER3-000203 Error Configuration No class definition exists for %1

The named class is invalid or does not exist. Check the repository to make sure that a valid class exists with that name.

AEADR3-600007 Error Configuration Absolute Path not Found. Field %1, Palette error. Unable to find specified absolute path. Make sure that you have specified the absolute path correctly

Absolute path of the Plugin Directory not found. Check the path.

AEADR3-600011 Error Configuration Error copying Configuration information/Inbound Connection Type does not support copying of connection information from Configuration view

You are trying to copy Design-Time parameters to Run-Time Inbound Connection which is not of type ’Dedicated.’ If you want to copy, make sure that the default inbound connection type is ’Dedicated’.

AEADR3-600012 Error Configuration Illegal Adapter Instance Name. Adapter Configuration names must have only alphanumeric characters with no embedded spaces and can be up to 80 characters long. Type in a valid name

Cannot rename the adapter instance. Provide a valid name. Make sure you have entered alphanumeric characters, no blank spaces, and the name is not more than 80 characters.





AEADR3-600013 Error Configuration Subject Names. Do you wish to regenerate subjects set to previous defaults?

Click YES button to regenerate.

AEADR3-600016 Error Configuration Illegal Operation/The new nested name is in conflict with the name of the resource you are editing. Rename the existing resource or choose a different name

Conflicting resource names. Try using a different name.

AEADR3-600023 Error Configuration Invalid Value. Field %1, Palette error. This is not a valid value

You tried to enter an invalid value in the connection parameters.

AEADR3-600024 Error Configuration Invalid Value. Palette error. Endpoint Reference cannot have null value

Endpoint Reference is empty. Select a valid end-point reference.

AEADR3-600028 Error Configuration Illegal Operation. Selected Resource Can Not Be Moved

No resolution.

AEADR3-600044 Error Configuration Error while pasting. Deserialization of R3 Connections Failed

Copy/Paste of connections failed. Try configuring again.

AEADR3-600045 Error Configuration Error while writing the Meta Url

Error in Meta URL. Try configuring again.

AEADR3-600050 Error Configuration Not Checked out. Failed to update Schema. The associated Schema files are not checked out from source control

Check out schema files from the source control.





AEADR3-600051 Error Configuration Illegal child error occurred while processing connection - %1

Error while processing R3 Connection. Try configuring again.

AEADR3-600052 Error Configuration Name conflict error occurred while processing connection - %1

Error while processing R3 Connection. Try configuring again.

AEADR3-600053 Error Configuration Error occurred while applying changes to connection - %1

Error while applying changes to R3 Connection. Try configuring again.

AEADR3-600054 Error Configuration Not Checked out. Failed to update R3Connections. The connection file is not checked out from source control

Check out the connection file from source control.

AEADR3-600055 Error Configuration Error Renaming Service. Service name must only have alphanumeric characters and must be at most 80 characters long

Cannot rename the service. Provide a valid name. Make sure you have entered alphanumeric characters, no blank spaces, and the name is not more than 80 characters.

AEADR3-600056 Error Configuration Global Variables File:Read-Only. Global Variable files needs to be checked out in order to successfully create the adapter

Check out Global Variables file from source control.





AEADR3-600057 Error Configuration Error During Rename : Read-Only File. The resource %1 could not be renamed. Rename requires the %2 should be checked out. Check out the resource and try renaming again. You can select the resource to be checked out by clicking on the Go To Resource button

Check out the resource and try renaming again.

AEADR3-600058 Error Configuration 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 and try deleting again. You can select the resource to be checked out by clicking on the Go To Resource button

Check out the resource and try deleting again.





Debug Messages

For details of debug messages for configuration category, see Table 89.

AEADR3-600059 Error Configuration Error During Creation of Service : Read-Only File. The service can not be created. Creation requires the %1 should be checked out. Check out the resource and try creating the service again. You can select the resource to be checked out by clicking on the Go To Resource button

Check out the resource and try creating the service again.

AEADR3-600062 Error Configuration RFC/BAPI: %1: Invalid parameter: %2, (%3) data type not allowed. Remove selection

When downloading a RFC/BAPI containing parameters referring to a table type or complex or nested type remove selection by unchecking the selection. If this RFC/BAPI is required, create a custom module and use the internal tables and flat structures.



Table 89 Debug Messages for Configuration Category


AER3-DEBUG-CONFIGURATION Debug Configuration %1 Debug messages generated during the loading of configuration by the adapter. No action required.



Info Messages

For details of info messages for configuration category, see Table 90.

Table 90 Info Messages for Configuration Category


AER3-000007 Info Configuration Management is local Better to use a remote Manager if multiple adapters are running in a load balanced manner. This is to ensure that the failed transactions are not executed twice among the load balanced group. This means that it is possible to get duplicate messages if more than one adapters are running in a load balanced configuration and are setted up to do local management.

AER3-000090 Info Configuration The Destination %1 in not defined, IDoc is logged to file %2


AER3-970032 Info Configuration Server connection pool: gatewayHost=%1 gatewayService=%2 programID=%3 updated successfully, connection count=%4


AER3-970034 Info Configuration Client connection pool name: %1 updated successfully, connection count=%2




Warn Messages

For details of warn messages for configuration category, see Table 91.

Trace Messages for Data Category

In data category there is one group of trace messages detailed as the following:


Debug Messages

For details of debug messages for data category, see Table 92.

Trace Messages for Hawk Category

In hawk category there is one group of trace messages detailed as the following.


Table 91 Warn Messages for Configuration Category


AER3-970028 Warn Configuration Logging being defaulted to SDK due to error: %1

Adapter configured to use extended logging but error exists with the Log4J file provided in TRA property adr3.trace.log4j.properties. Verify that Log4j file exists and correct.

AER3-970030 Warn Configuration Log4J logging refreshed from properties file: %1

Adapter configured using extended logging and Hawk method refreshExtendedLogging was invoked. No action required.

Table 92 Debug Messages for Data Category


AER3-DEBUG-DATA Debug Data %1 Debug messages generated during the marshaling of data by the adapter. No action required.



Debug Messages

For details of debug messages for adapter category, see Table 93.

Trace Messages for Publication Category

In publication category, there is one group of trace messages as the following:


Error Messages

For details of error messages for publication category, see Table 94.

Trace Messages for Request-Response Category

In request-response category, there is one group of trace messages as the following:


Table 93 Debug Messages for Hawk Category


AER3-DEBUG-HAWK Debug Hawk %! Debug messages provided by the custom Hawk microagent of the adapter. No action required.

Table 94 Error Messages for Pubication Category


AER3-930014 Error Publication Publication error Publication service %1 with publication subject %2 received error while sending event over the wire.



Error Messages

For details of error messages for request-response category, see Table 95.

Trace Messages for Request-Response Invocation Category

In request-response invocation category, there is one group of trace messages as the following:


Error Messages

For details of error messages for request-response invocation category, see Table 96.

Table 95 Error Messages for Request-Response Category


AER3-940009 Error Request-Response Request Response error.

Request Response service %1 listening on subject %2 failed due to target application invocation error %3.

AER3-940010 Error Request-Response Request-Response error.

Request-Response service %1 listening on subject %2 failed to create reply.

AER3-940020 Error Request-Response Server Timeout Check if the end application is up and running.

Table 96 Error Messages for Request-Response Invocation Category


AER3-950001 Error Request-Response Invocation

Request Response Invocation error.

Request Response Invocation service %1 with subject as %2 received event from target application %3.



Trace Messages for Subscription Category

In subscription category, there is one group of trace messages as the following:




Request Response Invocation service %1 with subject as %2 received event from target application %3.



Request Response Invocation service %1 with subject %2 received error while requesting event over the wire.


Oneway Invocation error

Oneway Invocation service %1 with subject %2 received error while requesting event over the wire.



Request Response Invocation service %1 with subject %2 received null reply while requesting event over the wire.



Request Response Invocation service %1 with subject %2 received timeout error while requesting event over the wire.



Request Response Invocation service %1 with subject %2 received error while processing reply message.

Table 96 Error Messages for Request-Response Invocation Category (Cont’d)




Error Messages

For details of error messages for subscription category, seeTable 97.

Trace Messages for System Category

In system category there is one group of trace messages detailed as the following.

Table 97 Error Messages for Subscription Category


AER3-920001 Error Subscription Subscription error. Subscription service %1 listening on %2 received an unexpected event of type = %3, Expects event %4. The Repository URL is %5 and the Configuration URL is %6

Subscription service %1 listening on %2 received an unexpected event of type =%3 received an unexpected event of type = %3, Expects event %4.

AER3-920002 Error Subscription Subscription error. Subscription service %1 failed to deserialize the event received on subject %2 and SDK exception thrown is %3.

AER3-920003 Error Subscription Subscription error. Subscription service %1 listening on subject %2 received inbound event with null data.

AER3-920007 Error Subscription Subscription error. Subscription service %1 listening on subject %2 could not get the class description of %3.

AER3-920008 Error Subscription Subscription error. Subscription service %1 listening on subject %2 could not find the mandatory property %3 in class %4.

AER3-920015 Error Subscription Subscription error. Subscription service %1 listening on subject %2 failed due to target application invocation error %3.





Info Messages

For details of info messages for system category, see Table 98.

Error Messages

For details of error messages for system category, see Table 99..

Design-Time Trace MessagesDesign-time trace messages are categorized in to the following groups.

• Design Time Trace Messages for Configuration Category, page 392

• Design-Time Trace Messages for DTA Category, page 396

• Design-Time Trace Messages for Repository Category, page 398

• Design-Time Trace Messages for Schema Category, page 399

Table 98 Info Messages for System Category


AER3-000004 Info System Adapter application %1 is stopped


Table 99 Error Messages for System Category


AER3-000147 Error System Could not open file %1 for writing

File could not be opened. Check permissions and whether you’ve adequate space on your disk.

AER3-970264 Error System Could not write to file: %1 error: %2

In the case of Invalid Destination, adapter was unable to write to file %1. Verify that the adapter is writing file to directory with enough disk space.

AER3-970265 Error System Could not close file: %1 error: %2

None



Design Time Trace Messages for Configuration Category

In configuration category, there is one group of design-time trace messages detailed as the following:


Warn Messages

For details of warn messages for configuration category, see Table 100.

Table 100 Warn Messages for Configuration Category


AEADR3-600001 Warn Configuration JMS Service Configured. This adapter version does not support JMS services, but one was found. Use the Go To button to select it

You have configured a service with transport type as JMS. But the AE Version of this adapter instance does not support JMS. You may change the AE Version or make sure that the runtime version is higher than this version.

AEADR3-600002 Warn Configuration XML Wire Format found. This adapter version does not support XML Wire Format

You have configured a service with XML Wire Format. But the AE Version of this adapter instance does not support XML format. You may change the AE Version or make sure that the runtime version is higher than this version.



AEADR3-600003 Warn Configuration Subscriber in exploded batch mode found. This adapter version does not support Subscriber in Explode Batch Mode

You have configured a Subscription service with Exploded Batch Mode. But the AE Version of this adapter instance does not support Subscriber in Exploded Batch Mode. You may change the AE Version or make sure that the runtime version is higher than this version.

AEADR3-600004 Warn Configuration Connection Retry Mechanism Warning. This adapter version does not suspend services on connection failure. The configured value 'Adapter Termination Criteria' will be ignored

You have configured a service with Connection Retry. But the AE Version of this adapter instance does not suspend services on connection failure. You may change the AE Version or the value of 'Adapter Termination Criteria' will be ignored.

AEADR3-600005 Warn Configuration Connection Retry Mechanism Warning. This adapter version does not suspend services on connection failure. The configured values 'Number of Reconnect Attempts Before Suspending Impacted Service(s)' and 'Adapter Termination Criteria' will be ignored

You have configured a service with Connection Retry. But the AE Version of this adapter instance does not suspend services on connection failure. You may change the AE Version or the value of 'Adapter Termination Criteria' will be ignored.

Table 100 Warn Messages for Configuration Category (Cont’d)




AEADR3-600006 Warn Configuration Empty Service Found. The Service is not Configured Or Class Reference or Endpoint Reference is Empty

You have configured an adapter instance with a service which has no schema associated with it. Such an adapter instance cannot be used at run-time. Make sure that you do not have an empty service before deploying the adapter instance.

AEADR3-600014 Warn Configuration Regenerate Names?. Do you wish to regenerate Subject Names, Connection Names and Session Parameters?


AEADR3-600015 Warn Configuration Replace Resource. The resource %1 is already defined as a type. Do you want to replace it?

Click OK button to continue.

AEADR3-600022 Warn Configuration Deleting Operation Type. Do you want to delete %1 ?

Delete confirmation. Select Yes to delete.

AEADR3-600040 Warn Configuration Regenerate Resources ? Do you want to regenerate endpoint and subject information?


AEADR3-600041 Warn Configuration Regenerate Resources? Do You want to regenerate Subject Names and Session Parameters?


AEADR3-600042 Warn Configuration Regenerate Connections. Do You want to regenerate Connection Names?

Click YES to regenerate Connection Names.





AEADR3-600046 Warn Configuration Inbound Management Warning. This adapter version does not support Inbound Management

You have configured an adapter instance with Inbound Management. But the AE Version of this adapter instance does not support Inbound Management. You may change the AE Version or make sure that the runtime version is higher than this version.

AEADR3-600047 Warn Configuration Advanced Logging Warning. This adapter version does not support advanced logging to a file

You have configured an adapter instance with advanced logging. But the AE Version of this adapter instance does not support advanced logging to a file. You may change the AE Version or make sure that the runtime version is higher than this version.

AEADR3-600048 Warn Configuration Confirm Publisher Warning. This adapter version does not support confirm publisher on the inbound side

You have configured an adapter instance with advanced logging. But the AE Version of this adapter instance does not support advanced logging to a file. You may change the AE Version or make sure that the runtime version is higher than this version.





Design-Time Trace Messages for DTA Category

In DTA category there are two groups of design-time trace messages detailed as the following:



Error Messages

For details of error messages for DTA category, see Table 101.

AEADR3-600049 Warn Configuration Valid destination Warning. This adapter version does not support Validating destination on the inbound side

You have configured an adapter instance to validate destination on the inbound side. But the AE Version of this adapter instance does not support validating destination on the inbound side. You may change the AE Version or make sure that the runtime version is higher than this version.

AEADR3-600060 Warn Configuration Need to Add File to RCS: %1 was created during schema generation. Ensure that this resource is added to RCS and checked in. Click on the Go To Resource button to select the resource

Ensure that this resource is added to RCS and checked in.



Table 101 Error Messages for DTA Category


AEADR3-600017 Error DTA Select an IDoc. You did not make a selection

Select an IDoc.



Info Messages

For details of info messages for DTA category, see Table 102.

AEADR3-600018 Error DTA Select an RFC Function. You did not make a selection

Select an RFC function.

AEADR3-600019 Error DTA IDoc Fetch Failed. %1 No IDocs were retrieved. Check your connection parameters and your IDoc filter criteria.

AEADR3-600020 Error DTA RFC Fetch Failed. %1 No RFCs were retrieved. Check your connection parameters and your RFC filter criteria.

AEADR3-600026 Error DTA Filter Length Exceeded. Palette error. The RFC Filter cannot be more than 30 characters in Length. Enter a filter value less than 30 characters in length

You have exceeded the filter length. Enter a filter value less than 30 characters in length.

AEADR3-600027 Error DTA Filter Length Exceeded. Palette error. The RFC Group Filter cannot be more than 26 characters in Length. Enter a filter value less than 26 characters in length

You have exceeded the filter length. Enter a filter value less than 26 characters in length.

Table 101 Error Messages for DTA Category (Cont’d)


Table 102 Info Messages for DTA Category


AEADR3-600008 Info DTA Connection Failure. Test Connection Failed

Test Connection to SAP R3 System failed. Check your connection parameters.



Design-Time Trace Messages for Repository Category

In repository category, there is one group of design-time trace messages as the following:


Error Messages

For details of error messages for repository category, see Table 103.

AEADR3-600009 Info DTA Connection Failure. %1 Test Connection to SAP R3 System failed. Check your connection parameters.

AEADR3-600010 Info DTA Connection Success. Hostname - %1, System Name - %2, R-3 Release - %3


AEADR3-600031 Info DTA Not Found. No IDocs Retrieved. Check the filter

Check IDoc Filter.

AEADR3-600032 Info DTA Not Found. No RFCs Retrieved. Check the filter

Check RFC Filter.

AEADR3-600033 Info DTA No List. IDoc List could not be retreived-%1'

Check IDoc Filter.

AEADR3-600034 Info DTA No List. RFC - BAPI List could not beretreived-%1'

Check RFC/BAPI Filter.

Table 102 Info Messages for DTA Category


Table 103 Error Messages for Repository Category


AEADR3-600030 Error Repository Error Occurred. Error Creating Global Variables

TIBCO Designer encountered an error while creating global variables. You may have to manually create global variables in the Global Variables pane.



Design-Time Trace Messages for Schema Category

In schema category, there are two groups of design-time trace messages listed as the following:



Error Messages

For details of error messages for schema category, see Table 104.

Table 104 Error Messages for Schema Category


AEADR3-600035 Error Schema Error Occurred. Conflicting Services. A Publication Service, having the same Schema, is already configured

You already have a Publication service with the same schema. You cannot configure another service in the same adapter instance.

AEADR3-600036 Error Schema Error Occurred. Conflicting Services. A Subscription Service, having the same Schema, is already configured

You already have a Subscription service with the same schema. You cannot configure another service in the same adapter instance.

AEADR3-600037 Error Schema Error Occurred. Conflicting Services. A Request-Response Service, having the same Schema, is already configured

You already have a Request-Response service with the same schema. You cannot configure another service in the same adapter instance.

AEADR3-600038 Error Schema Error Occurred. Conflicting Services. A Request-Response Invocation Service, having the same Schema, is already configured

You already have a Request-Response Invocation service with the same schema. You cannot configure another service in the same adapter instance.



Warn Messages

For details of warn messages for schema category, see Table 105.

Trace Messages DiscontinuedFor trace messages discontinued from TIBCO ActiveMatrix Adapter for SAP 7.0, see Table 106.

AEADR3-600043 Error Schema Error while pasting. Deserialization of Schema Failed

Copy/Paste of schemas failed. Try configuring again.

Table 104 Error Messages for Schema Category (Cont’d)


Table 105 Warn Messages for Schema Category


AEADR3-600021 Warn Schema Reuse Schema Type. Schema for %1 already exists. Do you want to reuse existing schema?

This is a Yes/No option. Select Yes if you want to use the existing schema. Select No if you want to re-download the schema for the SAP R3 system.

AEADR3-600029 Warn Schema Filter Applied to mandatory segments. You have applied the filter on the following mandatory segment(s)

You have applied a filter on mandatory segments. Uncheck the filter on these segments.

AEADR3-600039 Warn Schema Download Operation Schema. Schema for operation %1 is already available, Use existing schema?

Click YES button to reuse existing schema. Click NO button to re-download schema from SAP R3 system.

Custom Hawk rule bases referring to trace messages in this section would need to be modified accordingly.



Table 106 Discontinued Trace Messages of TIBCO ActiveMatrix Adapter for SAP 7.0


AEADR3-600061 Warn Configuration RFC/BAPI: %1: Import/Export parameters referencing String data type are ignored

The schema for the RFC/BAPI including import or export referencing String data types can be downloaded. But any references to String data types are ignored at runtime.

If parameters referring to String data types are required, create a custom module and change any references of String data type to fixed character types.

AER3-000002 Error Adapter Invalid value for attribute %1 for operation %2

Verify if you are using the correct class descriptions and value specified is valid and no mandatory values are omitted.

AER3-000003 Error Adapter Function call is transactional but no provided

When you set transactional in closure, you must also supply a value for.



AER3-000005 Error Configuration Could not find interface description element

This problem might also occur if the configuration file is edited manually and is invalidated in the process. After making any changes to the file make sure that the XML file is well formed. The SML file can be validated by opening it in an XML enabled browser.

AER3-000006 Error Configuration %1 not specified for %2

This problem might also occur if the configuration file is edited manually and is invalidated in the process. After making any changes to the file make sure that the XML file is well formed. The file can be validated by opening it in an XML enabled browser.

AER3-000008 Error Configuration file is not specified Specify the file name, attribute “tidFileName” in the adapter instance level Adapter Services

tab.

AER3-000009 Error Configuration Timer %1 does not exist

Provide a correct reference to the TIB Adapter SDK timer in the server connection section of the connection manager.

Table 106 Discontinued Trace Messages of TIBCO ActiveMatrix Adapter for SAP 7.0 (Cont’d)




AER3-0000010 Error Configuration The interface %1 does not specify attribute 'classRef'

Provide a correct reference to the TIBCO Adapter SDK timer in the server connection section of the connection manager.

AER3-000011 Error Configuration Invalid producer %1 Provide a correct reference to an TIBCO Adapter SDK producer (publisher).

AER3-000013 Error Configuration No RpcClient specified for operation %1

Provide a valid reference to an TIB Adapter SDK RPC Client through "mbRpcClientRef" element in Deployment Descriptions of IDocs.

AER3-000014 Warn Configuration Interface %1 does not contain deployment description for IDocs... continuing...

Provide a valid reference to an MBOperation. Also add a reference to the XML document that contains the descriptions for this operation. This is done using the model document tag at the beginning of the configuration file in the document section.

The default class descriptions for MB operations, i.e. UserExitSchema.xml, can also be extended with class description for additional operations.





AER3-000015 Info Configuration Invalid producer %1; using default producer %2


AER3-000016 Error Configuration Invalid consumer component %1

Modify your configuration by defining a consumer name as suggested by the error description.

AER3-000017 Error Configuration No components defined in the configuration document

Modify your configuration so that it has at least one component under the 'components' section.

AER3-000018 Error Configuration No connection manager defined in the configuration document

Modify your configuration so that it has a 'connectionManager' under the 'connectionManagers' section.

AER3-000019 Error Configuration Invalid rpcServer %1 specified for interface %2

Modify your configuration so that it has a 'connectionManager' under the 'connectionManagers' section.

AER3-000020 Error Configuration The Subscriber Description does not specify consumer reference, skipping...

Add consumerRef attribute in the configuration.

AER3-000021 Error Configuration Consumer %1 for deployment description %2 does not exist

ConsumerRef must point to a valid subscriber.





AER3-000022 Warn Configuration No instance defined for %1; control fields will not be replaced

You must have an instance defined under class instances.

AER3-000023 Warn Configuration Invalid reference for attribute consumerRef

ConsumerRef must point to a valid subscriber.

AER3-000024 Error System Error while reading directory=%1, filename=%2; %3

Determine the cause from the error description.

AER3-000025 Warn System directory=%1, filename=%2; No matching files found

There were no matching files. Check your filenames.

AER3-000026 Error System Could not open %1 for reading

The specific file could not be opened. Check permissions.

AER3-000027 Error System %1 is unreadable Check whether the file can be opened using a text editor.

AER3-000028 Warn System %1 is empty File is empty.

AER3-000029 Error System %1 does not contain newline. Perhaps not a text file

The file is not a text file, because it does not contain a new line.

AER3-000030 Info Adapter IDoc from file %1 sent in %2 mode


AER3-000032 Warn Adapter Cannot get control record for IDoc

The IDoc does not have a control record. If it’s not intentional, add a control record.

AER3-000034 Warn Adapter False call to %1 See the error description for more details.





AER3-000035 Warn Adapter Could not generate GUID

Even though a warning, this message is often indicative of a memory-low situation that could severely affect the adapter performance.

AER3-000036 Error Adapter No connection for %1 The named component does not have a valid connection Manager. Refer also to the description for 'R3-CORE-CFG-1014'.

AER3-000037 Error Adapter Could not create Manager

If the problem persists, repeat with remote Management.

AER3-000038 Error Configuration Could not find default client connection

Modify your configuration so that the login parameters that you specify for 'defaultClient' are valid and that the Adapter can establish a valid connection to the SAP System.

AER3-000039 Error Adapter No proxy defined to process request for RFC function %1

The Adapter could not create a proxy for the named RFC function. Look at the earlier error messages in the log file(s) for possible causes.

AER3-000041 Error Adapter Unable to create RFC server function %1






AER3-000042 Error Adapter Unable to create request proxy for %1


AER3-000043 Error Adapter Unable to create RFC client for %1


AER3-000047 Error Adapter %1 is not a valid structure or table

If the name represents a valid SAP structure (or table), ensure that the repository contains the class definition for this structure (or table). If you are sending data from your custom program(s) to the SAP Adapter, make sure that you're constructing the data correctly and that you're using valid classes.

AER3-000048 Error Adapter Unpacking error: Invalid class type for structure %1

Data inappropriate for the named structure. See also R3-CORE-LIB-6014.

AER3-000049 Error Adapter Unpacking error: Invalid class type for table %1

Data inappropriate for the named table. See also R3-CORE-LIB-6014.

AER3-000050 Error Adapter Unpacking error: Row of table %1 is not a structure

Data inappropriate for the named table. See also R3-CORE-LIB-6014.





AER3-000051 Info Adapter User-defined operation called successfully

The Adapter invoked the user-defined operation successfully.

AER3-000052 Error Adapter Invalid or no data received from user-defined operation

Check the program that implements the user-defined operation and make sure that it returns data.

AER3-000053 Error Adapter User-defined operation invocation exception; name: %1, data: %2

Ensure that your operation executes without any exception and that it returns valid data to the Adapter.

AER3-000054 Error Adapter User-defined operation invocation timeout

Ensure that the Rpc Server that implements your operation is running and that it is reachable from the Adapter.

AER3-000055 Error Adapter User-defined operation invocation: bad reply received

Ensure that your operation returns valid data to the Adapter.

AER3-000056 Error Adapter User-defined operation invocation exception; name: %1

Ensure that your operation executes without any exception and that it returns valid data to the Adapter.

AER3-000057 Error Adapter The request sent to user-defined operation contains invalid data

If you're constructing the data to be sent to the user-defined operation, ensure that it's being constructed correctly.





AER3-000058 Error Adapter Invalid operation name for IDoc %1

The Adapter found that the IDoc data is arriving from a function other than 'IDoc_INBOUND_ASYNCHRONOUS' or 'INBOUND_IDoc_PROCESS'.

AER3-000059 Error Adapter Cannot create IDoc parser instance

The error indicates that it could not create a parser, either because of a memory-low problem or because of an earlier error during Adapter initialization.

AER3-000060 Error Adapter Invalid RFC function %1


AER3-000062 Error Adapter Unable to create reply listener for operation %1

See earlier messages in the log file(s) for possible causes.

AER3-000063 Error Adapter RFC invocation timeout for function %1; description: %2

The named RFC function invocation timed out. See error description for more details.

AER3-000064 Error Adapter RFC invocation bad reply for function %1; description: %2

The named RFC function returned a bad reply. See error description for more details.





AER3-000065 Error Adapter RFC invocation remote exception; name: %1, description: %2

The named RFC function caused a remote exception. See error description for more details.

AER3-000066 Error Adapter Cannot create IDoc parser instance for subscriber %1

The error indicates that it could not create a parser, either because of a memory-low problem or because of an earlier error during Adapter initialization.

AER3-000069 Error Adapter Cannot implode IDoc %1

Either the adapter encountered a low-memory condition or the received data is incorrect. If it is your application that is sending the offending data to the adapter subscriber, make sure that your data is valid.

AER3-000070 Error Adapter Cannot get RFC client function %1

Make sure that SAP login parameters are correct and that the subscriber adapter can reach the SAP system. Also check earlier error messages in the log file(s) for possible causes.





AER3-000071 Error Adapter Cannot get marshaller for RFC client function %1

The subscriber adapter could not get marshaller to convert between adapter data and SAP data, perhaps because of a low-memory problem or because of an error encountered earlier during initialization. Check the earlier error messages in the log file(s) for possible causes.

AER3-000073 Error Application Cannot get RFC connection for client %1

See R3-CORE-LIB-60.

AER3-000074 Error Adapter Operation %1 timed out

Make sure that the RPC Server that corresponds to the named operation is executing and is accessible from the Adapter.

AER3-000075 Warn Adapter Operation %1 returned a bad reply %2

The named operation returned a bad reply. Look at the error message description for more details.

AER3-000076 Error Adapter Initialization exception type: %1, operation: %2, description: %3

The named operation returned the named exception. Look at the error message description for more details.





AER3-000079 Error Adapter Unpacking error The Adapter encountered an error either because of low-memory condition or because of an error earlier during the initialization. Check the earlier error messages in the log file(s) for possible causes.

AER3-000080 Warn Adapter Could not create TIBCO RV advisory handlers; exception type: %1, description: %2

The Adapter could not create the license expiry advisories. Look at the error description for more details.

AER3-000081 Warn Adapter Could not create TIBCO Hawk implants; exception type: %1, description: %2

The adapter could not create TIBCO Hawk implants. Look at the error description for more details.

AER3-000083 Warn Adapter Unable to create operation request for function: %1, class: %2, rpcClient: %3

The Adapter could not create Operation request for the named function. Look at the error description for more details.

AER3-000087 Info Adapter IDoc Sent to SAP System


AER3-000088 Info Adapter IDoc sent as a Business Document


AER3-000089 Info Adapter IDoc received as a Business Document






AER3-000092 Info Adapter The subscriber for this IDoc message could not be determined


AER3-000096 Info Adapter IDoc Message sequence number %1 could not be confirmed to %2, Use pre-registration of subscribers


AER3-000097 Info Configuration IDoc Message could not be confirmed, validation must be turned off, if 10X Publishers used


AER3-000099 Info Adapter RFC Function invoked: %1


AER3-000100 Warn Configuration User-defined operation: operation not specified, assuming 'transform'

If the default transfer is not desired, name your operation explicitly.

AER3-000101 Warn Configuration User-defined operation reference: operationRpcClientRef not specified, operation will not be invoked

The operation requires an rpcClient, specific through operationRpcClientRef. Specify this client.

AER3-000104 Info Adapter Setting up Imports and Exports for RFC function %1


AER3-000105 Info Adapter RFC function has %1 imports, %2 exports






AER3-000142 Info Adapter Subscriber: %1. The 10x Opaque message type is not supported


AER3-000143 Info Adapter The received message was recovered


AER3-000144 Info Adapter The IDoc message received in 10x format does not contain %1field


AER3-000148 Error Adapter CIDocIterator: The IDoc container does not contain any IDocs

Check the log file for any previous errors that may have led to this situation.

AER3-000149 Error Adapter The IDoc %1 does not contain %2

The IDoc does not contain a data record section. Check the IDoc data

AER3-000150 Error Adapter No control record instance for the %1 IDoc in the packet

The named IDoc does not have a control record. Check the data.

AER3-000151 Error Adapter No data record instance for the %1 IDoc in the packet

The IDoc does not contain a data record section. Check the data.

AER3-000152 Error Adapter %1 record of the data record instance does not contain mandatory attribute DOCNUM

DOCNUM is mandatory attribute for data record. Check the data and modify it to include DOCNUM.

AER3-000153 Info Adapter %1 row of the data record instance of the %2 IDoc instance of type %3 could not be obtained






AER3-000154 Error Subscription The IDoc instance could not be written to file, the instance is invalid

The instance could not be written because it was empty. Check the IDoc data.

AER3-000155 Error Adapter The IDoc does not contain a data record

The IDoc does not contain a data record section. Check the IDoc data.

AER3-000157 Info Adapter Invocation for RFC function %1 still pending


AER3-000158 Info Adapter Adapters initialization mode:%1


AER3-000159 Warn Adapter Cannot find communication client for Manager, Management will be local

The configuration does not specify the rpcClient for Manager, hence the management will be local.

AER3-000160 Info Adapter Connection: waiting for reply from server ...


AER3-000161 Info Adapter No component for the RFC call; Exception=%1


AER3-000162 Info Adapter Active connection is null


AER3-000163 Info Adapter Checking for connections






AER3-000168 Info Adapter %1 connection could not be removed


AER3-000170 Warn Adapter Stop Adapter: Correct consumer reference could not be obtained from deployment description %1, skipping...

The configuration did not specify consumerRef. No action necessary.

AER3-000171 Info Adapter Adapter is waiting for invocation response before shutdown can proceed...


AER3-000174 Info Adapter Connection Manager %1 stopped


AER3-000175 Info Adapter Component %1 stopped


AER3-000176 Info Adapter Deactivating stop scheduler


AER3-000179 Error Adapter Remote Exception: Exception Name: %1, Exception Data: %2

See the error description for details.

AER3-000180 Warn Adapter ADV_CLASS/ADV_SOURCE/ADV_NAME: %1, ADV_DESC : %2 %3

See the error description for more details.

AER3-000181 Error Adapter ADV_CLASS/ADV_SOURCE/ADV_NAME: %1, ADV_DESC : %2 %3

The adapter responds 'license expiry' warning from the daemon with this message.





AER3-000182 Error Adapter ADV_CLASS : %1, ADV_SOURCE : %2, ADV_NAME : %3

The adapter responds 'registration collision' error from the daemon with this message.

AER3-000183 Error Application RFC error; Group : %1, Key : %2, Message : %3

Look at the error description for details about the SAP Exception. Also check your connection parameters.

AER3-000184 Error Application RFC connection invalid for %1

The adapter could not get a valid connection to the SAP system. Check your login parameters. Also make sure that the adapter can reach the SAP system.

AER3-000185 Error Application CallReceive failed for operation %1; exception : %2, RFC error; Group/Key/Message: %3

Look at the error description for details about the SAP Exception.

AER3-000189 Error Application RFC function initialization error for function %1; RFC Error; Group/Key/Message : %2


AER3-000190 Warn Adapter RFC remote function %1 implementation exception %2






AER3-000191 Error Application Indirect call error while sending IDoc; RFC Error; Group : %1, Key : %2, Message : %3


AER3-000192 Error Application RFC error; Group : %1, Key : %2, Message : %3, Attempt to connect timed out


AER3-000193 Error Application Connection not available for client %1, retrying ...


AER3-000194 Info Adapter Invalid RFC client connection object for client %1


AER3-000204 Error Configuration %1 is not a modeled class

The named class is invalid, non-existent, or does not represent a modeled class. Check the repository to make sure that a valid class exists with that name.

AER3-000205 Error Configuration No operations defined in class %1

Modify the class definition to include operations.

AER3-000206 Error Configuration The operation %1 does not have any parameters

Modify the class definition to include parameters.

AER3-000208 Error Configuration Operation description not available for %1

The named operation is invalid or non-existent. Check the repository to make sure that an operation exists with the specified name.





AER3-000209 Error Configuration No IDoc operations defined in class %1

The named class does not have IDoc operations defined. Check the repository to make sure that the class definition is correct.

AER3-000210 Error Configuration Attribute %1 in class %2 is invalid

Check the configuration.

AER3-000211 Error Adapter Unsupported type %1 for attribute %2 in class %3

The named type is unsupported by SDK or SAP or both.

AER3-000212 Error Adapter Unexpected %1 : %2; inform technical support

Unexpected error. You cannot determine the cause from the description. Contact technical support: [email protected].

AER3-000213 Warn Configuration Control field replacements specify an attribute %1 which does not exist in the control record

Control field replacements in classInstances specify an attribute that does not exist in control record. Check spelling.

AER3-000214 Error Adapter Cannot access class registry

You specified an attribute that does not exist in the control record. Either omit that attribute or replace it with an attribute that exists.





AER3-000215 Error Adapter Subscriber %1 received a message that has invalid wire format

There was an exception in the Adapter upon receive of this message. When you are using 10x style, follow the configuration requirements given in Chapter 5, Configuring an Adapter Instance, on page 71.

AER3-000261 Info Adapter Using ini file %1 Indicates normal adapter operation. No action necessary.

AER3-000262 Info Adapter No program ID defined in the ini file, using destination %1 as program ID


AER3-000266 Info Adapter Initialized successfully


AER3-000267 Info Adapter CREATED %1 Indicates normal adapter operation. No action necessary.

AER3-000268 Info Adapter EXECUTED %1 Indicates normal adapter operation. No action necessary.

AER3-000269 Info Adapter CONFIRMED %1 Indicates normal adapter operation. No action necessary.

AER3-000270 Error Adapter Invalid client function specified in removeClient call

Because this message appears during shutdown, no action is necessary.





AER3-000271 Error Configuration Invalid poolRef name %1

poolRef must point to a valid pool definition.

AER3-000272 Error Configuration Pool reference not provided in Server Component

Provide a value that corresponds to a valid definition.

AER3-000274 Error Adapter Invalid default Connection for pool %1

Check the pool definitions to ensure that they are valid.

AER3-000275 Error Configuration No default session defined

The configuration must either specify a valid value for start up/default session or define at least one rvSession/rvCmSession.

AER3-000276 Error Adapter Duplicate DEST parameter defined in %1 : %2

Remove duplicate definition.

AER3-000277 Error Adapter Destination %1 not defined in %2

Define destination given in message.

AER3-000278 Info Adapter Received message is written to file %1


AER3-000279 Error Adapter Exception while initializing adapter; exception type : %1, description : %2

Refer to the description and take the required action.

AER3-000280 Error Adapter Error: Could not send reply for function: %1






AER3-000281 Error Adapter Error while invoking User-defined operation: %1


AER3-000283 Error Adapter Exception during one way invocation of function: %1, Type: %2, Description: %3


AER3-000284 Info Adapter Request written to file: %1 for operation: %2


AER3-000285 Error Adapter Error code: %1, Message: %2

Refer to the description and take the required action.

AER3-000286 Info Configuration 'userExit' class does not exist or it does not contain operation %1, operation will not be invoked


AER3-000287 Info Configuration There is no RpcClient named: %1, operation will not be invoked


AER3-000288 Info Adapter Untransformed IDoc data sent


AER3-000289 Info Adapter Performing asynchronous invocation for User-defined function: %1






AER3-000290 Warn Configuration No R/3 client configured for %1, using default-client %2

There is no deployment-description configured for the RFC. If not intentional, ensure that the client is specified in the deployment-descriptions for the RFC.

AER3-000291 Info Adapter Received request for logon to SAP R/3 System


AER3-000292 Info Adapter Successfully logged-on to SAP R/3 System


AER3-000293 Info Adapter Received request for logoff from SAP R/3 System


AER3-000294 Info Adapter Successfully logged-off from SAP R/3 System


AER3-000295 Error Adapter No session id exists in the logoff request

The sessionID obtained on logging-on to SAP system through design-time-adapter should be passed in the RFCCLOSURE along with the logoff request to successfully logoff from SAP system





AER3-000296 Error Adapter No logon session exists for the session ID

The sessionID obtained on logging-on to SAP system through design-time-adapter should be passed in the RFCCLOSURE along with the logoff request to successfully logoff from SAP system.

AER3-000300 Info M Created discovery subscriber successfully using subject %1


AER3-000301 Info M Attempting to create dynamic connection to SAP R/3 system


AER3-000302 Info M Attempting to close dynamic connection from SAP R/3 system


AER3-000303 Info M Retrieving list of function modules from SAP R/3 system


AER3-000304 Info M Retrieving schema for IDoc %1 FROM SAP R/3 system


AER3-000305 Info M Retrieving entries for table %1 FROM SAP R/3 system


AER3-000306 Info M Retrieving schema for structure/table %1 FROM SAP R/3 system






AER3-000307 Info M Received unknown operation %1

TIBCO Designer sent an invalid request to the design-time adapter. If problem persists contact technical support: [email protected]

AER3-000308 Info M Metadata adapter operation failure:%1; operation name : %2

Refer to the surrounding error messages for additional details.

AER3-000309 Info M Retrieving schema for RFC/BAPI %1 from SAP R/3 system


AER3-000400 Info Adapter Invalid connection detected. Message : %


AER3-000401 Info Adapter %1 RFCServers registered with SAP R/3 system with program-id %2 on GatewayHost %3


AER3-000402 Error Adapter No session id in request for operation %1

If the request is for an RFC that requires an explicit logon to SAP system, then the sessionID obtained on logging-on to SAP /3 system has to be passed in the RFCCLOSURE along with the RFC request.

AER3-000403 Error Adapter Unable to obtain context for implementation of operation %1






AER3-000405 Error Adapter Invalid session id passed in request for operation %1

The sessionID should be a valid string.

AER3-000406 Error Adapter Invalid session id passed for operation %1

If the sessionID was obtained after logging-on to the SAP system, ensure that the sessionID passed in the RFCCLOSURE while invoking a request on the InboundRFC instance is the same as the one obtained. Instead, if the sessionID was obtained for a subsequent BAPI_TRANSACTION_COMMIT call, ensure that the same sessionID was passed with BAPI_TRANSACTION_COMMIT invocation. Also check if the session created for commit/rollback has already timed-out as specified by the 'commitExpiry' parameter.

AER3-000407 Error Adapter Invalid call received, connection closed for thread

The adapter received an invalid call from the SAP system that caused a connection to be closed. Ensure that the adapter connections to SAP system are alive.





AER3-000408 Error Adapter Server thread unable to dispatch call, call skipped. message : %1

The adapter entered an invalid state because of an invalid call from the SAP system. See message description for more details. Ensure that the adapter connections to SAP system are alive.

AER3-000409 Error Adapter Server thread unable to dispatch call, connection invalidated

The adapter entered an invalid state because of an invalid call from the SAP system. See message description for more details. Ensure that the adapter connections with SAP system are alive.

AER3-000410 Warn Adapter Server thread exited, message : %1

The adapter encountered an exception condition that caused the server thread to exit. Look at earlier messages in the log-file(s) for possible causes. No resolution necessary.

AER3-000411 Error Configuration No poolRef specified for operation %1

The RFC does not have a 'poolRef' attribute in its deployment description. Ensure that a valid 'poolRef' is specified for the RFC.





AER3-000413 Error Adapter The session for commit/rollback timed out for operation %1

Ensure that the BAPI_TRANSACTION_COMMIT call is triggered in the SAP system before the session for commit/rollback times out as specified by the 'commitExpiry' parameter.

AER3-000414 Info Configuration No session timeout specified for commit/rollback for operation %1, defaulting to %2 seconds...

The 'commitExpiry' parameter defaults to 60 seconds if it is not specified. If this value is insufficient, ensure that a higher value is specified for the parameter.

AER3-000415 Info Adapter Session timeout for commit/rollback for operation %1 set to %2 seconds


AER3-000417 Info Adapter Connection pending commit for operation %1


AER3-000418 Error Adapter Invalid client specified : %1

Ensure that a valid client is specified for the RFC/IDoc in their respective deployment descriptions, if any. Else ensure that the 'defaultClient' attribute specified in client connectionpool is a valid client.





AER3-000419 Info Adapter Created new thread for RFCServer


AER3-000420 Info Adapter Server thread(s) stopped for Component %1


AER3-000421 Error Adapter No valid connection handle available for server for operation %1

The outbound adapter could not get a valid connection handle to the SAP system. Look at earlier messages in the log-file(s) for possible causes

AER3-000422 Error Configuration No client specified in deployment description for operation %1

Ensure that a client is configured for the operation

AER3-000423 Error Configuration No poolRef specified for operation %1

Ensure that a poolRef is specified for the operation

AER3-000424 Error Configuration No default client specified for operation %1

Ensure that a defaultClient is specified for the operation

AER3-000425 Error Configuration Invalid poolRef specified in deployment : %1

Ensure that a valid poolRef is specified in the deployment description for the RFC/IDoc

AER3-000426 Info Adapter Thread monitor started for %1 server thread(s)






AER3-000427 Error Adapter No active connections available in configuration, exiting...

This indicates that all the SAP systems the adapter is connected to, are down and none of the connections established by the adapter with the SAP system are active. Ensure that the SAP systems are up and running.

AER3-000428 Warn Configuration Interface %1 does not contain deployment description for RFCs... continuing...

The adapter could not find deployment descriptions for any RFC. If it is not intentional, ensure that the RFC configuration is correct.

AER3-000429 Warn Configuration No deployment description available for idoc %1...using default…

The adapter could not find deployment descriptions for the specified IDoc. If it is not intentional, ensure that the IDoc configuration is correct.

AER3-000432 Error Adapter Unable to clone proxy for operation %1


AER3-000433 Error Adapter Unable to clone RFC client for %1






AER3-000434 Error Adapter Unable to clone function implementation for operation %1


AER3-000435 Error Adapter Unable to create listener for call-operation


AER3-000436 Error Adapter Unable to create reply listener for operation %1


AER3-000437 Error Adapter Unable to clone subscriber implementation


AER3-000438 Error Adapter Unable to generate transaction-id. message : %1


AER3-000439 Error Adapter Unable to create implementation for thread


AER3-000440 Error Adapter Unable to create server thread


AER3-000442 Error Adapter Connection context lost. Operation %1 failed






AER3-000443 Error Adapter Logon to SAP R/3 system failed. message : %1


AER3-000444 Error Adapter Error writing to file for transaction %1

Ensure that the file has write permissions.

AER3-000446 Error Adapter No active connections in connection-pool %1. All retry attempts exhausted. Connections for this pool deactivated.

Ensure that the SAP system pointed to by the connection-pool %1 is up and running.

AER3-000447 Error Adapter No active connections in connection-pool %1. All retry attempts exhausted. Exiting...

This indicates that all the SAP systems the adapter is connected to, are down and none of the connections established by the adapter with the SAP system are active. Ensure that the SAP systems are up and running.

AER3-000449 Info Adapter The Application Manager has been flagged to restart on re-establishing connection to R/3.

None.





AER3-000451 Warn Adapter Adapter application will restart now

The adapter is recovering missed messages by performing an internal-restart. Ensure that the adapter has performed a restarted successfully by checking the adapter log files.

AER3-000452 Info Adapter Adapter application %1 is restarting on host %2.

None.

AER3-000453 Warn Configuration Invalid control-field replacement attribute %1 skipped.

A control-field name %1 not present in the IDoc's control record was specified for replacement. Ensure that the field name is one of those defined for the IDoc's control record.

AER3-000454 Info Adapter Performing oneway invocation for User-defined function: %1

None.

AER3-000455 Error Configuration No class description available for explode sequence %1

Check the repository under /tibco/public/adapt

er/SAPAdapter40/<sa

p version>/IDOCS/ for the class description for class %1.

AER3-000456 Error Configuration No attribute description for explode sequence %1

Check the repository for attribute description for explode sequence %1.





AER3-000457 Error Adapter Operation %1 requires external logon. The request does not contain sessionID in the closure data.

Supply the session-id parameter in the RFCCLOSURE data of the incoming request.

AER3-9100012 Error Startup Startup Error. Unable to create a Custom Hawk Micro Agent Named %1 used for %2

Verify your repository settings for validity of the stop-subscriber session parameters.

AER3-910003 Error Startup Startup Error. The command-line parameter(s): configurl, repourl have not been specified

Specify the command-line parameters configURL and repoURL.

AER3-910006 Error Startup Startup Error. SDK Exception %1 occurred while creating a shutdown listener with parameters %2. The Repository URL is %3 and the Configuration URL is %4

Verify your repository settings for validity of configuration for the shut down listener.

AER3-910007 Error Startup Startup Error. Unable to create a connection with the target application %1 using connection parameters %2 and the target application error is %3

Verify your repository settings for validity of connection parameters.





AER3-9300014 Error Publication Publication error. Publication service %1 with publication subject %2 received error while sending event over the wire. Error: %3

Check repository settings for valid configuration of the publish endpoint for this service. See Chapter 2, Getting Started, on page 7 for details on setting up a publish end point and a Publication Service.

AER3-9200015 Error Subscription Subscription error. Subscription Service %1 listening on subject %2 failed due to target application invocation error %3. Target application is %4

Verify the structure of the incoming message. Check in the SAP system for more detailed information on the cause of the error.

AER3-930003 Error Publication Publication error. Publication service %1 with publishing subject as %2 received event from target application %3. It failed while converting event to MInstance as it could not get the class description for %4. Repository URL is %5 and the Configuration URL is %6'

Verify the configuration of the publication service and check that the schema/class definitions are present in the repository. See Chapter 2, Getting Started, on page 7 for details on configuration of Publication Service.





AER3-930006 Error Publication Publication error. Publication service %1 with publishing subject %2 received the event from target application %3. It failed while converting event to MInstance attribute %4 of class %5 is missing. RepositoryURL is %6 and the ConfigurationURL is %'

Verify the configuration of the publication service and check that the schema definitions are present in the repository. See Chapter 2, Getting Started, on page 7 for details on configuration of Publication Service.

AER3-930015 Error Request-Response Property: adr3.preserveFieldBlanks must be set to ON when using message encoding UTF-8 for publisher: %1 in mode: %2

Verify that the property adr3.preserveFieldB

lanks is set to ON.

AER3-940001 Error Request-Response Request Response error. Request Response service %1 listening on %2 received unexpected null data in incoming request. Expects event %3. The Repository URL is %4 and the Configuration URL is %5

Check the configuration of the application that is requesting the event and make sure that it matches the inbound event definition for the above Request-Response service. See Chapter 2, Getting Started, on page 7 for details on configuration of Request-Response Service.





AER3-940005 Error Request-Response Request Response error. Request Response service %1 failed to deserialize the received Request to MInstance: Received event on subject %2, event = %3, SDK exception = %4. The Repository URL is %5 and the Configuration URL is %6

Check the configuration of the application that is requesting the event and make sure that it matches the inbound event definition for the above Request-Response service. See Chapter 2, Getting Started, on page 7 for details on configuration of Request-Response Service.

AER3-940008 Error Request-Response Request Response error. Connection error in invocation of Request Response service %1 listening on subject %2. Connection Parameters are %3

Check if the end application is up and running. Also verify the connection parameters are specified in the repository.


Request-Response Invocation error. Request-Response Invocation Service %1 with subject %2 received null reply while requesting event over the wire

Check the target application, if it is running or not. Check the configuration of Request-Response Invocation Service.






Request-Response Invocation error. Request-Response Invocation Service %1 with subject %2 received timeout error while requesting event over the wire

Check repository settings for valid configuration of the Request-Response Invocation endpoint for this service. See Chapter 2, Getting Started, on page 7 for details on setting up a endpoint of Request-Response Invocation Service and a Request-Response Invocation Service


Request-Response Invocation error. Request-Response Invocation Service %1 with subject %2 received error while processing reply message. Error %3

Check repository settings for valid configuration of the Request-Response Invocation endpoint for this service. See Chapter 2, Getting Started, on page 7 for details on setting up a endpoint of Request-Response Invocation Service and a Request-Response Invocation Service.




| 439

Appendix E Adapter Microagents and Methods

This appendix introduces the available TIBCO Hawk microagents and methods for TIBCO ActiveMatrix Adapter for SAP.

Topics

• Adapter Microagents, page 440

• Available TIBCO Hawk Methods, page 441


440 | Appendix E Adapter Microagents and Methods

Adapter Microagents

You can use TIBCO Hawk microagents to supplement the monitoring information provided by the standard logging levels capability. Examples of supplemental information that you can obtain with microagents include the repository URL, command line arguments used to start the adapter, and so on.

Each adapter has three microagents, with different capabilities and names. The same microagent follows different naming conventions, depending on how an adapter is started: from TIBCO Designer, or from TIBCO Administrator.

• Standard Microagent Predefined in TIBCO Adapter SDK. You can use the microagent to perform queries on all running adapters, regardless of their class or application.

— Naming in TIBCO Designer:COM.TIBCO.ADAPTER.adr3.%%Deployment%%.%%InstanceId%%

— Naming in TIBCO Administrator:

COM.TIBCO.ADAPTER.adr3.domainName.%%Deployment%%.%%InstanceId%%

• Class Microagent Predefined in TIBCO Adapter SDK. You can use the microagent to perform queries on one class of the adapter.

— Naming in TIBCO Designer:COM.TIBCO.adr3.%%Deployment%%.%%InstanceId%%

— Naming in TIBCO Administrator:COM.TIBCO.ADAPTER.adr3.%%Deployment%%.%%InstanceId%%

• Custom Microagent Predefined in TIBCO ActiveMatrix Adapter for SAP. You can use the microagent to perform the adapter specific queries.

— Naming in TIBCO Designer:SAPAdapterMicroAgent

— Naming in TIBCO Administrator:SAPAdapterMicroAgent


Available TIBCO Hawk Methods | 441

Available TIBCO Hawk Methods

Table 107 lists the methods available in the custom microagent of TIBCO ActiveMatrix Adapter for SAP.

For the methods available in the standard and class microagents, see "Appendix C TIBCO Adapter SDK Hawk Microagents and Methods" in TIBCO Adapter SDK Programmer’s Guide.

Table 107 Custom Microagent Methods

Method Description

getActivityStatisticsByService() Get the runtime statistics for an adapter service.

getInboundConnectionData() Get the number of client connections to an inbound adapter service at runtime.

getInboundThreadData() Get the number of threads used in processing inbound messages for an inbound adapter service at runtime.

getOutboundThreadData() Get the thread information for an outbound adapter service at runtime.

refreshExtendedLogging() When running the adapter using extended logging along with Log4J, invoke this method when the Log4J properties file is changed.

resetActivityStatistic() Reset the runtime statistics for an adapter service.

resumeInboundServices() Resume suspended inbound adapter services tied to a particular client connection pool.

resumeOutboundServices() Resume the server connection pools currently suspended.

resumeRemoteTIDManager() Resume the communication between the adapter services and the remote TIDManager.

setInboundConnectionPool() Set the maximum number of connections for a client connection pool.

setInboundThreadPool() Change the number of threads for an inbound adapter service.



Table 108 lists the prior custom methods that have either been removed or replaced in TIBCO ActiveMatrix Adapter for SAP 7.0.

setOutboundThreadPool() Modify the number of connections to the SAP gateway, which influences the number of threads available for processing outbound messages.

Table 107 Custom Microagent Methods (Cont’d)

Method Description

Table 108 Removed or Replaced TIBCO Hawk Methods in TIBCO ActiveMatrix Adapter for SAP 7.0

Prior Custom Methods 7.0 Custom Methods

getConfiguredRFCs() Replaced.

To obtain information on the configured RFC/BAPI , use new custom method getActivityStatisticsByService().

getConnectionStatistics() Replaced.

• For outbound connections:

use getOutboundThreadData().

• For inbound connections:

use getInboundConnectionData().

getActivityStatisticsByOperation()getActivityStatisticsBySchema()

Replaced.

Use getActivityStatisticsByService() instead.

refreshABAPContext() Removed.

getThreadStatistics() Replaced.

• For outbound thread information:

use getOutboundThreadData().

• For inbound thread information:

use getInboundThreadData().

getQueueStatistics() resetConnectionStatistics() resetThreadStatistics()

Removed.


getActivityStatisticsByService() | 443

getActivityStatisticsByService()

Purpose Get the runtime statistics for an adapter service.

Parameters None.

Returns Name Type Description

SerialNo integer Unique row index.

ServiceName string Name of the adapter service.

ServiceType string Type of the adapter service:

• For Publication Service and Subscription Service: the value is IDoc.

• For Request-Response Invocation Service and Request-Response Service: the value is RFC.

Schema string Name of the schema:

• For Subscription Service: the value is the IDoc type.

• For Request-Response Service: the value is the name of the RFC or BAPI type.

NumberTotalMessages integer Number of total messages processed.

NumberSuccessMessages integer Number of successfully processed messages.

NumberErrorMessages integer Number of messages processed in error.

The returned statistics are tied specifically to the adapter service and not to the message received. If a Publication Service sends an incorrect IDoc or the service causes an exception when processing a correct IDoc, the statistics will not be accumulated.

If there is no activity for a particular adapter service, the service will not appear in the results.



getInboundConnectionData()

Purpose Get the number of the client connections to an inbound adapter service at runtime.

Parameters None.



ClientConnectionPool string Name of the client connection pool.

MaxConnections integer Maximum number of connections for the specified pool.


getInboundThreadData() | 445

getInboundThreadData()

Purpose Get the number of threads used in processing inbound messages for an inbound adapter service at runtime.

Parameters None.



ServiceName string Name of the adapter service.

ServiceType string Type of the adapter service:

• For Subscription Service: the value is IDoc.

• For Request-Response Service: the value is RFC.

Schema string Name of the schema:

• For Subscription Service: the value is the IDoc type.

• For Request-Response Service: the value is the name of the RFC or BAPI type.

ClientConnReference string Client connection reference.

SessionReference string Session reference.

ThreadCount integer Number of threads.



getOutboundThreadData()

Purpose Get the thread information for an outbound adapter service at runtime.

Parameters None.



ServerConnectionPool string Name of the server connection pool.

GatewayHost string Gateway host.

GatewayService string Gateway service.

ProgramID string Program ID.



refreshExtendedLogging() | 447

refreshExtendedLogging()

Purpose When running the adapter using extended logging along with Log4J, invoke this method when the Log4J properties file is changed.

Parameters None.

Returns None.



resetActivityStatistic()

Purpose Reset the runtime statistics for an adapter service.

Parameters None.

Returns None.

Resetting the statistics will not necessarily remove all prior information. Any adapter service that contains an activity will remain, but all accumulated values will be reset to 0.

This method also does not reset or change the statistics maintained in the adapter logs. Any statistics maintained in the adapter log will remain unaffected.


resumeInboundServices() | 449

resumeInboundServices()

Purpose Invoke this method to resume suspended inbound adapter services tied to a particular client connection pool.

The adapter services that will be resumed are Subscription Services and any Request-Response Services that are configured using one-way invocation.

Parameters

Returns None.

Name Type Description

ClientConnectionPool string Name of the client connection pool.



resumeOutboundServices()

Purpose Invoke this method to resume the server connection pools currently suspended.

When the server connection pools are restarted, this method will allow for messages to start to be exchanged between the SAP system and the outbound adapter containing Publication Services and Request-Response Invocation Services.

Parameters None.

Returns None.


resumeRemoteTIDManager() | 451

resumeRemoteTIDManager()

Purpose Invoke this method when communication between the adapter services and the remote TIDManager has been disabled, and the issues related to the remote TIDManager have been fixed. Before invoking this method, make sure the remote TIDManager is up and running.

Parameters None.

Returns None.



setInboundConnectionPool()

Purpose Set the maximum number of connections for a client connection pool.

Parameters

Returns None.


ClientConnectionPoolName string Name of the client connection pool.

MaxConnections integer Maximum number of connections for the specified pool.


setInboundThreadPool() | 453

setInboundThreadPool()

Purpose Change the number of threads for an inbound adapter service.

Parameters

Returns None.


ServiceName string Name of the inbound adapter service.

ThreadCount integer Number of threads for the specified service.

When changing the thread count, you can increase the thread count, but you cannot decrease the thread count afterwards. If the thread count has to be decreased, then you must stop and restart the adapter.



setOutboundThreadPool()

Purpose Modify the number of connections to the SAP gateway, which influences the number of threads available for processing outbound messages.

Parameters

Returns None.


GatewayHost string Gateway host.

GatewayService string Gateway service.

ProgramID string Program ID.



| 455

Appendix F Migrating an Adapter Project

You can migrate an existing project either using TIBCO Designer or using the migration tool installed with TIBCO ActiveMatrix Adapter for SAP 7.0.

The migration tool can migrate one or more adapter projects built in TIBCO Designer from TIBCO ActiveMatrix Adapter for SAP 5.5 or later to 7.0. The tool supports migration for both non-Unicode and Unicode projects.

This appendix provides information on how to migrate an existing project using TIBCO Designer, and introduces the migration tool and basic steps for migration.

Topics

• Migrating a Project by Using TIBCO Designer, page 456

• Migration Tool Functions, page 457

• Migration Tool Directory and Files, page 459

• Migration Tool Parameters, page 460

• Notes for Running the Migration Tool, page 461

• Migrating a Project by Using the Migration Tool, page 462

• Steps Following Migration of Configuration, page 466

As of the 7.0 release, the adapter supports configuration using one TIBCO Designer palette, which supports SAP systems that are either Unicode or Non-Unicode enabled. When configuring a project where multiple R3 Adapter configurations exist, it is recommended that you do not mix configurations where an adapter configuration is referring to a Unicode-enabled SAP system and another configuration is referring to a Non-Unicode-enabled SAP system, because both of these configurations can refer to common SAP schema and the schema is maintained differently based on the SAP system.


456 | Appendix F Migrating an Adapter Project

Migrating a Project by Using TIBCO Designer

To migrate an existing project using TIBCO Designer:

1. Open the existing project in TIBCO Designer.

2. Select one of the adapter configurations from the project. The dialog as follows is displayed. The message "Loading R/3 Product Classes" indicates that required configuration is being added to the existing project.

3. For all the adapter configurations in the project, refresh the SAP schema for any Request-Response Invocation Services. You do not need to refresh the SAP schema for the Publication Services, Subscription Services, and Request-Response Services.


This step is not necessary, if the command-line migration tool has been used against the project and the schema has been updated accordingly.


Migration Tool Functions | 457

Migration Tool Functions

The migration tool of TIBCO ActiveMatrix Adapter for SAP is a command-line tool for migrating old adapter projects to the latest release.

During the migration, the migration tool makes the following updates to an adapter project, and then refreshes the project directory during save:

• Add new custom TIBCO Hawk methods introduced in the 7.0 release.

This action takes place each time a project is saved. No specific logic is beyond the functionality available through the save action.

• Add a default JMS durable name in the JMS Topic sessions.

Upon startup of a runtime adapter, if the JMS durable name is not specified, the adapter will exit. To avoid this error, the tool checks the durable names of all the JMS Topic sessions. For any session with no name specified, the tool will add a name by following this convention:

InstanceName + EndpointName

For example, if the instance name is R3AdapterConfiguration and the endpoint name is MATMAS05JMStopicSubscriber, the default value will be R3AdapterConfigurationMATMAS05JMStopicSubscriber.

• Add a default JMS client ID in the JMS sessions that are used by adapter services requiring JMS Topics or Queues.

Upon startup of a runtime adapter, if the JMS client ID is not specified, the adapter will exit. To avoid this error, the tool checks if the client IDs of all the JMS sessions are present. For any session with no client ID specified, the tool will add a client ID by following this convention:

"%%Domain%%.%%Deployment%%.%%AppName%%.%%InstanceId%%." + SessionName

For example, if the session name is R3JMSTopicSession, the default value will be %%Domain%%.%%Deployment%%.%%AppName%%.%%InstanceId%%.R3JMSTopic

Session.



• Refresh the RFC or BAPI schema for the Request-Response Invocation Services:

— The migration tool will use the existing design-time connection for the adapter instance to fetch the latest schema from the SAP system.

— If the adapter service contains the following class reference, the corresponding schema will be refreshed:

/tibco/public/class/ae/700/basic/functionModules/Z_TEST_COMP

LEX

— If the SAP release tied to the design-time connection is no longer 700, the schema will continue to use the one available in the 700 release.

— The migration tool will refresh the RFC or BAPI schema by using the same path in AE Schema to avoid having to refresh the adapter service in TIBCO ActiveMatrix BusinessWorks. If the project was originally configured using an older release of an SAP system then the path will change, because the release of the SAP system has changed.

This functionality is only being offered as part of the migration tool. If similar refresh schema is done using TIBCO Designer directly then the path would change if the release of the SAP system has changed.

The migration tool is an automation tool. It does not provide additional functionality beyond what is available in the TIBCO ActiveMatrix Adapter for SAP palette in TIBCO Designer. The behaviors observed with the palette are consistent with those of the migration tool.


Migration Tool Directory and Files | 459

Migration Tool Directory and Files

Table 109 lists the files of the migration tool. All the files are installed in the TIB_ADR3_HOME/tools directory.

Table 109 Files of the Migration Tool

File Description

adr3MigrateConfig.exe (Windows)

adr3MigrateConfig (UNIX)

Executable file of the migration tool.

adr3MigrateConfig.tra TRA properties file used by the migration tool.

adr3MigrateConfig.log4j.properties

Default Log4J properties file for the migration tool.

adr3MigrateConfig.log4j.properties_template

Template Log4J properties file for the migration tool.



Migration Tool Parameters

Table 110 lists the command-line parameters when running the tool.

Table 110 Migration Tool Command-Line Parameters

Parameter Usage Description

-projectfile Conditional Specify the location of the TIBCO Designer project you want to migrate.

-projectdir Conditional Specify the location of the directory containing the TIBCO Designer projects you want to migrate.

-log:propfile Required Specify the location of the Log4J properties file.

-verbose Optional Toggle for verbose logging. Default value is set to off.

-help Optional Show usage information.


Notes for Running the Migration Tool | 461

Notes for Running the Migration Tool

When you prepare for the migration, pay attention to the following notes:

• If a project contains one or more Request-Response Invocation Services and these services contain properties relevant for dynamic logging or transactions, the project will not be migrated by the migration tool. You must migrate the project manually by opening the project in TIBCO Designer.

• If a project contains examples where the JMS durable name has been corrected, you must recycle the EMS server prior to running the adapter using the migrated project.

• The migration tool only migrates TIBCO ActiveMatrix Adapter for SAP configuration and refreshes schemas. It does not generate the EAR file for deployment. You must generate the EAR file manually by using TIBCO Designer prior to deploying the migrated project to TIBCO Administrator.

• When refreshing the RFC or BAPI schema for a Request-Response Invocation Service, the migration tool uses the design-time connection information of the adapter instance in the project to fetch the latest schema from the SAP system. If there is any connection issue, the migration tool will not migrate the project and will generate an error. You need to migrate the project manually by opening the project in TIBCO Designer.

• The migration tool is only compatible with the VFile projects of TIBCO Designer. It does not support the migration of projects in the format of ZIP archives or DAT files. If a project is saved in formats that are not supported, you need to migrate the project manually by creating the VFile projects from those formats in TIBCO Designer.



Migrating a Project by Using the Migration Tool

This section introduces the detailed procedure of running the migration tool. It includes these topics:

• Before the Migration, page 462

• Run the Migration Tool, page 462

• After the Migration, page 463

Before the MigrationBefore the migration, back up the old projects to a safe location, because the migration tool will override the project directory with the migrated projects.

Run the Migration ToolTo run the migration tool, you can follow these steps as an example:

1. Open the command prompt or terminal window and navigate to the TIB_ADR3_HOME/tools directory.

2. Based on the projects you want to migrate, run the tool in two ways:

To migrate one project, run the following commands:

— Windows adr3MigrateConfig.exe -projectfile

project_directory/project_name -log:propfile


— UNIX ./adr3MigrateConfig -projectfile

project_directory/project_name -log:propfile


To migrate mutliple projects in a directory, run the following commands:

— Windows adr3MigrateConfig.exe -projectdir projects_directory

-log:propfile adr3MigrateConfig.log4j.properties

— UNIX ./adr3MigrateConfig -projectdir projects_directory

-log:propfile adr3MigrateConfig.log4j.properties


Migrating a Project by Using the Migration Tool | 463

If the migration completes successfully, the migrated project is saved to the original directory. If any error occurs during the migration, the project will not be migrated and remain unchanged.

Migration Logging

During the migration, the tool generates the log information to the console and to a file, with the syntax based on the Log4J property file specified. If you use the original adr3MigrateConfig.log4j.properties file, the log file will be created in the TIB_ADR3_HOME/tools directory using adr3MigrateConfig_YYYYMMDD_hhmmss.log as the file name. If you want to log information to a different directory with a different file name, you need to update the directory and file name information in the Log4J properties file before running the tool.

After the MigrationAfter the migration, you need to complete the following tasks to set up the migrated project correctly:

• Make the Project Compatible with the Current Version, page 463

• Review the Configured Properties, page 464

• Replace Configuration in the saprfc.ini File, page 465

• Create a Service for Each IDoc Type, page 465

Make the Project Compatible with the Current Version

When you open the migrated project using TIBCO Designer, the Palette Versioning Issues dialog is displayed to remind you about inconsistent versions with the old project. Click the Yes button to continue opening the project.

Figure 168 shows the dialog displayed for a project migrated from TIBCO ActiveMatrix Adapter for SAP 6.2.1 to 7.0 as an example.

Do not kill the migration process while it is migrating a project or directory. This can cause the process to hang requiring you to kill the process manually.



Figure 168 Palette Versioning Issues Dialog for a Migrated Project

Review the Configured Properties

During the migration, a default value is provided for some properties. This section lists those properties, and it is recommended that you review the default values after migration to ensure that they meet your requirements.

• Thread count This property is for Subscription Service and Request-Response Service. The default value is 1.

See Advanced Tab of Subscription Service Configuration Reference on page 125 and Advanced Tab of Request-Response Service Configuration Reference on page 136 for configuration details.

• Maximum time between two startup attempts in case of failures (secs) This property is for server connection pools. The default value is 60.

See Setting Server Connection Advanced Options on page 169 for configurationn details.

• Format of the IDoc logging file This property is for Publication Services and Subscription Service. The default value is XML.

See Advanced Tab of Publication Service Configuration Reference on page 116 and Advanced Tab of Subscription Service Configuration Reference on page 125 for configuration details.


Migrating a Project by Using the Migration Tool | 465

Replace Configuration in the saprfc.ini File

If configuration being migrated contains connection pools that have references to the Saprfc.ini file, these connection pools are not migrated. You need to create new connection pools as needed by using the various connection pool types that are available from TIBCO Designer.

Create a Service for Each IDoc Type

If an adapter service does not exist for each required IDoc type, you need to create an adapter service for the IDoc type after migration.



Steps Following Migration of Configuration

This section is relevant for projects migrated using TIBCO Designer or the migration tool. When a project is migrated to the 7.0 configuration, you need to review some other configurations as follows:

• Review the Adapter SDK properties in TIBCO Administrator and update the properties accordingly. If the properties are not maintained, the default value maintained in TIBCO Administrator will take precedence over the value maintained in the actual deployed TRA file.

• Review the performance related properties for the runtime adapter. See Tuning Performance Factors on page 248 for detailed information.

• Modify any existing TIBCO Hawk rulebases based on the current set of trace messages available.

If you migrate a project by using the migration tool and the automation of building of EAR is required, you can use the buildear utility installed with TIBCO Runtime Agent for building the EAR file.

To automate the deployment of the configuration to a TIBCO Administrator domain, you can use the AppManage utitlity installed with TIBCO Runtime Agent.

You can run both utilities from command line. See Chapter 1, Scripting Deployment in TIBCO Runtime Agent Scripting Deployment User’s Guide for detailed instructions on how to use these utilities.


| 467

Index

A

adaptertracing 274

Adding Adapter Services Automatically 100ALE/IDoc Interface 6Assigning CMQ Name - Inbound Load-balanced

Instance 319

B

Basic Steps for Configuring and Using the Adapter 8Before Starting 8

C

Certified 114configure SAP instance

to run on two systems 312Configuring a User exit for a Subscription Service 317,

317Configuring Advanced Request-Response Invocation

Options 317configuring design time

remote function call 30Configuring Multiple Connections for Inbound

Instance 317Configuring Multiple Connections for Outbound

Instance 317Configuring Request-Response Invocation

Service 136configuring runtime

inbound messaging 32ALE customization for transferring IDocs from

the TIBCO environment 32

configuration of invoking BAPIs/RFCs from the TIBCO environment 32

outbound messaging 31configuration of invoking BAPIs/RFCs from the

SAP system 31configuration of publishing IDocs from the SAP

system 31configuring the SAP system

creating logical system 33creating a logical system for an adapter

instance 33Configuring Valid Destinations 323Creating a Project for the Adapter 8

D

Distributed Queue 115Durable 113

E

ENV_NAME xxvEvent Driven Inbound Connections 310, 310Example 128, 128, 135, 135, 139, 139

F

Frequently Asked Questions 325, 326


468 | Index

G

getConnectionStatistics() 187getThreadStatistics() 187Getting Started with Adapter Configuration 8Global Variables

Attributes 64

I

Identifying the Publication Mode 119IDoc

records contained 119IDoc in uncompressed “exploded” format 121IDocs

compressed form 120exploded format 121metadata 120versions supported 119

Inbound BAPI Transactional Support 290instance name 102, 105, 105Invoking BAPIs/RFCs Using Transactional Semantics

in SAP R/3 296

L

Load Balancing 317log file options 274

M

message filter 103Mode “none” 119Multiple Application Servers 310multiple file project 66Multiple Inbound Configurations 318Multiple Program IDs 303Multithreading 301Multithreading with Distributed Queues 302

N

Non-durable 113Non-persistent 113

O

Opening Projects 62Overview 348

P

Persistent 113Procedure 291, 312publish-subscribe 114

Q

Queue 114

R

related documentation xxiiReliable 114Reopening Projects 62Replacing Control Fields 317Request-Response Service 136, 136resetActivityStatistics() 187RFC Interface 6Running an Adapter Instance on Two SAP R/3 Sys-

tems with Single Connection 312RVCMQ Session Attributes 317


Index | 469

S

Sample Scenario 291, 312SAP R/3 Releases 4.x 105, 106, 117, 118, 126, 127, 133,

134, 137, 138Setting Adapter Run-Time Options 323Setting Publisher Configuration Options 116Single Inbound Configuration 320Single Outbound Instance 321Startup Tab 262system

configurl command-line argument 339, 339

T

Terminating the Test 28TIB_ADR3_HOME xxvTIBCO Hawk Session 262TIBCO support

contacting xxviiiTIBCO documentation xxviiiTIBCOmmunity xxviii

TIBCO_HOME xxvTopic 112, 112, 114typographical conventions xxv

U

use-trace-file, adapter option 274

V

version 103

W

wire formatheader information 122