Configuration and Deployment - TIBCO Software · TIBCO ActiveMatrix ® Adapter for SAP Configuration and Deployment Software Release 7.1 November 2014 Two-Second Advantage®

Two-Second Adv

TIBCO ActiveMatrix® Adapter for SAP

Configuration and DeploymentSoftware Release 7.1November 2014

antage®

Important Information

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

| iii

Contents

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

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxTIBCO ActiveMatrix Adapter for SAP Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxThird-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvi

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Creating a Project for the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Creating and Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Creating and Configuring Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Starting the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Starting the adapter with the Adapter Tester . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Starting the Adapter from the Command line with a Repository File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

TIBCO ActiveMatrix Adapter for SAP Configuration and Deployment

iv | Contents

Chapter 3 Preparing the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

SAP Account Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Enabling Inbound and Outbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Outbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Inbound Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 4 Developing an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Adapter Project Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Starting TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Saving a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

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

Working with Global Variables at Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Specifying Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Using Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Precedence of Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

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

Chapter 5 Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Creating an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Changing an Existing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Adapter Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Design-Time Connection Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Run-Time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Run-Time Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Adapter Services Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64


Contents | v

Chapter 6 Configuring an Adapter Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Adding an Adapter Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Adding an Adapter Service Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Adding an Adapter Service Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Adapter Services Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring an Adapter Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Transport Specific Options for Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Transport Type and Related Configuration Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Wire Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Delivery Mode (JMS Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Connection Factory Type (JMS Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Quality of Service (Rendezvous Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Publication Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Subscription Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Request-Response Invocation Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Request-Response Service Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Chapter 7 Configuring an Adapter Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

Adapter Connection Configuration Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Adding an Active Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Adding a Connection Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Assigning an Active Connection to an Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Adding a Client Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Client Connection Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Client Configuration Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Adding a Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Server Connection Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133


vi | Contents

Chapter 8 Configuring TIDManager Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

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

Adding a TIDManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

TID Manager Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Adding a TIDManager JMS Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154TIDManager JMS Session Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Chapter 9 Working with Secure Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

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

Setting Up SNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Install the SAP Cryptographic Library on the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Set SNC in TIBCO Designer for the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Chapter 10 Developing a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Overview of Business Process Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Activities for Communicating with Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Activity Configuration Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Mapping and Transforming Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Activity Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Mapping and Transforming Process Data to Activity Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Mapping Data with Adapter Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174For Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174For Request-Response Invocation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175For Request-Response Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Data Type Mapping between the SAP System and Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Testing a Process Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Chapter 11 Deploying an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Generating an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Generating an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Generating an EAR File in TIBCO Designer for a Project Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191EAR Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192


Contents | vii

Starting TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Task A Start the Administration Server and TIBCO Hawk Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Task B Start the TIBCO Administrator GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Creating an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Changing Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Overview of Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Tuning Performance Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Working with Global Variables at Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Changing Adapter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Deployment Choices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

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

Starting and Stopping a Service Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Overview of Service Instances Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Starting and Stopping a Service Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Viewing Log File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

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

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

Monitoring a Service by Using TIBCO Hawk Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Enabling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Starting TIBCO Hawk Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Invoking a Microagent Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Chapter 13 Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227

Configuring Advanced Logging Options for an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Using TIBCO Adapter SDK for Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Using Log4J for Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Setting TIBCO Messaging Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235TIBCO Messaging Encoding Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Setting Encoding at Design Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Setting Encoding at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Connecting with the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Managing the Connectivity with the SAP System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Adapter Reconnection with the SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Adapter Connecting to Multiple Client Connection Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Configuring Multiple Connections for Inbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238


viii | Contents

Configuring Multiple Connections for Outbound Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Configuring SAP System for bgRFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Password Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

JMS Compression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Using SSL Certificates from an External Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Inbound BAPI Transactional Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Automatic Commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Related Transaction Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Invoking BAPI/RFCs Using Transactional Semantics in SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Support for qRFCs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Transferring IDoc through qRFC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Multithreading in Outbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Multithreading in Inbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Multithreading with Distributed Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Multiple Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Posting BAPIs/RFCs/IDocs from Multiple Gateways in the Outbound Adapter . . . . . . . . . . . . . . . . . . . . . . 261Posting BAPIs/RFCs/IDocs from Multiple RFC Destinations in the Outbound Adapter. . . . . . . . . . . . . . . . 262Responding to Dynamic Changes in the Application Server Environment . . . . . . . . . . . . . . . . . . . . . . . . . 263Configuring the Inbound Adapter for Multiple Application Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Event Driven Inbound Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Disabled Connection Pooling Inbound Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Performing Explicit Logon for RFCs/BAPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Single Sign-On Using SNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

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

Using JMS Destination Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

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

Load Balancing Using Distributed Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Configuring Inbound Load-Balanced Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Multiple Inbound Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Single Inbound Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Configuring Outbound Load-balanced Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Configuring Valid Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Appendix A Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Appendix B Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293


Contents | ix

Appendix C Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .295

Overview of Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Password Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Adapter Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Required Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299TIBCO ActiveMatrix Adapter for SAP Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Appendix D Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311

Overview of Trace Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Fields of Trace Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Status Messages of TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Trace Messages of TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Design-Time Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357Trace Messages Discontinued . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Appendix E Adapter Microagents and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .405

Adapter Microagents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Available TIBCO Hawk Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Appendix F Migrating an Adapter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .423

Migration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424Migration Tool Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

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

Migrating a Project by Using the Migration Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427Before the Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427Migrating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428After the Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

Configuration in the Migrated Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .433


x | Contents


Figures | xi

Figures

Figure 1 R3 Adapter Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Figure 2 TIBCO Designer Startup Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Figure 3 Save Project Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 4 Global Variables Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Figure 5 Add Files to the Revision Control System Warning Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 6 Adapter Instance - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Figure 7 Adapter Instance - Change Version Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 8 Adapter Instance - Design-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Figure 9 Connection Success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Figure 10 Connection Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Figure 11 Adapter Instance - Run-Time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Figure 12 Adapter Instance - Run-Time Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Figure 13 Adapter Instance - Adapter Services Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Figure 14 Adapter Instance - Adapter Services Tab, OutboundTID Management: Remote . . . . . . . . . . . . . . 56

Figure 15 Adapter Instance - Adapter Services Tab, InboundTID Management: Remote . . . . . . . . . . . . . . . . 57

Figure 16 Adapter Instance - General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Figure 17 Adapter Instance - Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Figure 18 Sample Outbound Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Figure 19 Adapter Instance - Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Figure 20 Adapter Instance - Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Figure 21 Adapter Services - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Figure 22 Adapter Services - IDocs Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Figure 23 Adapter Services - RFC/BAPI Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Figure 24 Publication Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Figure 25 Publication Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . . . . 89

Figure 26 IDoc in Native RFC Table Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Figure 27 IDoc in Uncompressed “Exploded” Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Figure 28 IDoc in Untransformed "String" Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94


xii | Figures

Figure 29 Publication Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Figure 30 Publication Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Figure 31 Subscription Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Figure 32 Subscription Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . . . . . . 100

Figure 33 Subscription Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Figure 34 Subscription Service - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Figure 35 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS. . . . . . . . . . . 106

Figure 36 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous . . . . 108

Figure 37 Request-Response Invocation Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Figure 38 Request-Response Invocation Service - Advanced Tab - Transport Type Rendezvous . . . . . . . 110

Figure 39 Request-Response Service - Configuration Tab - Transport Type: JMS . . . . . . . . . . . . . . . . . . . 111

Figure 40 Request-Response Service - Configuration Tab - Transport Type: Rendezvous . . . . . . . . . . . . . 113

Figure 41 Request-Response Service - Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Figure 42 Request-Response Service - Advanced Tab - Transport Type: Rendezvous. . . . . . . . . . . . . . . . 115

Figure 43 Adapter Connection - R3 Connections Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Figure 44 R3TIDManager - Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Figure 45 Sample Outbound Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Figure 46 R3TIDManager - Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Figure 47 R3TIDManager - Monitoring Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Figure 48 R3TIDManager - General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Figure 49 TIDManager JMS Session - Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Figure 50 Runtime Outbound Connection in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Figure 51 Runtime Inbound Connection in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Figure 52 Developing a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Figure 53 Input Tab of an Example Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Figure 54 Segment Example in SAP System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Figure 55 IDoc SEGNAM Property in the Input Tab of the Publish to Adapter Activity . . . . . . . . . . . . . . . . . 175

Figure 56 Invoke an Adapter Request-Response Service Activity - Input Tab . . . . . . . . . . . . . . . . . . . . . . . 177

Figure 57 Edit Statement Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Figure 58 Select a Resource Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Figure 59 __caret__userClosure__caret_ element with the RFCCLOSURE Schema . . . . . . . . . . . . . . . . . 179

Figure 60 Set Breakpoints Window for a Sample Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186


Figures | xiii

Figure 61 Select Processes to Load Window for a Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Figure 62 Select a Resource Window for Shared Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Figure 63 Dependencies (Resources) Tab with the Certificate Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Figure 64 Enterprise Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Figure 65 Adapter Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Figure 66 Application Management > Application Management Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Figure 67 New Application Configuration Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Figure 68 Application Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Figure 69 Deploy Configuration Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Figure 70 All Service Instances Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Figure 71 View Service Instance - Tracing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Figure 72 TIBCO Hawk Session - Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Figure 73 Hawk Console - Microagent Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Figure 74 Hawk Console - Microagent Window - Method Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Figure 75 Machine Console - View Machine Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Figure 76 Microagents, Methods and Arguments Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Figure 77 Microagents, Methods and Arguments Window - getComponentInfo Method. . . . . . . . . . . . . . . . 224

Figure 78 Invocation Results - getComponentInfo Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Figure 79 Adapter Instance - Logging Tab for Advanced Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Figure 80 File Sink for an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Figure 81 Log4j Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Figure 82 Setting TIBCO Messaging Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Figure 83 RFC Destination Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Figure 84 Function Builder Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Figure 85 Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Figure 86 Invoke Request-Response Service Activity-Input Tab-bAutoCommit . . . . . . . . . . . . . . . . . . . . . . 252

Figure 87 Create Sales Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Figure 88 Get Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Figure 89 Invoke Request - Response Service Activity - Input Tab - Activity Input - tRFC . . . . . . . . . . . . . . 255

Figure 90 Invoke Request - Response Service Activity - Input Tab - Activity Input - qRFC. . . . . . . . . . . . . . 257

Figure 91 Outbound Adapter Connecting to Multiple SAP Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Figure 92 Outbound Adapter Registering on Multiple Program IDs on One Gateway . . . . . . . . . . . . . . . . . . 262


xiv | Figures

Figure 93 Clustering Multiple Application Servers under a Central SAP Instance . . . . . . . . . . . . . . . . . . . . 263

Figure 94 Invoke Inbound Adapter Service Activity - Input Tab - bTransactional . . . . . . . . . . . . . . . . . . . . . 271

Figure 95 Default RVCMQ Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Figure 96 RVCMQ - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Figure 97 Palette Versioning Issues Window for a Migrated Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430


Tables | xv

Tables

Table 1 TIBCO Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx

Table 2 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii

Table 3 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv

Table 4 Remote Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

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

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

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

Table 8 Adapter Instance - Run-Time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Table 9 Adapter Instance - Run-Time Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Table 10 Adapter Instance - Adapter Services Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

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

Table 12 Adapter Instance - Adapter Services Tab, Inbound TID Managment: Remote . . . . . . . . . . . . . . . 57

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


xvi | Tables

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

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

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

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

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

Table 34 Adapter Connection Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Table 35 Client Connection - Dedicated Application Server - Run-Time Inbound Tab . . . . . . . . . . . . . . . . 126

Table 36 Client Connection - Load Balancing - Run-Time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Table 37 Client Connection - SNC - Run-Time Inbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Table 38 Client Connection - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Table 39 Client - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Table 40 Client - Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Table 41 Server Connection - Default - Run-Time Outbound Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Table 42 Server Connection - SNC - Run-Time Outbound Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Table 43 Server Connection - Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Table 44 R3TIDManager - Logging Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Table 45 R3TIDManager - Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Table 46 R3TIDManager Monitoring - Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Table 47 R3TIDManager - General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Table 48 TIDManager JMS Session - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Table 49 Outbound SNC Parameters for TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Table 50 Inbound SNC Parameters for TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Table 51 Adapter Services and Associated Activities in the ActiveEnterprise Adapter Palette . . . . . . . . . . 168

Table 52 Schemas Used in the Input and Output of Activities for Adapter Services . . . . . . . . . . . . . . . . . . 173

Table 53 RFCCLOSURE Properties for an Inbound Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Table 54 Associated Properties of Dynamic Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Table 55 RFCCLOSURE Properties for an Outbound Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Table 56 RFCCLOSURE Properties Not Applicable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Table 57 Data Mapping between SAP Data Types and Adapter Data Types . . . . . . . . . . . . . . . . . . . . . . . 184

Table 58 Enterprise Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Table 59 Adapter Archive - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Table 60 Adapter Services Supported by TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . 233


Tables | xvii

Table 61 TIBCO Messaging Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Table 62 Description of BAPI Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

Table 63 Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

Table 64 Required Runtime Adapter Properties File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Table 65 Adapter Properties in TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

Table 66 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP. . . . . . . . . . . . . . . . . . . . . . . . . 306

Table 67 SDK Fault Tolerance Properties in TIBCO ActiveMatrix Adapter for SAP . . . . . . . . . . . . . . . . . . 308

Table 68 Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Table 69 Debug Messages for Adapter Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Table 70 Error Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Table 71 Info Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Table 72 Warn Messages for Adapter Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

Table 73 Info Messages for Application Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

Table 74 Error Messages for Configuration Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

Table 75 Debug Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Table 76 Info Messages for Configuration Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Table 77 Warn Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Table 78 Debug Messages for Data Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Table 79 Debug Messages for Hawk Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Table 80 Error Messages for Pubication Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

Table 81 Error Messages for Request-Response Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

Table 82 Error Messages for Request-Response Invocation Category . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Table 83 Error Messages for Subscription Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Table 84 Info Messages for System Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

Table 85 Error Messages for System Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

Table 86 Warn Messages for Configuration Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Table 87 Error Messages for DTA Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Table 88 Info Messages for DTA Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

Table 89 Error Messages for Repository Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Table 90 Error Messages for Schema Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Table 91 Warn Messages for Schema Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Table 92 Discontinued Trace Messages of TIBCO ActiveMatrix Adapter for SAP 7.1 . . . . . . . . . . . . . . . . 367


xviii | Tables

Table 93 Custom Microagent Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Table 94 Migration Tool Command-Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428


| xix

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, deploy, manage, and monitor 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 xx

• Typographical Conventions, page xxiii

• Connecting with TIBCO Resources, page xxvi


xx | 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.

• TIBCO ActiveMatrix Adapter Framework Documentation Read this documentation for instructions on how to install, configure and deploy the adapter in TIBCO ActiveMatrix BusinessWorks 6.

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

Table 1 TIBCO Products (Sheet 1 of 3)

TIBCO Product Description

TIBCO ActiveMatrix® Binding Typefor Adapters

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


Preface | xxi

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

TIBCO ActiveMatrix® Adapter Framework This product provides a visual, model-driven development environment for configuring supported TIBCO adapters in TIBCO Business Studio.

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.




xxii | 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.

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.




http://service.sap.com/instguides

http://help.sap.com

http://service.sap.com/connectors

Preface | xxiii

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].


xxiv | 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 | xxv

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}


xxvi | 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:

https://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

https://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.

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

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 9.

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 to message with the TIBCO environment by carrying out appropriate configuration. See Chapter 3, Preparing the SAP System, on page 17.

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, Defining and Saving an Adapter Project, page 3

• Task B, Configuring an Adapter Instance, page 3

• Task C, Configuring an Adapter Service, page 3

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

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

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


Configuration and Deployment Overview | 3

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

• Task H, Testing the Adapter Configuration, page 4

For an introduction of TIBCO Designer, see "TIBCO Designer" in TIBCO ActiveMatrix Adapter for SAP Concepts.

Task A Defining and Saving an Adapter Project

When starting TIBCO Designer, you can 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 23.

Task B Configuring an Adapter Instance

An adapter instance in a project contains all information needed by the runtime adapter. By dragging the R3AdapterConfiguration 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 37.

Task C Configuring 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 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 69.



Task D (Optional) Configuring an Adapter Connection

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

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

Task E (Optional) Configuring a TIDManager Instance

In TIBCO ActiveMatrix Adapter for SAP, you need to configure the TIDManager server in the following scenarios:

• Outbound Configurations

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.

• Inbound Configurations

Mutiple Subscription service configurations (for IDoc) run in a load-balanced fashion.

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

Task F (Optional) Configuring Secure Communication

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

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

Task G (Optional) Configuring Advanced Options

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

See Chapter 13, Advanced Topics, on page 227.

Task H Testing 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.


Configuration and Deployment Overview | 5

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

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 165.

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 189.

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 211.



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 requested 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.




Features of TIBCO ActiveMatrix Adapter for SAP | 7



Mutiple Subscription service configurations (for IDoc) run in a load-balanced fashion.




| 9

Chapter 2 Getting Started

This chapter describes the basic steps that are required to configure and run the TIBCO ActiveMatrix Adapter for SAP.

Topics

• Creating a Project for the Adapter, page 10

• Creating and Configuring an Adapter Instance, page 11

• Creating and Configuring Adapter Services, page 13

• Starting the Adapter, page 14

• Stopping the Adapter, page 16


10 | Chapter 2 Getting Started

Creating a Project for the Adapter

To begin the configuration process, first you need to create a project in TIBCO Designer.

See the TIBCO Designer documentation for more information about using TIBCO Designer.

To create a project:

1. Start TIBCO Designer by executing one of the following platform-specific commands:

— On Microsoft Windows:

Click Start > All Programs > TIBCO > TIBCO Designer [version_number] > TIBCO Designer.

— On UNIX:

On a command line, go to TIBCO_HOME/designer/version_number/bin and type ./designer.

2. In the TIBCO Designer startup window, click New empty project.

3. In the Project Directory field, browse to select the directory where you want to save the project and specify a name for the project. Click OK.


Creating and Configuring an Adapter Instance | 11

Creating and Configuring an Adapter Instance

After creating the project, to create and configure an adapter instance:

1. Open the project created in the preceding task in the Project Explorer.

2. Expand the R3 Adapter palette in the Palettes panel.

3. Drag the R3AdapterConfiguration icon to the Design panel. The R3 Adapter Configuration panel is displayed. See the following figure.

Figure 1 R3 Adapter Configuration Panel

4. Specify a name for this adapter instance in the Configuration tab. The default name is R3AdapterConfiguration. To show the advanced configurations, select the Show All Tabs check box.

If the R3 Adapter palette does not appear in the Palettes panel, click Palettes > Adapters > R3 Adapter.

When you create a SAP adapter instance in a project, the R3Connections folder is automatically created at the same time.



5. Define the connection options in the Design-Time Connection, the Run-Time Inbound, and the Run-Time Outbound tabs. See Design-Time Connection Tab on page 47, and Run-Time Inbound Tab on page 49, and Run-Time Outbound Tab on page 51 for more details.

6. Click Save.


Creating and Configuring Adapter Services | 13

Creating and Configuring Adapter Services

After configuring the adapter instance, you need to create and configure adapter services that perform the data passing operations for the adapter. You can add more than one service to an adapter instance. The available services for the adapter are as follows:

• Publication Service

• Subscription Service

• Request-Response Invocation Service

• Request-Response Service

Take the Publication Service as an example.

To add and configure a Publication Service:

1. Expand the adapter instance folder in the Project panel, and then click the Adapter Services folder.

2. Drag the Publication Service icon from the R3 Adapter palette to the Design panel.

3. In the Configuration panel, define the options in all the tabs. See Publication Service Configuration Reference on page 86 for details about configuring the service.

4. Click Save.



Starting the Adapter

After configuring the adapter with required services, you can start the adapter in the following two ways:

• Starting the adapter with the Adapter Tester, page 14

• Starting the Adapter from the Command line with a Repository File, page 14

Starting the adapter with the Adapter TesterTo start the adapter with the Adapter Tester, the adapter and TIBCO Designer must be installed on the same machine.

1. Start TIBCO Designer.

2. Click Tools > Show Adapter Tester. The Adapter Tester window opens.

3. In the left panel, select the adapter instance that you want to start.

4. In the Run Settings tab, enter a directory to place running files in the Working Directory field.

5. Select an executable from the Adapter Executable field and then click Apply.

6. To start the adapter instance, click Start. To view the output messages, click the Console tab.

Starting the Adapter from the Command line with a Repository FileTo start the adapter on a command line with a repository file, the project must be run as a local repository and saved in DAT (repository) format. See the TIBCO Designer documentation for more information about repository files.

Task A Converting the Project to a Repository File

To export the project to a local repository:

1. Start TIBCO Designer.

2. Click Project > Export Full Project. The Export Project window opens.

If the transport type of the adapter service is JMS, first you need to start TIBCO Enterprise Message.

See "Running the EMS Server" in TIBCO Enterprise Message Service User’s Guide for how to start and stop an EMS Server.


Starting the Adapter | 15

3. In the Local Repository tab, enter the project name and the output directory and then click OK.

4. In the Create Project dialog, select file type and TIBCO messaging encoding. Click Yes.

Task B Starting the Adapter

The adapter can be run by specifying the path of the DAT file in the repo URL, in the properties file or TIBCO Runtime Agent.

1. On the command line, go to the TIB_ADR3_HOME\bin directory, which hosts the adapter executable.

2. Enter the following command to start the adapter:

adr3.exe -system:repourl repository_file_url -system:configurlconfiguration_url



Stopping the Adapter

To stop the adapter, you can use one of the following ways:

• From a command window, stop the adapter by sending the following message to the terminate subject or terminate topic. Ensure that this is the message specified in the General tab. See General Tab on page 58 for message subject details. The convention of the subject is %%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit with “now” as the message content.

Example — To stop an adapter instance called IDocOutbound, available in the gettingStarted.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 termination subject, it completes any pending transactions, cleans resources, and then terminates.

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


Preparing the SAP System | 17

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 different configuration stage.

You must enable the SAP system for messaging with the TIBCO environment. No modifications of code are required in the SAP system itself.

Topics

• SAP Account Requirements, page 18

• Enabling Inbound and Outbound Messaging, page 20


18 | Chapter 3 Preparing the SAP System

SAP Account Requirements

An SAP account is required to connect to the SAP system to communicate with the adapter.

Before configuring the adapter at design time, ensure your SAP account and your SAP system meet the following requirements:

• Your SAP account has the access to a dedicated SAP application server and has permission to extract metadata for BAPIs, RFCs, and IDocs by using TIBCO Designer.

• Your SAP account has the authorization from the SAP system administrator to execute RFCs and access tables in the SAP system.

• Your SAP account can successfully execute the RFCs listed in the following table by using the transaction code SE37 in your SAP GUI with the provided test data.

• If you want to use different connections between design-time and runtime Inbound adapters, obtain the relevant connection information.

• If you want to configure a load-balanced Inbound adapter, get the parameters used to connect to a messaging server for a specific login group.

IDocs/RFCs/BAPIs specific to a particular language cannot be retrieved if you log on to the SAP system from the SAP GUI or TIBCO Designer with a different language.

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>


SAP Account Requirements | 19

DDIF_FIELDINFO_GET Run transaction SE37.

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

Table 4 Remote Function Calls (Cont’d)

Remote Function Call Test Input Data



Enabling Inbound and Outbound Messaging

Configure the SAP system to enable Outbound and Inbound messaging with TIBCO Environment.

• Outbound Messaging, page 20

• Inbound Messaging, page 21

Outbound MessagingTo enable Outbound messaging at run time, ensure that you implement the following configurations in the SAP system.

Configurations of Invoking BAPIs/RFCs from the SAP System

1. Define an RFC destination in the SAP system.

After creating an RFC destination, map it to a program ID. The Outbound adapter is registered on the SAP gateway with this program ID. Therefore, the Outbound adapter can receive BAPIs/RFCs invoked on the RFC destination.

See Defining an RFC Destination for details.

2. Ensure that your SAP account is authorized to execute BAPIs and RFCs.

Configurations of Publishing IDocs from the SAP System

To transfer IDocs from the SAP system to TIBCO environment:

1. Create a logical system for the adapter. See Defining/Setting Up a Logical System for details.

2. Create a distribution model. See Creating the ALE Distribution Model for details.

3. Configure RFC communication.

4. Test the SAP ALE configuration. In the SAP system, run transaction code BD12 to send IDocs to any logical system.


http://help.sap.com/saphelp_nw73/helpdata/en/aa/b4b13b00ae793be10000000a11402f/content.htm


https://help.sap.com/saphelp_erp60_sp/helpdata/en/56/b1b13bb3acef3ce10000000a11402f/content.htm

http://help.sap.com/saphelp_srm70/helpdata/en/9f/9925413fabef23e10000000a155106/content.htm

Enabling Inbound and Outbound Messaging | 21

Inbound MessagingTo enable Inbound messaging at run time, ensure you implement the following configurations in the SAP system.

Configurations of Invoking BAPIs/RFCs from the TIBCO Environment

To use the adapter to invoke BAPIs/RFCs in the SAP, ensure your account has the authorization to invoke BAPIs/RFCs.

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

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

Configurations of Transferring IDocs from the TIBCO Environment

To transfer IDocs from TIBCO environment to SAP system:

1. Create a logical system for the adapter. See Defining/Setting Up a Logical System for details.

2. Create a distribution model. See Creating the ALE Distribution Model for details.

3. Define a partner profile.

See Configuring the Port and Partner Profile for details.


http://help.sap.com/saphelp_erp60_sp/helpdata/en/88/bac79fd384c64ea61983dd93af507e/frameset.htm



https://help.sap.com/saphelp_erp60_sp/helpdata/en/56/b1b13bb3acef3ce10000000a11402f/content.htm



| 23

Chapter 4 Developing an Adapter Project

Project is 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 24

• Starting TIBCO Designer, page 25

• Creating a Project, page 26

• Saving a Project, page 27

• Opening and Reopening a Project, page 28

• Working with Global Variables at Design Time, page 29

• Working with a Revision Control System, page 32


24 | 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 171 for detailed information.

• Adapter Services Folder This folder contains the adapter services you add to the adapters and the configuration you specify for the services.

• Advanced Folder This folder contains resources created by TIBCO Designer when you configure an 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 configurations are done by changing resources that are available from the Adapter Services folder.


Starting TIBCO Designer | 25

Starting TIBCO Designer

To start TIBCO Designer:

• On Microsoft Windows, you can choose one of the following ways:

— Click Start > All Programs > TIBCO >TIBCO Designer [version_number] > TIBCO Designer.

— Invoke TIBCO_HOME\designer\version_number\bin\designer at the command prompt.

• On UNIX:

Invoke ./TIBCO_HOME/designer/version_number/bin/designer on the command line.



Creating a Project

• When you launch TIBCO Designer, the startup window opens, as shown in the following figure. With the startup window, you can create a new project, open an existing project or convert a project from a legacy format, and perform some administrative tasks.

Figure 2 TIBCO Designer Startup Window

• In TIBCO Designer main window, click Project > New Project.

When you create a new project, the Save Project window opens. 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 27 to save the project.


Saving a Project | 27

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 tasks:

— Click Project > Save.

— Click Project > Save As and specify the storage directory.

— Click the Save icon on TIBCO Designer Toolbar.

2. In the Save Project window, see the following figure, 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. 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 3 Save Project Window

3. Click OK.



Opening and Reopening a Project

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

See "Project Formats" in 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 the following two ways:

• From the startup window when you launch TIBCO Designer.

• Click Project > Open if TIBCO Designer is already open. TIBCO Designer opens a new window for your project.

Importing a Project Saved as a ZIP ArchiveClick Project > Import Full Project or Project > Import Resources From File, Folder, URL. In the open window, provide the appropriate information for the project files and click OK.

Opening a Project under a Revision Control SystemIf you open a project under a revision control system, you must provide the appropriate information for the system you work with.

Opening a Project Saved as a DAT FileIf you open a project saved in a legacy format, first you must convert it. Use the Administration tab in the startup window 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 cannot be ensured that all configurations are loaded. It is recommended that you use ZIP archives whenever possible.


Working with Global Variables at Design Time | 29

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 run time.

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 293.

• 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 29

• Using Global Variables, page 31

• Precedence of Global Variables, page 31

See Working with Global Variables at Deployment on page 203 for details of changing and using global variables at run time.

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, click the Global Variables panel, and then click Open Advanced Editor. If you select a global variable, then click Open Advanced Editor, the editor opens with the variable selected.

The following figure shows the Global Variables editor.



Figure 4 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 Select Deployment check box to make the variable visible and configurable when deploying using TIBCO Administrator. If the check box is clear, the variable is not visible in TIBCO Administrator.

• Service Select this check box, and select Include All Service Level Global Variables check box 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 189 for how to set global variables at deployment.

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

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


Working with Global Variables at Design Time | 31

• 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, the user name and the 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 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 32

• Locking an Adapter Configuration, page 32

• Managing Schema Files, page 32

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

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 in 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 hard drive of the developer.

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 | 33

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 is modified to update custom scalars if necessary. The R3Connections.adr3Connections file under project_root is 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 are 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. The following figure shows the displayed warning dialog.

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



Figure 5 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.

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 | 35

Regeneration When Moving, Copying and Pasting

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

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.




| 37

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 38

• Configuring an Adapter Instance, page 39

• Changing an Existing Configuration, page 41

• Adapter Configuration Reference, page 42


38 | 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 you create an adapter instance, 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 icon from the R3 Adapter palette to the Design panel. This creates an adapter instance named, by default, R3AdapterConfiguration.

Click the adapter instance you create, 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 39 for configuration details.

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 instances exist, it is recommended that you do not mix configurations where an adapter instance is referring to a Unicode-enabled SAP system and another instance 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 | 39

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, select the Show All Tabs check box in this tab. See Configuration Tab on page 42.

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

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

— For Inbound R/3 connection type, see Run-Time Inbound Tab on page 49.

— For Outbound R/3 connection type, see Run-Time Outbound Tab on page 51.

— For Both R/3 connection type, see Run-Time Inbound Tab on page 49 and Run-Time Outbound Tab on page 51.

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

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

f. (Optional) In the Logging tab, define the logging options. Decide now whether or not 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, select the Use Advanced Logging check box, and use the Log Sinks folder in the Project panel to define your sinks. See Logging Tab on page 60.



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

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

4. Click Save.


Changing an Existing Configuration | 41

Changing an Existing Configuration

When making changes, take note 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 42

• Design-Time Connection Tab, page 47

• Run-Time Inbound Tab, page 49

• Run-Time Outbound Tab, page 51

• Adapter Services Tab, page 53

• General Tab, page 58

• Logging Tab, page 60

• Startup Tab, page 63

• Monitoring Tab, page 64

Configuration TabThe following figure shows the Configuration tab.

Figure 6 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 29 for details on how to define and use global variables.


Adapter Configuration Reference | 43

The following table 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 44 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.

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) Select this check box to display additional tabs for configuring advanced options.

This check box is clear by default. See Guidelines for Showing All Tabs on page 45 for when you need to show all the configuration tabs.

R/3 Connection Type The type of instance.

An client and server connection references are created in the Adapter_NameActiveConnections folder by default. See Guidelines for Choosing R/3 Connection Type on page 46.

Available options are:• Inbound

• Outbound

• Both

Change Version... Click this button to change the value of the Version option.

See the following figure and table for more detailed information.



Figure 7 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.

• 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.

Table 6 Adapter Instance - Change Version Window

Name Description

What Version Do You Want To Change To From the What Version Do You Want To Change To list, select the adapter environment version of your preference.

Available options are:• AE Version 4.0

• AE Version 5.0

• AE Version 5.1

• AE Version 5.2

• AE Version 5.3

Note: The current Version value is not shown in the drop-down list.



When you create an adapter instance, the palette automatically creates several resources for it. The names of these resources are derived from the name of the instance they belong to. The change of the name of the adapter instance results in an automatic change of the resources names. If you manually modify any resource name, this resource name is not automatically changed next time you rename the adapter instance.

When you name the adapter instance, the following resources are named automatically:

• Subject name

• CM name

• CMQ name

• Ledger file

• Default client connection

• Default server connection

• Active connection

Guidelines for Showing All Tabs

You must select the Show All Tabs check box, if any of the following configurations are required:

• Configuring Outbound TID Management to Remote

• Configuring Inbound TID Management to Local or 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 227.



Guidelines for Choosing R/3 Connection Type

Select the type of instance:

• Inbound

If you select Inbound from the R/3 Connection Type list, proceed to enter the Inbound configuration parameters in the Run-Time Inbound tab.

• Outbound

If you select Outbound from the R/3 Connection Type list, enter the Outbound configuration parameters in the Run-Time Outbound tab.

• Both

Default setting. If you select Both from the R/3 Connection Type list, enter configuration details in both the Run-Time Inbound and Run-Time Outbound tabs.

The Both adapter instance is a test adapter instance. It is not recommended to switch from Both to Inbound or from Both to Outbound. There is no automatic mechanism to change the adapter services to reflect any change. You need to manually delete the Publication Service if a change was made from Both to Inbound or vice versa.

An Inbound or an Outbound instance can be changed to a Both 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 list in the Configuration tab, a client connection and a server connection references are created by default when you create an adapter instance.



Design-Time Connection TabThe following figure shows the Design-Time Connection tab.

Figure 8 Adapter Instance - Design-Time Connection Tab

The following table lists the fields in the Design-Time Connection tab.

Table 7 Adapter Instance - Design-Time Connection Tab

Field Description

Application Server Network name of the SAP application server host

machine.

For example: SAPsvr

System Number SAP system number.

For example: 00

Client SAP client number.

For example: 853

User name The valid user name to log on to the SAP client specified.

Password The valid password corresponding to the user name.

Remember Password Select this check box to store a password in the project repository.

The check box is selected by default.



Guidelines for Testing Connection

Click Test Connection to verify the connection parameters specified.

• If connectivity is available, a successful message dialog is displayed. See the following figure as an example.

Figure 9 Connection Success

• If connectivity is not available, an error message with details of the error is displayed. See the following figure as an example.

R/3 Logon Language The language used by the adapter to set up connection with the SAP system.

The available option is:• English

Use Design-Time Connection For Run-time

Select this check box to copy design-time parameters in the Design-Time Connection tab to the Run-Time Inbound tab. And all fields in the Run-Time Inbound tab are disabled.

To customize values in the Run-Time Inbound connection tab, clear this check box.

This check box is clear by default.

If the SAP system is behind a firewall, then the SAP router string and the application server name need to be mentioned. See Route String Entry for SAP router for more information.

Test Connection... Click this button to verify the connection parameters specified.

See Guidelines for Testing Connection on page 48 for how to verify the parameters.

Table 7 Adapter Instance - Design-Time Connection Tab (Cont’d)

Field Description



Figure 10 Connection Failure

Run-Time Inbound TabThe following figure shows the Run-Time Inbound tab.

Figure 11 Adapter Instance - Run-Time Inbound Tab

The following table lists the fields in the Run-Time Inbound tab.

Table 8 Adapter Instance - Run-Time Inbound Tab

Field Description

Type The type of default Inbound connection.

Application Server Network name of the SAP application server host machine.

For example: SAPsvr

System Number SAP system number. For example: 00

Client SAP client number. For example: 853

User name The user name for logging on to the SAP system.



Password The password corresponding to the user name.

R/3 Logon Language The language used by the adapter to set up connection with the SAP system.

R/3 Code Page The character sets used by the SAP system and database.

The value of this field is null by default. You need not to enter a value for it.

Note: If the value of this field is not null in the project of a prior version, after you migrate a project to the version 7.1, the value becomes null.

Inbound Connection Reference

Click Go To Reference Resource to configure advance settings for the default connection reference.

When you create an adapter instance, a default client connection is automatically created and used as the client connection reference for the Subscription Service an the Request-Response Service.

You can configure an Inbound adapter instance with multiple client connection types. See Adding a Client Connection on page 125. But the instance can have only one default connection. In case of multiple Inbound connections, only the default Inbound connection configuration is displayed. During creation of adapter services, the default Inbound connection is used to configure connections requiring Inbound connection to the SAP system.

Test Connection... Click this button to verify the connection parameters specified.

See Guidelines for Testing Connection on page 48 for how to verify the parameters.

Table 8 Adapter Instance - Run-Time Inbound Tab (Cont’d)

Field Description



Run-Time Outbound TabThe following figure shows the Run-Time Outbound tab.

Figure 12 Adapter Instance - Run-Time Outbound Tab

The following table lists the fields in the Run-Time Outbound tab.

Table 9 Adapter Instance - Run-Time Outbound Tab

Field Description

Type The type of default Outbound connection.

Program ID A valid existing program ID that identifies the RFC Server program for the SAP system.

Gateway Service SAP gateway service. Default value is SAPgw00.

Gateway Host Gateway host name, IP address or router string. If there is no specified machine acting as a gateway host, this is the same as the appserver.

RFC Trace REC trace activation indicator.

Set the value to 0 to disable RFC trace.

Set the value to 1 to enable RFC trace.

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.



Outbound Connection Reference

Click Go to referenced resource to configure advance settings for the default server connection reference.

You can configure an Outbound adapter instance with multiple server connections. For details see Adding a Server Connection on page 133. But the instance can have only one connection set as the default. In case of multiple Outbound connections, only the configuration of the default Outbound connection is displayed.

Before specifying a server connection reference ensure that the required server connection has been created. See Adding a Server Connection on page 133 for details. During creation of adapter services, the default Outbound connection is used to configure connections requiring Outbound connection to the SAP system

Table 9 Adapter Instance - Run-Time Outbound Tab (Cont’d)

Field Description



Adapter Services TabThe following figure shows the Adapter Services tab.

Figure 13 Adapter Instance - Adapter Services Tab



The following table lists the fields in the Adapter Services tab.

Table 10 Adapter Instance - Adapter Services Tab

Field Description

The following are configurations for All Publication and Request-Response Invocation (One Way Only) Services:

Outbound TID Management

Select a TIDManagement mode from the list.

• Local: Select local TID Management when there is only one Outbound adapter instance receiving messages from the SAP system for a specific program ID.

Note: When Local is selected, you need to specify the TID file name in the displayed TID Filename field.

By default, the name of the TID file is tidFile.tid. See General Tab on page 152 for more details.

A TID file is used by the TID Manager to maintain state on the transaction IDs sent from the SAP system.

• Remote: Select Remote TID Management when more than one Outbound adapter instances receiving messages from the SAP system for a specific program ID.

Note: When Remote is selected, you need to configure related client information. See Outbound TID Management: Remote on page 56 for more details.

Valid Destinations (Publication Service Only)

The valid destinations only for Publication Service. 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 283 for details.

The following are configurations for All Subscription and Request-Response (One Way Only) Services:



Inbound TID Management Select a TIDManagement mode from the following list:

• None: Select None when there is no need to Inbound TID Managment.

• Local: Select local TID Management when only the adapter instance is being used.

Note: When Local is selected, you need to specify the file name of the TID file in the displayed TID Filename field.

By default, the name of the TID file is tidFileInbound.tid. See General Tab on page 152 for more details.

The specified TID file is used by the TIDManager to maintain state information on the transaction IDs sent from the SAP system.

• Remote: Select Remote TID Management when more than one Inbound adapter instances run in a load-balanced fashion.

Note: When Remote is selected, you need to configure related client information in the displayed fields.

See Inbound TID Managment: Remote on page 57 for more details.

Note: TIBCO ActiveMatrix Adapter for SAP 7.0 does not have the feature of the Inbound TID management. If you migrate a project from the version 7.0 of TIBCO ActiveMatrix Adapter for SAP to the version 7.1, the Inbound TID Management field is automatically specified with None.

Valid Destinations (Subscription Service Only)

The valid destinations only for Subscription Service. 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 283 for details.

Table 10 Adapter Instance - Adapter Services Tab (Cont’d)

Field Description



Outbound TID Management: Remote

The following figure shows the Adapter Service tab with the Outbound TID Management field set to Remote.

Figure 14 Adapter Instance - Adapter Services Tab, OutboundTID Management: Remote

The following table lists the fields in the Adapter Services tab with the Outbound TID Management field set to Remote.

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

Field Description

Shutdown all Outbound adapter services requiring TID management following timeout exception

Select this check box to suspend the connection to TID Manager when a timeout exception occurs.


TID Manager Client Retry Count The number of retries that the adapter makes connect to TID Manager. The default value is 3.

TID Manager Client Retry Interval The retry time interval in milliseconds. This setting is activated when the TID Manager server cannot be reached, default value is 30000ms.

TID Manager Client A TID Manager Client for adapter.

Ensure that the TID Manager client in all the adapter instances matches the TID Manager server in the TID Manager server being used. Also ensure that the subject name of the TID Manager client is configured appropriately and that the client and the TIDManager server are on the same transport.

When creating a client session manually, under the TIDManager Configuration, you need to ensure that you enter a value in the Invocation Timeout (ms) field that is greater than the default value 0. Otherwise, the messages are not deleted from the destination.



Inbound TID Managment: Remote

The following figure shows the Adapter Services tab with the Inbound TID Management field set to Remote.

Figure 15 Adapter Instance - Adapter Services Tab, InboundTID Management: Remote

The following table lists the fields in the Adapter Services tab with the Inbound TID Management field set to Remote.

Table 12 Adapter Instance - Adapter Services Tab, Inbound TID Managment: Remote

Field Description

TID Manager Client

A TIDManager Client for adapter.

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.

TID Manager Client Retry Count

The number of retries that the adapter makes to connect to TID Manager. The default value is 3.

TID Manager Client Retry Interval

The retry time interval in milliseconds. This setting is activated when the TIDManager server cannot be reached, default value is 30000 ms.

When creating a client session manually, under the TIDManager Configuration, you need to ensure that you enter a value in the Invocation Timeout (ms) field that is greater than the default value 0. Otherwise, the messages are not deleted from the destination.



General TabIn the General tab, you can configure the following:

• Termination Subject or Topic

• ActiveConnection Reference

• Plugin: Discovery Agent

The following figure shows the General tab.

Figure 16 Adapter Instance - General Tab

The following table lists the fields in the General tab.

Table 13 Adapter Instance - General Tab

Field Description

Termination Subject or Topic The termination subject or topic.

Once a message is sent to the termination subject or topic, the adapter stops.

The default termination subject is:%%Domain%%.%%Deployment%%.adr3.%%InstanceId%%.exit

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



ActiveConnections Reference The name of the active connection to be assigned to the adapter. Changing the reference of the active connection used by an adapter instance changes all client and server connections used by the adapter. So you can use an existing active connection without reconfiguring 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 Adapter_NameActiveConnections 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 Adding a Connection Reference on page 123 for details on setting connection references.

Discovery Agent In TIBCO ActiveMatrix Adapter for SAP, the Discovery Agent can be configured as a plug-in in the adapter. See Chapter 13, Advanced Topics, on page 227 on how to configure the plug-in for the Discovery Agent for runtime adapter.

Enabled Select this check box to enable the plug-in for the Discovery Agent.

Polling Cilent Reference A client endpoint that has been created for this transport.

Polling Interval This polling interval is used by the Discovery Agent as the interval for polling the available list of SAP application servers. The default value is 60000 ms.

Polling Publisher Reference A publisher endpoint that is created for this transport.

Application Server Domain Name

The name of application server domain.

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



Logging TabThe following figure shows the Logging tab.

Figure 17 Adapter Instance - Logging Tab

The following table lists the fields in the Logging tab.

Table 14 Adapter Instance - Logging Tab

Field Description

Use Advanced Logging Select this check box to use customized logging options.


To add custom log sinks, select this check box and configure log sink resources for the adapter instance in the Advanced folder. See Configuring Advanced Logging Options for an Adapter Instance on page 228 for more information.

Log to Standard I/O Select this check box to send the logging information to the console window when you start the adapter.

This check box is selected by default.

Logging information is displayed when you select this check box.



Log File File to which the 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, the 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 29 for details on how to define and use global variables.

Log Info Messages Select this check box to send all messages of type INFO to the specified locations.


For when to turn on this option, see Guidelines for Turning on the Log Levels on page 62.

Log Debug Messages Select this check box to send all messages of type DEBUG to the specified locations.



Log Warning Messages Select this check box to send all messages of type WARNING to the specified locations.



Log Error Messages Select this check box to send all messages or type ERROR to the specified locations.



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 selected. 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.

The following figure shows an example of a log file.

Figure 18 Sample Outbound Log File



Startup TabThe following figure shows the Startup tab.

Figure 19 Adapter Instance - Startup Tab

The following table lists the fields in the Startup tab.

Table 15 Adapter Instance - Startup Tab

Field Description

Show Startup Banner Select this check box to display a startup banner when the adapter is started.

This check box is selected by default

The startup banner displays the runtime adapter version, the infrastructure version on which the adapter is built and the copyright information in the console window when the adapter is started.

Metadata Search URL Location where the adapter searches for base schemas. The adapter searches for any schema that is defined and saved at this location, and that needs to be loaded at startup.

This field is predefined and cannot be changed.



Monitoring TabThe folling figure shows the Monitoring tab.

Figure 20 Adapter Instance - Monitoring Tab

The following table lists the fields in the Monitoring tab.

For more detailed information,see Chapter 12, Managing and Monitoring an Adapter Project, page 211.

Table 16 Adapter Instance - Monitoring Tab (Sheet 1 of 3)

Field Description

Enable Standard MicroAgent Select this check box to enable the standard TIBCO Hawk microagent.

Click , to switch the way of configuration between a standard check box and a text value (true or false) so that you can use a global variable.

The standard TIBCO Hawk microagent is enabled by default.



Standard MicroAgent Name The name for the standard microagent that is registered with the TIBCO Hawk system.

The default standard microagent name is: COM.TIBCO.ADAPTER.adr3.%%Deployment%%.%%InstanceI

d%%

You do not need to specify the InstanceId variable, because it is automatically set at run time by the runtime adapter.

Standard MicroAgent Timeout (ms) The timeout value for the standard microagent in milliseconds.

The default value is 10000.

Normally you do not need to change this value. However, when the timeout of an method invocation occurs on a machine under heavy load, you can increase the timeout value.

Enable Class MicroAgent Select this check box to enable the instance-specific or class-specific standard TIBCO Hawk microagent.

Click , to switch the way of configuration between a standard check box and a text value, true or false, so that you can use a global variable. By default, the input field is specified with the HawkEnabled global variable.

The instance-specific or class-specific standard TIBCO Hawk microagent is enabled by default.

Note:Use the global variable only when you need to specify the instance-specific or class-specific standard TIBCO Hawk microagent in one or more adapter instances at the same time.

Class MicroAgent Name The name for the class microagent that is registered with the TIBCO Hawk system.

The default class microagent name is:COM.TIBCO.adr3.%%Deployment%%.%%InstanceId%%

You do not need to specify the InstanceId variable, because it is automatically set at run time by the runtime adapter.


Field Description



Class MicroAgent Timeout (ms) The timeout value for the class microagent in milliseconds.



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 216.

R/3 Adapter MicroAgent Name The name for the custom microagent used to configure microagents specific to TIBCO ActiveMatrix Adapter for SAP. The name specified is 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 The type of the custom microagent.

Available options are:• Local

• Remote

The default type is Local.


Field Description






| 69

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 70

• Configuring an Adapter Service, page 79

• Transport Specific Options for Adapter Services, page 80

• Publication Service Configuration Reference, page 86

• Subscription Service Configuration Reference, page 97

• Request-Response Invocation Service Configuration Reference, page 106

• Request-Response Service Configuration Reference, page 111


70 | 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 70

• Adding an Adapter Service Manually, page 71

Adding an Adapter Service AutomaticallyTo add an adapter service automatically:P

1. In the Project panel, expand Project_Name > Adapter_Name > Adapter Services.

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 Fetch IDocs 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 Fetch RFC/BAPIs to download the list of RFCs or BAPIs according to the filter you provided.

See Adapter Services Configuration Reference on page 72 for more detailed information.

3. Select the schema and add the service:

— For Publication Service or Subscription Service After you fetch the schemas, the IDocs tab is displayed in the Configuration panel. The tab

It is recommended that you add an adapter service automatically.

To keep the schemas consistent, when a change occurs in the RFC schema of the SAP system, you need to refresh the those of the adapters, which communicate with this SAP system.


Adding an Adapter Service | 71

contains the list of IDocs available for selection. Select the IDocs in the IDocs tab and click Apply.

The IDocs schemas are retrieved from the SAP system and the adapter services associated with the schemas are automatically added.

— For Request-Response Invocation Service or Request-Response Service After you fetch the schemas, the RFC/BAPI tab is displayed in the Configuration panel. The tab contains the list of RFCs or BAPIs available for selection. Select the RFCs or BAPIs in the RFC/BAPI tab and click Apply.

The RFCs or BAPIs schemas are retrieved from the SAP system and the adapter services associated with the schemas are automatically added.

See Adapter Services Configuration Reference on page 72 for more detailed information.

Adding an Adapter Service ManuallyTo add an adapter service manually:

1. In the Project panel, expand Project_Name > Adapter_Name > Adapter Services.

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. Select the schema for the adapter service:

— For Publication Service or Subscription Service In the Schema tab, click Select IDoc. A list of IDocs is displayed in a new window. Choose an IDoc from the list by selecting the Used check box for that IDoc and clicking OK.

— For Request-Response Service or Request-Response Invocation Service

In the Schema tab, click Select RFC/BAPI. A list of RFC/BAPI is displayed in a new window. Choose an RFC or BAPI from the list by selecting the Used check box for that IDoc and clicking OK.

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.

It is recommended that you select the Used check box only when the IDocs or RFC/BAPIs are in use.



Adapter Services Configuration ReferenceWhen adding an adapter service automatically, you can refer to the following information:

• Configuration Tab on page 72

• IDocs Tab on page 74

• RFC/BAPI Tab on page 76

Configuration Tab

The following figure shows the Configuration tab.

Figure 21 Adapter Services - Configuration Tab


Table 17 Adapter Services - Configuration Tab

Field Description

IDoc Filter The 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*

RFC/BAPI Filter The 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.



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 the RFC/BAPI group.

For example: set the RFC/BAPI Filter field as /* and leave the RFC Group Filter field blank and vice versa.

• Fetch the namespace by filtering the RFC/BAPI or the RFC/BAPI group.

For example: set the RFC/BAPI Filter field as /SAPTRX/* and leave the RFC Group Filter field blank and vice versa.

Leave either the RFC/BAPI Filter or the RFC/BAPI Group Filter field blank when you click Fetch RFC/BAPIs. The default value * 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 is replaced with __SLASH__ at design time and saved to project with this name.

At run time, the adapter replaces the __SLASH__ with the / character in all its interactions with the SAP system.

For example: the RFC /tibco/MY_CUSTOM_RFC is interpreted in the TIBCO environment as __SLASH__tibco__SLASH__MY_CUSTOM_RFC.

This applies to parameters referred to by the BAPI/RFC also.

RFC/BAPI Group Filter The 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 field as * and specify a value in the RFC Filter field.

Custom Folder The directory for the downloaded schema. If you want to download the schema to a specific folder, specify a directory in this field. If you do not specify this field, the schema is downloaded to a predefined location.

Table 17 Adapter Services - Configuration Tab (Cont’d)

Field Description



IDocs Tab

The list of IDocs displayed depends on the SAP logon language provided in the Design-Time Connection tab in the adapter instance. Only those IDocs maintained in the SAP logon language are displayed. If the IDocs are not listed, ensure that these IDocs exist in the SAP system.

If an SAP logon language other than English, French, Italian, Danish, Dutch, Norwegian, Portuguese, Spanish, Finnish, and Swedish is in use, it does not ensure that the description of the IDoc is incorrect.

The following table 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 75, and the Release 3.x?, see Table 20 on page 75.

The following figure shows the IDocs tab. The IDocs displayed are retrieved with the Release 4.x? IDocs filter.

Figure 22 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



The following table lists the fields in the IDocs tab when the IDocs are retrieved from a 4.x SAP system.

The following table 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 The basic IDoc type in the SAP system.

Extended Type The extended IDoc type in the SAP system.

Description The description of the IDoc in the SAP system.

Used Select this check box to select the IDoc schema to be downloaded and for appropriate adapter services to be created.


Operation Type This value depends on the connection type of the adapter instance.

Available options are: • Outbound

• Inbound

• Both

Release 4.x? Select this check box to download IDoc schema using 4.x schema.


Release 3.x? Select this check box to download IDoc schema using 3.x schema.

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

Field Description

IDoc Type The basic or extended IDoc type in the SAP system.

Description The description of the IDoc in the SAP system.

Used Select this check box to download the IDoc schema and to create appropriate adapter services.



RFC/BAPI Tab

You can select the required RFCs or BAPIs in the RFC/BAPI tab.

The following figure shows the RFC/BAPI tab.

Figure 23 Adapter Services - RFC/BAPI Tab

Operation Type This values depend on the connection type of the adapter instance.

Available options are: • Outbound

• Inbound

• Both

TIBCO ActiveMatrix Adapter for SAP 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



The following table lists the fields in the RFC/BAPI Tab.

Table 21 Adapter Services - RFC/BAPI Tab

Field Description

Name The name of the RFC or BAPI. To obtain information about the parameters available in the RFC or BAPI, expand the node of this field. For field information on these types, expand the node of the parameter, if the parameter pertains to a structure, denoted by “struct”, or table, denoted by “sequence”.

Type The type of the BAPI.

Direction The direction of the BAPI parameter.

Available options are:• In

The parameter is an Import parameter and the direction is In.• Out

The parameter is an Export parameter and the direction is Out.• In/Out

The parameter is a Table and the direction is In or Out.

Used Select this check box to download the RFC/BAPI schema and to create appropriate adapter services.

Operation Type This value depends on the connection type o the fadapter instance.

Available options are:• Inbound

• Outbound

• Both



Invocation Protocol Select the appropriate Invocation Protocol in order to create an adapter service for a particular RFC or BAPI.

Available options 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 . You can invoke the BAPI/RFC in the SAP system without waiting for a reply from the system by using the 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 | 79

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 80.

• 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 86

— Subscription Service Configuration Reference, page 97

— Request-Response Invocation Service Configuration Reference, page 106

— Request-Response Service Configuration Reference, page 111



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 are available.

This section explains the transport types and the transport specific service configuration options that are common to all services:

• Transport Type and Related Configuration Option, page 80

• Wire Format, page 82

• Delivery Mode (JMS Only), page 83

• Connection Factory Type (JMS Only), page 84

• Quality of Service (Rendezvous Only), page 84

Transport Type and Related Configuration OptionAfter selecting the transport type, you can configure the transport specific options:

• Transport Types, page 80

• Secure Transport, page 81

Transport Types

Two transport types are available for the runtime adapter:

• JMS, page 80

• Rendezvous, page 81

JMS

JMS indicates that Java Messaging Service transport mode is used by the service. An adapter service that uses the 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 82.


Transport Specific Options for Adapter Services | 81

• Delivery Mode The delivery mode for the message. See Delivery Mode (JMS Only) on page 83.

• Connection Factory Type The type of the client connection to the TIBCO Enterprise Message Service server. See Connection Factory Type (JMS Only) on page 84.

For more detailed information, see TIBCO Enterprise Message Service User’s Guide.

Rendezvous

Rendezvous indicates that TIBCO Rendezvous transport mode is 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 82.

• Quality of Service The quality of service for publishing messages. See Quality of Service (Rendezvous Only) on page 84.

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 the Secure Sockets Layer (SSL) configuration. TIBCO Rendezvous sessions and JMS sessions have an SSL configuration field that uses a dialog to perform the SSL configuration.

To enable and configure the SSL:

1. In the Project panel, expand Adapter_Name > Advanced > Sessions. Click the TIBCO Rendezvous session or JMS session.

2. In the Configuration tab, select the Use SSL check box.

3. To do further configuration, click Configure SSL.

See the online help associated with the session dialog or "Managing Trusted Certificates" in TIBCO Designer User’s Guide for the SSL configuration options.

If the JMS SSL configuration is not specified correctly, the Undefined Gvars tab with the RuntimeCertificatesDirectory global variable is displayed when you run the adapter tester in TIBCO Designer for the service you configure.

If you want to use the SSL certificates from an external directory through global variables, see Using SSL Certificates from an External Directory, page 249 for detailed information.



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 82

• Rendezvous Message (TIBCO Rendezvous Only), page 82

• XML Message, page 82

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.

Services must use the same transport type and wire format to exchange data.



Delivery Mode (JMS Only)For JMS transport, different delivery modes are available for different services:

• For Publication Service and Request-Response Invocation Service, page 83

• For Subscription Service and Request-Response Service, page 83

For Publication Service and Request-Response Invocation Service

For a Publication Service or a Request-Response Invocation Service, the following delivery modes are supported:

• Persistent The message is available to a JMS client even if the JMS server goes down.

• Non-persistent The message is not available to a JMS client if the JMS server goes down.

For Subscription Service and Request-Response Service

For a Subscription Service or a 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 84 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 has been down and recovered, it receives the messages that arrived at the JMS server while the service has been 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 has been down and recovered, it does not receive the messages that arrived at the JMS server while the service has been 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 84

• Queue, page 84

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 84

• Reliable, page 85

• Distributed Queue (Subscription Service and Request-Response Service Only), page 85

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 is 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 is 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.

If the same IDoc must be published in different modes, a separate Publication Service is required for each mode. In cases where the publish mode is not explode, the service still needs to be associated with an IDoc although the IDoc schema is not used. For details on publish mode, see Identifying Publication Mode on page 90.

You can configure Publication Service parameters under the following tabs:


• Schema Tab, page 95

• Advanced Tab, page 95

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.

Depending on which transport type you choose, you can choose one of the following sets of configuration:

• Transport Type: JMS, page 87

• Transport Type: Rendezvous, page 89


Publication Service Configuration Reference | 87

Transport Type: JMS

The following figure shows the Configuration tab for JMS transport.

Figure 24 Publication Service - Configuration Tab - Transport Type: JMS

The following table lists the fields in the Configuration tab for JMS transport.

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

Field Description

Name The name of the Publication Service.

The default name is PublicationService.

Transport Type The type of the message transport used by the service.

See JMS on page 80 for details.

Wire Format The format in which messages are sent.

Available option is:• XML Message

For integrating two SAP systems, the wire format and transport type for both the publisher and subscriber must be the same, otherwise an error occurs.

See Wire Format on page 82 for details.



Publish Mode The publication mode.

Available options are:• explode

• none

• exploded batch

• IDocFormat

See Identifying Publication Mode on page 90 for details.

Delivery Mode The delivery mode of the message.

Available options are:• Non-Persistent

• Persistent

See Delivery Mode (JMS Only) on page 83 for details.

Connection Factory Type

The type of client connection to the TIBCO Enterprise Message Service server.

Available options are:• Queue

• Topic

See Connection Factory Type (JMS Only) on page 84 for details.

Table 22 Publication Service - Configuration Tab - Transport Type: JMS (Cont’d)

Field Description



Transport Type: Rendezvous

The following figure shows the Configuration tab for Rendezvous transport.

Figure 25 Publication Service - Configuration Tab - Transport Type: Rendezvous

The following table lists the fields in the Configuration tab for Rendezvous transport.

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

Field Description

Name The name of the Publication Service.

The default value is PublicationService.


See Rendezvous on page 81 for details.

Wire Format The format in which messages are sent.

Available options are:• ActiveEnterprise Message

• Rendezvous Message

• XML Message

For integrating two SAP systems, the wire format and transport type for both the publisher and subscriber must be the same, otherwise an error occurs




Identifying Publication Mode

You can configure the publish mode by selecting one option from the Publish Mode list. The following section describes each available mode in detail:

• None Mode, page 90

• Explode Mode (Default), page 92

• Exploded Batch Mode, page 93

• IDocFormat Mode, page 93

None Mode

In the default interface mode, the IDoc output from an SAP system is processed in the native RFC table format. This compressed 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 step is left for the stage when the data is actually consumed.

IDocs of SAP System Releases 3.x and 4.x, which is 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.

Publish Mode The appropriate publication mode.

Available options are:• explode

• none

• exploded batch

• IDocFormat


Quality of Service The type of Quality of Service for publishing messages.

Available options are:• Reliable

• Certified

See Quality of Service (Rendezvous Only) on page 84 for details.

Table 23 Publication Service - Configuration Tab - Transport Type: Rendezvous (Cont’d)

Field Description



For SAP releases 4.x, an 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)

The following figure shows a truncated example of the 4.x IDoc data transmitted in the default “unexploded” 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 26 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. The following figure 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 TIBCO Adapter SDK Concepts.

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.

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 27 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.

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.

IDocFormat Mode

In IDocFormat mode, no transformation is performed in the IDoc content. The IDoc is presented in a original string format. See the following figure.

Only IDocs of SAP System Release 4.x is supported. The IDoc contains the following records:

• EDI_DC (one control record)

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.



• IDocMsg (multiple data records)

Similar to Expode mode, only one IDoc is exchanged per message. When you send multiple IDocs from SAP system or TIBCO environment in one call, each IDoc is sent individually.

If the Transport Type is JMS, the control fields are also passed as JMS properties. The property name consists of the prefix, SAPIDOC_ and the IDoc control record field. For example, if the field is DOCNUM, the corresponding JMS property is SAPIDOC_DOCNUM.

Figure 28 IDoc in Untransformed "String" Format

If the Transport Type is Rendezvous, the Rendezvous Message wire format is not supported.



Schema TabThe following figure shows the Schema tab.

Figure 29 Publication Service - Schema Tab

Advanced TabThe following figure shows the Advanced tab.

Figure 30 Publication Service - Advanced Tab

The following table lists the fields in the Advanced tab.



Table 24 Publication Service - Advanced Tab

Field Description

Message Subject The subject name to use by default when the adapter publishes messages.

This item is shown only when Rendezous is selected as the transport type.

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 The name on which the service publishes messages to a topic or sends messages to a queue when you set advanced options for a Publication Service.

This item is shown only when JMS is selected as the transport type.

Endpoint Reference The endpoint to be used by the Publication Service.

Class Reference The class referenced in this Publication Service.

Log IDoc: Destination The destination of the IDoc logging file. The Outbound IDoc can be sent to a Rendezvous or JMS endpoint or written to a file.

Available options are:• Log to file

• Publish message

Log IDoc: Format The format of the IDoc logging file.

This item is shown only when you select Log to file from the Destination list.

Available options are:• None

• XML

Log IDoc: Log IDoc to Directory The directory to log IDoc files. If you do not specify this field, the IDoc is logged to the current working directory of the adapter or the directory specified in the TRA property of adr3.idocLogDirectory.


Subscription Service Configuration Reference | 97

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 type of the 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 31 Subscription Service - Configuration Tab - Transport Type: JMS


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

Field Description

Name The name of the Subscription Service.

The default value is SubscriptionService.



Wire Format The format in which you can send messages.

The available option is: • XML Message





Receive IDOCs in Exploded Batch Mode

Select this check box to receive IDocs in exploded batch mode.



Receive IDOCs in IDocFormat Mode

Select this check box to receive IDocs in IDocFormat mode.




Available options are:• Non-Durable

• Durable

This item is shown only when Topic is selected as the connection factory type.



The client connection type to the TIBCO Enterprise Message Service server.


• Topic


Table 25 Subscription Service - Configuration Tab - Transport Type: JMS (Cont’d)

Field Description





Figure 32 Subscription Service - Configuration Tab - Transport Type: Rendezvous


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

Field Description

Name The name of the Subscription Service.

The default value is SubscriptionService.




Available options are:• ActiveEnterprise Message

• Rendezvous Message

• XML Message





Receive IDocs in Exploded Batch Mode

Select this check box to receive IDocs in exploded batch mode.



Receive IDOCs in IDocFormat Mode

Select this check box to receive IDocs in IDocFormat mode.


See Identifying Publication Mode on page 90 for detail.



• Certified

• Distributed Queue


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

Field Description

For an IDoc received as TIBCO Rendezvous 5.x message, the wire format must be Rendezvous Message.




Figure 33 Subscription Service - Schema Tab


Figure 34 Subscription Service - Advanced Tab




Table 27 Subscription Service - Advanced Tab (Sheet 1 of 3)

Field Description

Destination The name on which the service publishes messages to a topic or sends messages to a queue when you set advanced options for a Subscription Service.




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.

Endpoint Reference The endpoint used by the Subscription Service.

Class Reference The class referenced in this Subscription Service.



Confirm Required Select this check box to publish the IDoc confirmation message report once the SAP system receives the IDoc.


An IDoc confirmation message report can include:

• Track Information of the message received

• Business Key of the message received

• Transaction ID generated by SAP system when receiving the IDoc

• IDoc number and status generated by the SAP system

By default, the adr3.idocNumAndStatusIncluded property is set to ON, which indicates the IDoc number and status are included in the IDoc confirmation message report. And this configuration is only available to the tRFC protocol.

Note:

• If the Subscription Service receives IDocs in exploded batch mode, the IDoc confirmation message report only reflect the first received IDoc. The statuses of all the IDocs in a batch cannot reflect the actual statuses of the IDocs in the SAP system.

• If this checkbox is selected and the adapter works with the remote EMS server, you need to specify the following properties:— adr3.msgReportQueue.serverUrl

— adr3.msgReportQueue.userName

— adr3.msgReportQueue.password

Otherwise, the adapter tries to connect to the local EMS server when you start the adapter.

• If the Inbound partner profile of the IDoc is configured as immediate processing, depending on when the IDoc processing is completed in the SAP system, the IDoc status is different.

Confirm Publisher reference The publisher of IDoc confirmation message report.

This item is shown only when the Confirm Required check box is selected.


Field Description



Log IDoc: Destination The destination of the IDoc logging file. The Inbound IDoc can be sent to a Rendezvous or JMS endpoint or written to a file.

Available options are:• Log to file

• Publish message

Log IDoc: Format The format of the IDoc logging file.

This item is shown only when you select Log to file from the Destination list.

Available options are:• None

• XML (Default value)

Log IDoc: Log IDoc to Directory

The directory to log IDoc files.

If you do not specify this field, the IDoc is logged to the current working directory of the adapter or the directory specified in the TRA property of adr3.idocLogDirectory.

Client Connection Reference The 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 Browse Resource to locate the client connection reference.

Thread Count The number of threads.

This number cannot be less than 1, which is the default. You can specify the number of dispatcher threads for the service in the Thread Count field.

Thread Count supports Global Variables.

qRFC Queue Name The name of qRFC queue.

You can specify the Inbound IDoc as qRFC by using this field. If left blank, the Inbound IDoc is tRFC. You can configure the Subscription adapter service by 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.


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 the transport type, the type of Quality of Service and the invocation protocol to use for the Request-Response Invocation Service.

Depending on your choice of transport type, you can choose one of the following sets of configuration:



Transport Type: JMS


Figure 35 Request-Response Invocation Service - Configuration Tab - Transport Type: JMS


Request-Response Invocation Service Configuration Reference | 107


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

Field Description

Name The name of the Request-Response Invocation Service.

The default value is Request-ResponseInvocationService.








Available options are:• Non-Persistent

• Persistent





• Topic






Figure 36 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous


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

Field Description

Name The name of the Request-Response Invocation Service.

The default value is Request-ResponseInvocationService.




Available option is:• ActiveEnterprise Message




Request-Response Invocation Service Configuration Reference | 109


Figure 37 Request-Response Invocation Service - Schema Tab



• Certified


Table 29 Request-Response Invocation Service - Configuration Tab - Transport Type: Rendezvous (Cont’d)

Field Description




Figure 38 Request-Response Invocation Service - Advanced Tab - Transport Type Rendezvous


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

Field Description



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 The name on which the service publishes messages to a topic or sends messages to a queue when you set advanced options for a Request-Response Invocation Service.


Endpoint Reference The endpoint to be used by the Request-Response Invocation Service.

Class Reference The class referenced in this Request-Response Invocation Service.


Request-Response Service Configuration Reference | 111

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 the transport type, the type of Quality of Service and the invocation protocol to use for the Request-Response service.




Transport Type: JMS


Figure 39 Request-Response Service - Configuration Tab - Transport Type: JMS




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

Field Description

Name The name of the Request-Response Service.

The default value is Request-ResponseService.








Available options are:• Non-Durable

• Durable

This item is shown only when Topic is selected as the connection factory type.





• Topic






Figure 40 Request-Response Service - Configuration Tab - Transport Type: Rendezvous


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

Field Description

Name The name of the Request-Response Service.

The default value is Request-ResponseService.




Available option is:• ActiveEnterprise Message






Figure 41 Request-Response Service - Schema Tab



• Certified

• Distributed Queue

If you invoke the service by using Request/Reply invocation protocol, you must select Reliable from the Quality of Service list. If you invoke the service by using One Way invocation protocol, you must select Certified from the Quality of Service list. If the adapter instance is Load-Balanced with other similarly configured Inbound instances, you must select Distributed Queue from the Quality of Service list.


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

Field Description

If the SAP system needs a response from the adapter, you must set the invocation protocol as Request/Reply. If no reply is needed, set the invocation protocol as One Way.

In the case of One way, the schema used by the Request-Response server cannot have any OUT parameters since receiving a reply is not applicable.




Figure 42 Request-Response Service - Advanced Tab - Transport Type: Rendezvous


Table 33 Request-Response Service - Advanced Tab - Transport Type: Rendezvous (Sheet 1 of 4)

Field Description



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 The name on which the service publishes messages to a topic or sends messages to a queue when you set advanced options for a Request-Response Service.


Endpoint Reference The endpoint to be used by the Request-Response Service.

Note: In the case of Oneway RFCs, if an error occurs when invoking SAP, the original message sent can be forwarded to a Rendezvous or JMS endpoint by using the Endpoint Reference field.



Class Reference The class referenced in this Request-Response Service.


Field Description



Confirm Required Select this check box to publish the IDoc confirmation message report once the SAP system receives the IDoc.

This check box is shown only when the invocation protocol of the Request-Response Service is set to One Way.


An IDoc confirmation message report includes:

• Track Information of the message received

• Business Key of the message received

• Transaction ID generated by SAP system when receiving the IDoc

When the message report being sent relates to an IDoc, the message report has the following characteristics:

• The message report is consistent with the report returned by the Subscription Service.

• IDoc number and status generated by the SAP system can be included in the message report if required.

By default, the adr3.idocNumAndStatusIncluded property is set to ON, which indicates the IDoc number and status are included in the IDoc confirmation message report. And this configuration is only available to the tRFC protocol.

Note:

• If this checkbox is selected and the adapter works with the remote EMS server, you need to specify the following properties:— adr3.msgReportQueue.serverUrl

— adr3.msgReportQueue.userName

— adr3.msgReportQueue.password

Otherwise, the adapter tries to connect to the local EMS server when you start the adapter.

• If the Inbound partner profile for the IDoc, being sent to the SAP system, is configured as immediate processing, depending on when the IDoc processing is completed in the SAP system, the IDoc status is different.


Field Description



Confirm Publisher reference The publisher of IDoc confirmation message report.

This item is shown only when the Confirm Required check box is selected.

Log Rfc: Endpoint Reference The endpoint to be used by log RFC.

The transport type needs to be JMS or RV.

Client Connection Reference The 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 Browse Resource to locate the client connection reference.

Thread Count The number of the threads.

This number 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.

For a Request-Response Service using invocation protocol One Way, if the LogRfc: Endpoint Reference field 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.


Field Description


| 119

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 120

• Adding an Active Connection, page 123

• Adding a Client Connection, page 125

• Adding a Server Connection, page 133


120 | Chapter 7 Configuring an Adapter Connection

Adapter Connection Configuration Overview

Each time you create an adapter instance, a set of connections is created by default under the R3Connections folder.

Different types of connections are grouped in different folders. See the following figure.

Figure 43 Adapter Connection - R3 Connections Folder

There are three types of adapter connections:

• Active Connection

Only when you associate an adapter instance with an active connection referring to a client and server connections, the adapter instance can use the client or the server connection to communicate with the SAP system.

• Client Connection

Inbound adapter instances only use the client connection to set up connection to the SAP system.

• Server Connection

Outbound adapter instances only use the server connection to set up connection to t heSAP system.

For more detailed information on the adapter connections, see the following table.

When you select Both from the R/3 Connection Type list, the choice between the client connection or the server connection depends on the adapter service.


Adapter Connection Configuration Overview | 121

The following table lists the detailed information on the adapter connections:

Table 34 Adapter Connection Type

Connection Type Description

Active Connection A connection referring to a client and server connections.

When you create an adapter instance, the reference relationship between the active connection and the client and server connections is created automatically.

Client Connection A connection to a SAP application client.

There are three types of client connection:

• Dedicated Application Server

• Load Balancing

• SNC

When you create a client connection, a client is also created in the Clients folder by default.

The adapter which supports a client connection pool is referenced by one or more Inbound adapter services.

Additional client connections are required when an Inbound adapter instance needs to set up connection to mutiple SAP application clients. Each client needs its own connection.

In order to validate each client connection pool in the adapter, an automatic check is performed on the startup of the adapter.



You can directly configure the connections created by default for use or add new connections for adapter instances.

For detail information on adding connections, see:

• Adding an Active Connection, page 123

• Adding a Client Connection, page 125

• Adding a Server Connection, page 133

Server Connection A connection to a SAP application server.

There are two types of server connection:

• Default

• SNC

You can create the server connection pools by configuring the properties specific to the Discovery Agent.

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.

Multiple server connections are required when an Outbound adapter instance needs to connect to multiple Gateway Host servers or connect to SAP system using multiple Program IDs. See Multiple Connections on page 261 for details on multiple Program IDs.

Table 34 Adapter Connection Type (Cont’d)

Connection Type Description


Adding an Active Connection | 123

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.

To add and configure an active connection:

1. In the Project panel, expand Project_Name > R3Connections. Drag the ActiveConnections icon from the Palette panel to the Design panel.

2. Specify the name and the description of the active connection in the Configuration tab. Click Apply.

3. After creating an active connection instance, tie references from the active connection to the required client and server connection. See Adding a Connection Reference on page 123.

Adding a Connection ReferenceYou can add a connection reference to associate a particular client or server connection inside an active connection. When creating an adapter instance, two default connection references are created within the active connection. One reference points to a client connection created by default and the other reference points to a server connection created by default.

To add a connection reference:

1. In the Project panel, expand Project_Name > R3Connections > Adapter_NameActiveConnections.

2. Drag the ConnectionReference icon from the Palette panel to the Design panel.

3. In the Configuration tab, enter a name for the connection reference in the Name field.

4. To select a client or server connection, click the Select a Resource icon.

Create client connections and server connections before creating connection references. See Adding a Client Connection on page 125 and Adding a Server Connection on page 133 for details.



5. (Optional)To set the referenced connection as the default connection, select the Default Connection check box.

6. Click Apply.

Assigning an Active Connection to an AdapterA default active connection instance is created when you create an adapter instance. By default, a reference point to the active connection is also created in the adapter instance.

If you require a different active connection, you must set up an appropriate reference in the adapter instance.

To associate an adapter instance with an active connection reference:

1. In the Project panel, expand Project_Name > Adapter_Name.

2. Click the General tab in the Configuration panel.

3. Browse to select the required active connection. Click OK, and then click Apply.

You can only set one connection as a default for one particular type. If you changed the default connection references to the connection manually created , once you reopen your project the default connection references is reset to the ones before you made the change.

It is recommended that you associate one instance with one active connection.


Adding a Client Connection | 125

Adding a Client Connection

When you create an adapter instance, a client connection of the Dedicated Application Server type is created by default. You can configure the client connection for use or add new client connections of any type.

To add a client connection:

1. In the Project panel, expand Project_Name > R3Connections > ClientConnections.

2. Drag the ClientConnection icon from the Palette panel to the Design panel.

3. In the Configuration tab, select a client connection type from the Select ClientConnection Type list. Click Apply.

4. Define the options in the Run-Time Inbound and Advanced tabs. See Client Connection Configuration Reference on page 125. Click Apply.

5. Select the client corresponding to the client connection created under the Clients folder. Define the options in the Configuration and Advanced Tabs. See Client Configuration Reference on page 131. Click Apply.

Client Connection Configuration ReferenceDepending on the client connection type you selected, the runtime configurations of the client connection are different.

Configure the client connection according to the following information:

• Runtime Configurations for Dedicated Application Server

• Runtime Configurations for Load Balancing

• Runtime Configurations for Secure Network Connection

• Advanced Tab

The options in Advanced Tab are still the same for all types of client connections.

When you rename a client connection, if you want the name of the related client resource to keep consistent with the client connection, you need to rename it.



Runtime Configurations for Dedicated Application Server

When Dedicated Application Server is selected as the client connection type, the runtime configuration is as described in the following table.

Table 35 Client Connection - Dedicated Application Server - Run-Time Inbound Tab

Name Description

Application Server The machine that hosts SAP applications.

System Number SAP system number.


User Name The valid user name that logs on to the specified SAP client.


R/3 Logon Language The language used by the adapter to set up connection to the SAP system.




Test Connection Click this button to test the connection of your configuration.

Note: For every client connection pool, you need to do a connection test in order to validate the configuration. If the connection is invalid, an error occurs during the startup of adapter.



Runtime Configurations for Load Balancing

When Load Balancing is selected as the client connection type, the runtime configuration is as described in the following table.

Table 36 Client Connection - Load Balancing - Run-Time Inbound Tab

Name Description

System Name The SAP/R3 system ID used in conjunction with the load balancing connection.

For example, to use the load balancing connection, 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.

Msg Server The message server in conjunction with the load balancing connection.

For example, SAPSVR.

Logon Group The SAP logon group in conjunction with the load balancing connection. For example, PUBLIC.

In the SAP system, names of logon groups are case sensitive.

When starting multiple adapter instances using the same SAP logon group, you need stagger the start times for adapter instances.


User Name The valid user name that logs on to the SAP client.







Note: For every client connection pool, you need to do a connection test in order to validate the configuration. If the connection is invalid, an error is shown during the startup of the adapter.



Runtime Configurations for Secure Network Connection

When SNC is selected as the client connection type, the runtime configuration is as described in the following table.

For more information on SNC parameters, see Working with Secure Communication on page 159 or go to the documentation website of SAP.

Table 37 Client Connection - SNC - Run-Time Inbound Tab

Name Description

Application Server The machine hosting SAP applications.

System Number SAP database instance number.

SNC Mode SNC activation indicator.

Set the value to 0 to disable the SNC connections.

Set the value to 1 to enable the SNC connections.

SNC Partnername SNC name of the communication partner, which is an application server.

SNC QOP Quality of protection.

Set the value to 1 to apply authentication only.

Set the value to 2 to apply integrity protection.

Set the value to 3 to apply privacy protection.

Set the value to 8 to apply the default protection.Set the value to 9 to apply the maximum protection.

SNC Lib The library of the external security product.


User Name The valid user name logs on to the specified SAP client.

Password The valid password corresponds to the user name.

R/3 Logon Language

The language used by the adapter to set up connection to the SAP system.

R/3 Code Page The character sets used by SAP and database.





Advanced Tab

The advanced configuration is as described in the following table.


Note:

• For every client connection pool, you need to do a connection test in order to validate the configuration. If the connection is invalid, an error occurs during the startup of the adapter.

• When testing a SNC client connection after a successful connection test within the same TIBCO Designer session, you also can receive a successful confirmation even though the connection parameters are incorrect. To avoid this situation, it is recommended that you close the project and reopen the project.

Table 37 Client Connection - SNC - Run-Time Inbound Tab (Cont’d)

Name Description

Table 38 Client Connection - Advanced Tab

Name Description

Maximum number of Reconnect Attempts The maximum number of times the adapter retries 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) field. 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.



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.

Select When All Pools Are Suspended to stop the adapter when all pools are suspended.

Select Any Pool Is Suspended to stop the adapter when any pool is suspended.

The default setting is When All Pools Are Suspended.

Note: If there is only one server connection pool and it is set to “When All Pools Are Suspended", the adapter stops.

Max Connections The number of SAP connections in the client connection. By default, it is set to 1. The maximum number is 99, subject to limitations in the SAP system.

Note:

• When you specify the number of SAP connections, which is contained in a client connection, you need to consider the number of threads configured in all the Inbound adapter services using the client connection. To achieve maximum throughput from the adapter, the number of SAP connections need to equal the number of required concurrent messages. These messages are processed across all the Inbound adapter services.

• When you set the Max Connections field to 0, you can start the adapter without any errors.

Disable Connection Pooling Select this check box to disable the connection to SAP system after the call to the SAP system is completed for a certain time.

Table 38 Client Connection - Advanced Tab (Cont’d)

Name Description



Client Configuration ReferenceConfigure the Configuration and the Advanced tabs according to the following information:

• Configuration Tab

• Advanced Tab

Configuration Tab

The following table lists fields in the Configuration tab.

Table 39 Client - Configuration Tab

Name Description

Name The name derived from the client connection instance associated with this client.

Description The description of the client.

Client SAP client number. This number must exist in the SAP system.

User Name A valid user name to log on to the SAP client specified.







Advanced Tab

The following table lists fields in the Advanced tab.

Table 40 Client - Advanced Tab

Name Description

RFC Trace RFC trace activation Indicator.




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/versio

n_number.

Use SAPGUI SAP GUI activation Indicator.

Set the value to 0 to disable SAP GUI to carry out debugging of RFCs.

Set the value to 1 to enable SAP GUI to carry out debugging of RFCs.

Set the value to 2 to enable SAP GUI to carry out debugging of RFCs until used by an invocation of an RFC.


Note:

• When attaching the SAP GUI 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, the adapter can generate an error message during startup.

• It is recommended that you install the SAP GUI on the same machine as the adapter.

If other values are entered into the fields in the Advanced tab, an error message appears. If a valid value is not provided, the original value is used.


Adding a Server Connection | 133

Adding a Server Connection

When you create an adapter instance, a server connection of Default type is created by default. You can configure this connection for use or add new server connections of any type.

To add a server connecton:

1. In the Project panel, expand Project_Name > R3Connections > ServerConnections.

2. Drag the ServerConnection icon from the Palette panel to the Design panel.

3. In the Configuration tab, select a connection type from the Select ServerConnection Type list. Click Apply.

4. Define the options in the Run-Time Outbound and Advanced tabs. See Server Connection Configurations on page 133. Click Apply.

Server Connection ConfigurationsDepending on the server connection type you select, the runtime configurations of the client connection are different.

Configure the server connection according to the following information:

• Default Server Connection Configuration Reference

• Secure Network Connection - Server Configuration Reference

• Advanced Tab

The options in Advanced Tab are the same for all types of client connections.

Default Server Connection Configuration Reference

When Default is selected as the client connection type, the runtime configuration is as described in the following table.

Table 41 Server Connection - Default - Run-Time Outbound Tab

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 261.

Gateway Service SAP gateway service. The default value is SAPgw00.



The adapter supports automatic retries for server connection pools if the adapter fails to connect to the SAP system. If the number of retries has been exhausted, the server connection pool is suspended or the adapter is stopped.

Secure Network Connection - Server Configuration Reference

When SNC is selected as the client connection type, the runtime configuration is as described in the following table.

For more information on SNC parameters, see Working with Secure Communication on page 159 or go to the documentation website of SAP.

Gateway Host Gateway Host name, IP address, or router string.

If there is no machine acting as a gateway host, this field is specified as the application server.

RFC Trace RFC trace activation indicator.



By default the value is 0.

Note: If any other values are entered, an error is displayed. If you do not provide a valid value, then it defaults to 0.

Table 41 Server Connection - Default - Run-Time Outbound Tab (Cont’d)

Name Description

Table 42 Server Connection - SNC - Run-Time Outbound Tab

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 261.

Note: If the Program ID is incorrect, after the adapter is started, there is no error messages. The validation process is based on the combination of Gateway Host and Gateway Service.

Gateway Service SAP gateway service. The default value is SAPgw00.



Gateway Host 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.

SNC Mode SNC activation indicator.

Set the value to 0 not to apply SNC to connection.

Set the value to 1 to apply SNC to connection.

SNC QOP Quality of Protection.




Set the value to 8 to apply the default protection.

Set the value to 9 to apply the maximum protection.

SNC Myname The SNC name of the initiator.

SNC Lib The library of external security product.

RFC Trace RFC trace activation indicator.

Set the value to 0 to disable the RFC trace.

Set the value to 0 to enable the RFC trace.

By default the value is 0.

Note:

• If you enter any other value, an error occurs. If you do not provide a valid value, then it defaults to 0.

• When you disable the RFC trace, the CPIC Trace file also can be created. The creation of the CPIC Trace file depends on the settings in the SAP system.

Table 42 Server Connection - SNC - Run-Time Outbound Tab (Cont’d)

Name Description



Advanced Tab

The fields in the Advanced tab are as described in the following table.

Table 43 Server Connection - Advanced Tab

Name Description

Maximum time between two startup attempts in case of failures (secs)

The maximum time interval used to reconnect to the Gateway Host for the adapter. 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 second

— Second 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 60th second

After the seventh startup, the adapter 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.

Select When All Pools Are Suspended to stop the adapter when all pools are suspended.

Select Any Pool Is Suspended to stop the adapter when any pool is suspended.

The default setting is When All Pools Are Suspended.

Note: If there is only one server connection pool and it is set to “When All Pools Are Suspended“, the adapter stops.



Max Connections The number of SAP connections in a server connection.

By default, it is set to 1. The maximum number is 99, subject to limitations in SAP system.

Note: When you specify the number of SAP connections, which is contained in a server connection, you need to consider the number of connections defined in SAP transaction SMQS for the RFC Destination corresponding to the program ID. To achieve maximum throughput from the adapter, the number of SAP connections need to equal the number of connections defined in SAP transaction SMQS.

Table 43 Server Connection - Advanced Tab (Cont’d)

Name Description




| 139

Chapter 8 Configuring TIDManager Options

Topics

• Introduction of TIDManager Configuration, page 140

• Adding a TIDManager, page 143

• TID Manager Configuration Reference, page 144

• Adding a TIDManager JMS Session, page 154


140 | Chapter 8 Configuring TIDManager Options

Introduction of TIDManager Configuration

The Transaction Identification Manager (TIDManager) is used to ensure exactly-once delivery for the transaction data between the SAP system and the adapter. The TIDManager guarantees that no transactional data is duplicated in case of communication errors between the adapter and the SAP system.





Mutiple Subscription service configurations (for IDoc) or Request-Response Service configurations (for tRFCs) run in a load-balanced fashion.

Outbound instances 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 for the transaction data from the SAP system or TIBCO environment.

Interactions between the Adapter and the TIDManager Server ConfigurationAfter the adapter is set for the remote TID Management 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 the transaction 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 Adapter_Name > Advanced > Sessions > TIDManagerSession folder in the Project panel is correctly configured in the General tab for each adapter instance. See Adapter Services Tab on page 53 for details on setting RPC client reference.

The subject of the TID_RPC_CLIENT service in the adapter instance needs to match that of the TID_RPC_SERVER service in the TID Manager. See General Tab on page 152.


Introduction of TIDManager Configuration | 141

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 emote TIDManagement.

Outbound TIDManagement

In case of the remote TIDManagement for Outbound configurations, if the TIDManager server is not running or it cannot be reached because of the network outages, the adapter displays the following errors upon receiving a transaction from the SAP system:2014 Sep 10 07:37:59:423 GMT -0700 R3AdapterConfiguration Error [Adapter] AER3-000102 TID operation timed out 6A785778253F540FC9030CDA

The transaction itself is not lost and it is maintained in the tRFC queue of the SAP system. The SAP system periodically tries to push out the transaction and clear the queue. If communication with the TIDManager server is restored, normal processing continues.

Inbound TIDManagement

In case of the remote TID Management for Inbound configurations, if the TIDManager server is not running or it cannot be reached because of the network outages, the adapter displays the following errors upon receiving an IDoc from the TIBCO environment:2014 Sep 10 07:28:27:057 GMT -0700 R3AdapterConfiguration Error [Adapter] AER3-000493 Remote TIDManager server unreachable

The AER3-000493 error is also published as a Hawk Notification that can be subscribed to from TIBCO Hawk.

The value specified in the TIDManager Client Retry Count field of the adapter instance determines the number of times the adapter tries to invoke the TID operation on the TIDManager server before concluding that the TIDManager server is indeed unreachable.

Transactions maintained in the tRFC queue are 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.



Once the TIDManager server is found to be unreachable, the Subscriber adapter cannot proceed with posting the IDoc. The IDoc cannot be confirmed to the sending application in the TIBCO environment as it results in message losses.

Hence, upon detection of this situation, the adapter suspends all its Subscription Services, does not confirm received IDocs to the TIBCO environment, and goes into a silent retry mode to try and reconnect to the TIDManager server. This is achieved by pinging the TIDManager server periodically. The adapter continues to remain in this suspended state till it establishes communication with the TIDManager server again.

The value specified in the TIDManager Client Retry Interval field of the adapter instance determines the time interval in milliseconds between any two ping attempts to the TIDManager server.


Adding a TIDManager | 143

Adding a TIDManager

To add a TIDManager:

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

2. Drag the TIDManagerConfiguration icon from the Palette panel to the Design panel.

3. In the Configuration tab, define the Instance Name field.

4. (Optional) To configure the options in General tab, select the ShowAll Tabs check box.

5. (Optional) To select the adapter runtime environment version from the What version do you want to change to list in the Chang Version window, click Change Version.

6. Define the options in the other tabs of the Configuration panel. See TID Manager Configuration Reference on page 144.

7. Click Apply.



TID Manager Configuration Reference

Configure the TIDManager according to the following information:

• Logging Tab, page 144

• Startup Tab, page 147

• Monitoring Tab, page 148

• General Tab, page 152

Logging TabThe following figure shows the Logging tab.

Figure 44 R3TIDManager - Logging Tab

The following table lists the fields in the Logging tab.

Table 44 R3TIDManager - Logging Tab (Sheet 1 of 3)

Field Description

Use Advanced Logging Select this check box to use customized logging options.


To add custom log sinks, select this check box and configure log sink resources for the adapter instance in the Advanced folder. See Configuring Advanced Logging Options for an Adapter Instance on page 228 for more information.


TID Manager Configuration Reference | 145

Log to Standard I/O Select this check box to send the logging information to the console window when the adapter is started.


Logging information is displayed when this check box is selected.

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 must change the name of the log file, adapter.log, if you intend to run multiple SAP TIDManagers.

You can use global variables to specify the location of the log file. See Working with Global Variables at Design Time on page 29 for details on how to define and use global variables.

Log Info Messages Select this check box to send all messages of type INFO to the specified locations.



Log Debug Messages Select this check box to send all messages of type DEBUG to the specified locations.




Field Description



Guidelines for Turning on the Log Levels

The log levels available are: Info, Debug, Warning, and Error messages. The type of logging message depends on the log level you select. Turning on the level can affect the performance of the adapter. It is recommended that you only turn on the required levels. 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.

The following figure shows an example of a log file.

Log Warning Messages Select this check box to send all messages of type WARNING to the specified locations.



Log Error Messages Select this check box to send all messages of type ERROR to the specified locations.




Field Description



Figure 45 Sample Outbound Log File

Startup TabThe following figure shows the Startup tab.

Figure 46 R3TIDManager - Startup Tab



The following table lists the fields in the Startup tab.

Monitoring TabThe following figure shows the Monitoring tab.

Figure 47 R3TIDManager - Monitoring Tab


Table 45 R3TIDManager - Startup Tab

Field Description

Show Startup Banner Select this check box to display a startup banner when the adapter is started.

This check box is selected by default

The startup banner displays the runtime adapter version, the infrastructure version on which the adapter is built and the copyright information in the console window when you start the adapter.

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.



Table 46 R3TIDManager Monitoring - Tab (Sheet 1 of 3)

Field Description

Enable Standard MicroAgent Select this check box to enable the standard TIBCO Hawk microagent.

Click , to switch the way of configuration between a standard check box and text value (true or false) so that you can use a global variable.

The standard TIBCO Hawk microagent is enabled by default.

Standard MicroAgent Name The name for the standard microagent that is registered with the TIBCO Hawk system.

The default standard microagent name is: COM.TIBCO.ADAPTER.adr3.%%Deployment%%.%%InstanceI

d%%

In most cases, keep the default value. You do not need to specify the InstanceId variable, because it is automatically set at run time by the runtime adapter.

Standard MicroAgent Timeout (ms) The timeout value for the standard microagent in milliseconds.



Enable Class MicroAgent Select this check box to enable the instance-specific or class-specific standard TIBCO Hawk microagent.

Click , to switch the way of configuration between a standard check box 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.

The instance-specific or class-specific standard TIBCO Hawk microagent is enabled by default.

Note:Use the global variable only when you need to specify the instance-specific or class-specific standard TIBCO Hawk microagent in one or more adapter instances at the same time.



Class MicroAgent Name The name for the class microagent that is registered with the TIBCO Hawk system.

The default class microagent name is:COM.TIBCO.adr3.%%Deployment%%.%%InstanceId%%

In most cases, keep the default value. You do not need to specify the InstanceId variable, because it is automatically set at run time by the runtime adapter.

Class MicroAgent Timeout (ms) The timeout value for the class microagent in milliseconds.



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 216.

R/3 Adapter MicroAgent Name The name for the custom microagent used to configure microagents specific to TIBCO ActiveMatrix Adapter for SAP. The name specified is displayed in the TIBCO Hawk monitoring console and the methods associated with the microagent are made available.

The default value is SAPAdapterMicroAgent.


Field Description



R/3 Adapter MicroAgent Type The type of the custom microagent.

Available options are:• Local

• Remote

The default type is Local.


Field Description



General TabThe following figure shows the General tab.

Figure 48 R3TIDManager - General Tab


Table 47 R3TIDManager - General Tab

Name Description

TID Manager Server

The reference of the TIDManager server.

To browse to locate the appropriate server endpoint, click Browse Resources.

To configure the RPC server, click Go To.

By default, an endpoint named TID_RPC_SERVER is provided for a TIDManager instance for messaging on TIBCO Rendezvous. For details on configuring a TIDManager server for JMS messaging, see Adding a TIDManager JMS Session on page 154.

By default, the subject name for the TIDManager Server Session is

SAP.TIDMANAGER. You can change the subject as appropriate. The subject must be unique for each TIDManager.

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 or to 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

The termination subject or topic.

A message sent to the termination subject or topic 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 contains "now" in the message content

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.

Table 47 R3TIDManager - General Tab (Cont’d)

Name Description



Adding a TIDManager JMS Session

An RV session named TIDManagerSession is created by default when a TID Manager is created.

You can configure this session for use or add a JMS session when the transport type is JMS.

To add a TIDManager JMS Session:

8. In the Project panel, expand TIDManager_NameTIDManagerConfiguration > Advanced > Session.

9. Drag the GenericSession icon from the Palettes panel to the Designer panel.

10. In the Configuration tab, select JMS from the Session Type list. Click Apply.

11. In the Configuration tab of the JMS session, define the options. See TIDManager JMS Session Configuration Reference on page 155.

12. Click TIDManager_NameTIDManagerConfiguration > Advanced > Session > JMSSession_name in the Project panel.

13. Drag the Server icon from the Palettes panel to the Designer panel.

14. In the Configuration tab of the server, define the Name, Description, Startup State, Endpoint Type and Subject fields. Click Apply.

Ensure that the subject assigned to the TID RPC Server matches the subject name of the TID RPC Client. This RPC client refers to the Subject field of the Configuration tab of TID_RPC_CLIENT server under the Adapter_Name > Advanced > Sessions > TIDManagerSession folder.

The subject name needs to match subject names used by TID_RPC_CLIENT references in all adapter instances using this TIDManager.


Adding a TIDManager JMS Session | 155

TIDManager JMS Session Configuration ReferenceThe following figure shows the Configuration tab.

Figure 49 TIDManager JMS Session - Configuration Tab

The following table lists the fields in the Configuration Tab.

Table 48 TIDManager JMS Session - Configuration Tab

Name Description

Session Type The type of the session.

Name The unique name for the TIDManager JMS Session.

Description The brief description of the TIDManager JMS Session.

Client ID The identification of the URL of the naming service provider and any other properties, such as the user name and password to authenticate the client to the service.

Leave this field blank. After you save the project, the client ID is automatically configured.

JNDI Lookups Select this check box to look up client ID through JDNI by using TIBCO Enterprise Message Service.




The connection factory type.


• Topic

If the JNDI Lookups check box is selected, this field name is changed to JNDI Conn. Factory Type, applicable drop-down list options stay the same.

Connection Factory Name

The unique name for the Connection Factory.

If the JNDI Lookups check box is selected then this field name is changed to JNDI Conn. Factory Name.

Connection Username The user name for the connection.

If the JNDI Lookups check box is selected then this field name is changed to JNDI Conn. Username.

Connection Password The password for the connection.

If the JNDI Lookups check box is selected then this field name is changed to JNDI Conn. Password.

Provider URL The URL for the JMS provider.

If the JNDI Lookups check box is selected then this field name is changed to JNDI Provider URL.

Provider Context Factory

The naming directory for the Provider Context Factory.

SSL Select this check box to use SSL to set up connection with the SAP system.

If this check box is selected, then you need to configure the %%JmsSslProviderUrl%% variable in the Global Variables panel.

Configure SSL... Only applicable once the SSL check box is selected.

If you want to use the SSL certificates from an external directory through global variables, see Using SSL Certificates from an External Directory, page 249 for more detailed information.

Table 48 TIDManager JMS Session - Configuration Tab (Cont’d)

Name Description


Adding a TIDManager JMS Session | 157

For more details on how to configure the Client ID and JNDI Lookups fields, see "Using the EMS Implementation of JNDI: Looking up Administered Objects Stored in EMS" in TIBCO Enterprise Message Service User’s Guide.




check boxTID | 159

check boxTID

Chapter 9 Working with Secure Communication

This chapter introduces functionality and configuration of the Secure Network Communication, SNC. The component provides secure communication between the TIBCO ActiveMatrix Adapter and the SAP system.

Topics

• Introduction of Secure Network Communication, page 160

• Setting Up SNC, page 161


160 | Chapter 9 Working with Secure Communication

Introduction of Secure Network Communication

You can use the Secure Network Communication, SNC, component for secure communication between TIBCO ActiveMatrix Adapter for SAP and the SAP system.

SNC provides the following three levels of security protection between the adapter and the SAP system:

• Authentication

• Integrity

• Privacy

For more information about SNC, see Secure Network Communications (SNC).

SAP Cryptographic Library for SNC The SAP Cryptographic Library is the default security product for performing encryption functions in SAP Systems. For example, you can use it for providing SNCs.

This chapter describes using the SAP Cryptographic Library for SNC. SAP Cryptographic Library provides the entire functionality defined in the standard interface of the GSS-API V2 (Generic Security Services Application Programming Interface Version 2).


http://help.sap.com/saphelp_nw70ehp1/helpdata/en/e6/56f466e99a11d1a5b00000e835363f/frameset.htm

Setting Up SNC | 161

Setting Up SNC

To set up the SNC in the SAP system and the TIBCO ActiveMatrix Adapter for SAP:

1. Install the SAP Cryptographic Library.

For the detailed information, see Install the SAP Cryptographic Library.

2. Set the Trust Manager Profile Parameters.

For more information, see Set the Trust Manager Profile Parameters.

3. Create a SNC PSE.

For more information, see Create a SNC PSE.

4. Set the SNC Parameters.

For more information, see Set the SNC Profile Parameters.

5. Install the SAP Cryptographic Library on the Adapter.

For more information, see Install the SAP Cryptographic Library on the Adapter, page 161.

6. Configure SNC for the connection between AS Java and AS ABAP.

For more information, see AS Java to AS ABAP.

7. Set the SNC Parameter Specific to an Inbound or Outbound Scenario.

For more information, see External Programs to AS ABAP Using RFC or RFC: TCP/IP Connection - Registered Program.

8. Set SNC in TIBCO Designer for the Adapter.

For more information, see Set SNC in TIBCO Designer for the Adapter, page 162.

Install the SAP Cryptographic Library on the AdapterTo install the SAP Cryptographic Library on the adapter:

1. Extract the SAP Cryptographic Library.

2. Copy the SAP Cryptographic Library file to a folder. Ensure you specify the SNC Lib field with the path of the folder in the SNC connection Configuration panel.

3. Create the SEC directory and copy the ticket file to this directory.

4. Set the SECUDIR environment variable to point to the sec directory.


http://help.sap.com/saphelp_nw73/helpdata/en/d9/e8a740bbaa4d8f8bee6f7b173bd99f/content.htm

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/19/164442c1a1c353e10000000a1550b0/content.htm

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/c3/d2281db19ec347a2365fba6ab3b22b/content.htm

http://help.sap.com/saphelp_nw73/helpdata/en/4d/a8410336831f8de10000000a15822b/content.htm

http://help.sap.com/saphelp_nw73/helpdata/en/4d/a8410336831f8de10000000a15822b/content.htm

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/49/236897bf5a1902e10000000a42189c/content.htm

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/3d/bf463c6796e61ce10000000a114084/content.htm

http://help.sap.com/saphelp_nw73ehp1/helpdata/en/07/03473cbff75b01e10000000a114084/content.htm


This parameter is set for the user that executes the adapter process. When deploying and running the adapter using TIBCO Administrator, ensure the SECUDIR variable is set and is available for the adapter process.

On Windows NT platforms, the SECUDIR variable is set in the adr3.tra for Unicode adapter files.

On UNIX platforms, the SECUDIR variable is set in the adr3_env.sh for Unicode adapter files.

If using the adapter tester, the SECUDIR variable is set in the adr3.tra for Unicode adapter.

Set SNC in TIBCO Designer for the Adapter Set SNC in TIBCO Designer for the adapter according to the following information:

• SNC Connection Configuration for the Outbound Adapter on page 162

• SNC Connection Configuration for the Inbound Adapter on page 163

SNC Connection Configuration for the Outbound Adapter

The following figure shows the runtime Outbound connection configuration in the TIBCO Designer.

Figure 50 Runtime Outbound Connection in TIBCO Designer

The following table lists the SNC parameters in TIBCO Designer to set SNC in TIBCO Designer for the adapter.


Setting Up SNC | 163

Table 49 Outbound SNC Parameters for TIBCO Designer

SNC Connection Configuration for the Inbound Adapter

The following figure shows the runtime Inbound connection configuration in the TIBCO designer.

Figure 51 Runtime Inbound Connection in TIBCO Designer

Parameter Description Required? Valid values Default Value

SNC MODE The SNC activation indicator Y 0,1

0 = SNC disabled

1= SNC activated

none

SNC QOP Quality of protection level N 1,2,3,8,9 3

SNC MYNAME The SNC name of the user sending the RFC.

N string The name provided by the security product for the logged-on user.

SNC LIB The path and file name of the gsSAPi library

Y string none



The following table lists the SNC parameters in TIBCO Designer to set SNC in TIBCO Designer for the adapter.

Table 50 Inbound SNC Parameters for TIBCO Designer

Parameter Description Required? Valid values Default Value

SNC MODE The SNC activation indicator Y 0,1

0 = SNC disabled

1= SNC activated

none

SNC Partnername The name of the communication 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 the gsSAPi library

Y string none

The adapter supports additional properties as the part of the SNC connectivity, but these properties are only available to the dynamic connection. See Associated Properties of Dynamic Connection on page 181.


| 165

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 166

• Activities for Communicating with Adapter Services, page 168

• Activity Configuration Tabs, page 170

• Mapping and Transforming Data, page 171

• Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services, page 174

• Testing a Process Definition, page 186


166 | 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.

The following figure shows the general procedure for developing a business process.

Figure 52 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 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 is displayed in the Design panel, with a Start activity 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 168 for detailed information.

Drag the activities from their palettes into the Design panel.

Configure the selected activities by clicking this activity and specifying the options available as tabs in the Configuration panel. See Activity Configuration Tabs on page 170 for detailed information.

5. Click transition 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 171 for detailed information.


Overview of Business Process Development | 167

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. The following table lists the adapter services and associated activities in the ActiveEnterprise Adapter palette.

For detailed information about when and how to use each of these activities, see

"ActiveEnterprise Adapter Palette" in TIBCO ActiveMatrix BusinessWorks PaletteReference.

Table 51 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.


Activities for Communicating with Adapter Services | 169

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 activities, and becomes the first activityin the process.



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 171 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 | 171

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 171

• Mapping and Transforming Process Data to Activity Input, page 172

• Mapping Data with Adapter Schemas, page 173

Activity Input TabUse the Input tab of an activity to supply the data that an activity expects as input.

The following figure shows the Input tab of an activity.

Figure 53 Input Tab of an Example Activity

In 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.

• 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 and Transforming Data | 173

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. The following table shows the schema usage in each activity.

See "ActiveEnterprise Adapter Palette" in TIBCO ActiveMatrix BusinessWorks Palette Reference for configuration options of each adapter activity.

To keep the schemas consistent, when a change occurs in the RFC schema of the SAP system, you need to refresh the those of the adapters, which communicate with this SAP system.

Table 52 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

This section introduces the details of mapping data for TIBCO ActiveMatrix Adapter for SAP services:

• For Subscription Service, page 174

• For Request-Response Invocation Service, page 175

• For Request-Response Service, page 176

• Data Type Mapping between the SAP System and Adapter, page 183

For Subscription ServiceWhen invoking a Subscription Service from TIBCO ActiveMatrix BusinessWorks, you need to use the Publish to Adapter activity as listed in Table 51 on page 168 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. 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. shows the SEGNAM property of one IDoc in the Input tab.

Figure 54 Segment Example in SAP System


Mapping Data for TIBCO ActiveMatrix Adapter for SAP Services | 175

Figure 55 IDoc SEGNAM Property in the Input Tab of the Publish to Adapter Activity

• tRFC If the SEGNAM property is left blank, the adapter automatically specifies the property by using the name from the AE Schema class and the format of the name is 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 specifies it using the segment definition, which is incorrect, and the sent IDoc fails the syntax check in the SAP system and remains 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 51 on page 168:

• 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 51 on page 168, 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 176

• RFCCLOSURE Properties, page 179

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 Apply.

2. Click the Input tab, as shown in the following figure.

When the Outbound adapter is invoked by the SAP system, any parameters not specified on the actual call cannot 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 cannot be initialized by the adapter.



Figure 56 Invoke an Adapter Request-Response Service Activity - Input Tab

3. Click the __caret__userClosure__caret_ element in the Activity Input panel and click Edit Statement. The Edit Statement window opens. See the following figure.

Figure 57 Edit Statement Window



4. Configure the schema for the selected element:

a. Click the Type tab and select the Type Substitution check box.

b. Click Browse Resource. The Select A Resource window opens.

c. 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 OK in the Select A Resource window.

f. Click OK in the Edit Statement window.

The following figure shows the Select A Resource window with the RFCCLOSURE class selected.

Figure 58 Select a Resource Window

5. Expand the __caret__userClosure__caret_ element in the Activity Input panel and specify the properties based on features that you want to use.

The following figure shows the expanded element with the RFCCLOSURE properties.

See RFCCLOSURE Properties on page 179 for a description of the properties.



Figure 59 __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 53 on page 179.

• For an Outbound adapter, see Table 55 on page 182.

• Properties that are not applicable, see Table 56 on page 183.

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 298 for more details.

Table 53 RFCCLOSURE Properties for an Inbound Adapter (Sheet 1 of 3)

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 fails.

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.

See Associated Properties of Dynamic Connection on page 181 for more information about associated properties of DynamicConnection.

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 is closed and all resources including the connection is 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 the TRA property adr3.contextTimeout, an error is returned.





snc_SSOsend SAP SSO log ticket that has been used to logn on to the SAP system.

bAutoCommit Only applicable for an Inbound adapter when the use of automatic commit is required.

Set the flag to true to enable automatic commit.



Table 54 Associated Properties of Dynamic Connection


useConnection Set the value to 0 to disable dynamic connection.

Set the value to 1 to enable dynamic connection.

connectionType Type of dynamic connection.

appServer The machine that hosts SAP applications.

systemNumber SAP database instance number.


userName Valid user name to log on to the specified SAP client.

password Valid password corrsponding to the user name.

msgServer Message server used for load balancing.

groupName Name of Logon Group in SAP system.

snc_mode SNC activation indicator.

Set the value to 0 to disable the SNC connection.

Set the value to 1 to enable the SNC connection.

snc_partnername SNC name of the communication partner, which is an application server.



snc_qop Quality of protection.




Set the value to 8 to apply the default protection.

Set the value to 9 to apply the maximum protection.

snc_lib The library of external security product.

snc_bSSO Request a SSO logon ticket from the SAP system.

snc_SSOrecv SAP SSO logon ticket.

snc_x509 x.509 certificate.

codePage The character sets used by SAP and database. The default value is 1100.

language Language used to log on to the SAP system. The selected language is only used in design time.

rfcTrace RFC trace activation Indicator.



useSAPGUI SAP GUI activation Indicator.

Set the value to 0 to disable SAP GUI to carry out debugging of RFCs.

Set the value to 1 to enable SAP GUI to carry out debugging of RFCs.

Set the value to 2 to enable SAP GUI to carry out debugging of RFCs until used by an invocation of an RFC.

Table 54 Associated Properties of Dynamic Connection (Cont’d)


Table 55 RFCCLOSURE Properties for an Outbound Adapter


TID The TID property is specified when the message originates from a transaction call.



Data Type Mapping between the SAP System and AdapterThe following table provides the mapping between the following data types:

• SAP data types used in the SAP system.

bTransaction

al

Set the bTransactional property to true when the message originates from a transaction call.

Note: Do not set the bQueue or qName property when using tRFC.

Table 55 RFCCLOSURE Properties for an Outbound Adapter (Cont’d)


Table 56 RFCCLOSURE Properties Not Applicable


GUID Not applicable.

packetSize Not applicable.

bUseCache Not applicable.

bMore Not applicable.

bLogoutAferCall Not applicable.

qCount Not applicable.

Note: For Inbound adapter services, when using the qRFC protocol, the qCount property does not work. Since the qCount property is assigned by the SAP system when the message is received by the adapter, you need to ensure that the messages are sent to the adapter in the required order and that the number of threads per adapter service is not greater than one.

bClearCache Not applicable.

cacheDirection Not applicable.

maxRowCount Not applicable.

currentRowCount Not applicable.

rfcBapiTimeout Not applicable.



• Data types used in TIBCO Designer.

• Java data types used by the runtime adapter.

Table 57 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

UNIT CHAR.X String

Table 57 Data Mapping between SAP Data Types and Adapter Data Types (Cont’d)

SAP Data Type AE Custom Schema Type Java Type



Testing a Process Definition

To test a process definition:

1. Save the project.

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 Set Breakpoints icon or in the menu bar press Alt + F8 to open the Set Breakpoints window.

b. In the window, select the check boxes 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 XPath Formula Builder icon to open the builder window and build a condition.

d. Click OK.

The following figure shows the Set Breakpoints window for a sample process with the breakpoints set before and after the Parse Vendor Input activity.

Figure 60 Set Breakpoints Window 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.


Testing a Process Definition | 187

5. Load and start one or more processes:

a. In the Tester panel, click Start Testing Viewed Process icon or press F9 to open the Select Processes To Load window.

b. Select the check boxes for the processes you want to load.

c. To start the processes, click Load Selected.

The following figure shows the Select Processes To Load window for project Sample with the Using JMS process selected.

Figure 61 Select Processes to Load Window 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.




| 189

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 190

• Starting TIBCO Administrator, page 195

• Creating an Application, page 197

• Changing Application Properties, page 200

• Deploying an Application, page 207


190 | 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 190

• Generating an EAR File in TIBCO Designer for a Project Using SSL, page 191

• EAR Configuration Reference, page 192

See 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 Apply.

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 the Advanced tab for the resource, then click Apply.

5. Create and configure the archives for other resources you want to add into the EAR file.

6. To create the archive file, click Build Archive.

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 click Tools > Create Project EAR, which creates the archive automatically for you.


Generating an EAR File in TIBCO Designer | 191

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.

To manually add the certificate folder to the EAR file:

1. In the Project panel, click the Shared Archive folder of the EAR file.

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 the following figure. Click Apply.

Figure 62 Select a Resource Window for Shared Archive

After you add the certificate folder in the Resources tab, the certificates included in the folder is displayed in the Dependencies (Resources) tab, as shown in the following figure.



Figure 63 Dependencies (Resources) Tab with the Certificate Folder

3. Select the EAR file in the Project panel and click Build Archive in the Configuration panel to rebuild the EAR file.

After the rebuild, the EAR file includes 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 193

• Adapter Archive Configuration Tab, page 194


Generating an EAR File in TIBCO Designer | 193

Enterprise Archive Configuration Tab

The following figure shows the Configuration tab of an Enterprise Archive resource.

Figure 64 Enterprise Archive - Configuration Tab


Table 58 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 is saved. Click Select a file from the file system to select a different file location from the default.

Include All Service Level Global Variables

Select this check box to include all global variables in the archive.



Adapter Archive Configuration Tab

The following figure shows the Configuration tab of an Adapter Archive resource.

Figure 65 Adapter Archive - Configuration Tab


Table 59 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 Browse resources and select the adapter you want to associate with the archive.

Note: You need to create a new Adapter Archive resource 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 resource that includes the class, so the class is in the class path.


Starting TIBCO Administrator | 195

Starting TIBCO Administrator

You must start the administration server and TIBCO Hawk agent before starting the TIBCO Administrator GUI.

To start TIBCO Administrator, you need perform the following tasks:

• Task A Start the Administration Server and TIBCO Hawk Agent, page 195

• Task B Start the TIBCO Administrator GUI, page 196

For more information about the 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:

• Under Microsoft Windows:

1. Start the administration server by invoking the following commands:% cd TIBCO_ADMIN_DOMAIN_HOME\domainName\bin

% tibcoadmin_domainName.exe

2. Start the TIBCO Hawk agent by invoking the following commands:% cd TIBCO_TRA_DOMAIN_HOME\domainName

% hawkagent_domainName.exe

• Under UNIX:

1. Start the administration server by invoking the following commands: % cd TIBCO_ADMIN_DOMAIN_HOME/domainName/bin

% tibcoadmin_domainName

2. Start the TIBCO Hawk agent by invoking the following command:% cd TIBCO_TRA_DOMAIN_HOME/domainName

% hawkagent_domainName



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 | 197

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 190 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 make do not have the desired result.

To create an application:

1. Click Application Management, a previously created folder or All Applications.

2. In the Application Management > All Applications window, click New Application. See the following figure.

Figure 66 Application Management > Application Management Screen

3. In the Upload EAR File window, click Browse and select an EAR file. Click OK.

4. In the New Application Configuration window, verify the information in the Application Archive panel, and specify options in the Application Parameters and the Services panels. See the following figure.



Figure 67 New Application Configuration Window

5. Click Save.

Application Creation Choices

The Services panel provides you the following choices when creating an application:

• If the Quick Configure check box is selected, the services are bound to the targets that you select in the target field.

• If the Quick Configure check box is selected, the Deploy On Save check box is enabled:

— If the Deploy On Save check box is selected, when you click Save, the application is created and immediately deployed to the target machines specified in the Target column of the Services panel. All variables, logging and other configuration values use defaults defined in the archive file. The Configuration Console displays the deployment status.


Creating an Application | 199

• If the Deploy On Save check box is clear, 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

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 has 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 200

• Tuning Performance Factors, page 201

• Working with Global Variables at Deployment, page 203

• Changing Adapter Properties, page 205

For more information about the 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 do the following tasks:

• Manage the properties of the application at the application level, service level, and service instance level.

• Perform the following deployment operations:

— Deploy and undeploy an application.

— Update an application.

— Revert a deployment: choose an earlier deployment configuration if there was one.

— View the deployment history.

To open the console, select the application from the Application Management module, All Applications in the Application Management module, or the folder which includes the application.

The console consists of two panels, Configuration Builder and Deployed Configuration. Each panel contains applications, service configurations, and service instances. The following figure shows the Configuration console.


Changing Application Properties | 201

Figure 68 Application Configuration Console

• Configuration Builder Use this panel 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 is added to the adapter and this affects the number of connections that is 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:

ApplicationService

Service Instance



• Heap Size

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 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, which is 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 about 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 203

• Precedence of Global Variables, page 204

See Working with Global Variables at Design Time on page 29 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 29 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 Edit Application Configuration window, click the Advanced tab and change the variable in the Global Variables panel.

— Service In the Edit Service Configuration window, click the Advanced tab and change the variable in the Runtime Variables panel.

Service level variables are only included in the service archive (AAR) file.

— Service Instance In the Edit Service Instance window, click the Advanced tab and change the variable in the Runtime Variables panel.



2. Click Save.

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 define the value for the RvServiceTest global variable as 7800, the variable is replaced with 7800 at run time.

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 run time.

• 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 run time, 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 run time, 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 Reset To Defaults 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 run time. For the adapter properties supported in TIBCO ActiveMatrix Adapter for SAP, see Appendix C, Adapter Properties File, on page 295.

This section gives an overview of how to change and use adapter SDK properties at deployment:

• Changing Adapter Properties, page 205

• Precedence of Adapter Properties, page 206

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 panel for the application.

2. In the Edit Service Configuration window, click the Advanced tab and change the variable value in the Adapter SDK Properties panel.

3. Click Save.

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 is used, unless they are overridden in a way that had higher precedence.

Click Reset To Defaults to reset all the adapter properties to the default values defined in the EAR file.



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.

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 the properties of an adapter 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/Domain_Name/application/ApplicationDeployment_Name 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 are 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 are lost if you redeploy the application.


Deploying an Application | 207

Deploying an Application

When you create an application, you can select the Deploy On Save check box 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 check box, 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 200 for details.

3. Click Deploy. The Deploy Configuration window opens. Use the dialog to add a description and specify the deployment options. See Deployment Choices on page 208 for details. The following figure shows the Deploy Configuration window.

Figure 69 Deploy Configuration Window

4. Click OK to deploy the application.

If you redeploy an application, all the current running services with configuration changes in this application are 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:



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:

• Click 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:


Deploying an Application | 209

• 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.




| 211

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 212

• Viewing Log File Information, page 214

• Configuring Monitoring Options for Using TIBCO Hawk, page 216

• Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator, page 218

• Monitoring a Service by Using TIBCO Hawk Display, page 222


212 | 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 212

• Starting and Stopping a Service Instance on page 213

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:

— Start a service instance.

— Restart a service instance.

— Stop a service instance.

— Kill a service instance.

To open the All Service Instances console, click 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.

The following figure shows the All Service Instances console.


Starting and Stopping a Service Instance | 213

Figure 70 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, select the check box 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 View Service Instance window, click the General tab. Click the clickable link next to the State field to start or stop the service instance.

• In the Application Management > Application_Name > Service Instances console, select the check box next to a service instance, and then click the appropriate buttons that are enabled.

• Explicitly start services after deployment. See Deployment Choices on page 208 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 of the application.

2. In the View Service Instance window, click the Tracing tab.

3. Select the log file from the File Is 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 Search. 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.

The following figure shows the Tracing tab of the View Service Instance window for a service instance.


Viewing Log File Information | 215

Figure 71 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 216

• (Optional) Defining a TIBCO Hawk Session, page 216

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, the TIBHawkNetwork, and the 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.

(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 in TIBCO Designer:

1. Expand Adapter_Name > Advanced > Sessions.

2. If you want to configure the default TIBCO Hawk session:

a. Click 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 parameters are not set properly, the microagents cannot be displayed in the TIBCO Hawk monitoring console.


Configuring Monitoring Options for Using TIBCO Hawk | 217

The following figure shows the Configuration tab for a TIBCO Hawk session.

Figure 72 TIBCO Hawk Session - Configuration Tab

3. 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 RV from the Session Type list. Click Apply.

c. Configure the session in the Configuration tab, which is similar to the Configuration tab shown in the previous figure.

In the Name field, enter the name previously assigned in the Default MicroAgent Session field under the Monitoring tab. See Monitoring Tab on page 64 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 cannot be displayed in the TIBCO Hawk monitoring console.

4. Click Apply and then Save.

See "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 405 for the microagent methods supported for TIBCO ActiveMatrix Adapter for SAP.

See also:

• TIBCO Hawk Plug-in For TIBCO Administrator 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.

The following figure shows the available methods of an adapter microagent displayed in the Microagent window from the Hawk console.


Monitoring a Service by Using TIBCO Hawk Plug-in for TIBCO Administrator | 219

Figure 73 Hawk Console - Microagent Window

Click the method you want to invoke. The Method window shows a Method panel with the detailed definition of the method and an Invocation panel for you to invoke or subscribe to the method.

The following figure shows the Method window for the getAdapterServiceInstance method of an adapter microagent.



Figure 74 Hawk Console - Microagent Window - Method Window

Enter the values in the Parameters fields and click Invoke to invoke the method. The method results is displayed.

You can also subscribe the method by selecting the Subscribe check box.

Adding a Rulebase to a ServiceThe TIBCO Hawk agent in the administration domain monitors manages 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 | 221

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 panel, click Add. The Upload Rule Base File window opens.

4. Click Browse and select a rulebase. Click OK and then Save.

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.

The following figure shows several alerts that have been generated based on a rulebase in the View Machine window.

Figure 75 Machine Console - View Machine Window



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 405 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, the TIBHawkNetwork, and the 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:

• Under Microsoft Windows:

— Click Start > All Programs > TIBCO > [ENV_NAME] > TIBCO Hawk [version_number] > Hawk Display.

— Invoke USER_HOME\ENV_NAME\tibco\cfgmgmt\hawk\bin\tibhawkdisplay.exe at a command prompt.

• Under UNIX:

Invoke tibhawkdisplay in a command console.


Monitoring a Service by Using TIBCO Hawk Display | 223

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 occurs. Select another agent, or contact your system administrator to obtain access.

The Microagents, Methods And Arguments window opens. The panel on the upper left lists microagents you can access on the current agent. The following figure shows the window.

Figure 76 Microagents, Methods and Arguments Window

2. Click a microagent name to display a list of associated methods and text descriptions in the bottom panel

Click the name of the method to invoke, for example, the getMicroAgentInfo method. If the method accepts arguments, fields for each argument are displayed in the upper right panel. Detailed help text is displayed in the lower panel. The following figure shows the method information for the getMicroAgentInfo method.



Figure 77 Microagents, Methods and Arguments Window - getComponentInfo Method

3. Specify any arguments for the method.

4. Click the Invoke radio button. To invoke the selected method, click the Invoke button. The displayed Invocation Results window shows the results returned by the method. The following figure shows the results of the getMicroAgentInfo method as an example.


Monitoring a Service by Using TIBCO Hawk Display | 225

Figure 78 Invocation Results - getComponentInfo Method

5. To close the window, click Done.




| 227

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 228

• Setting TIBCO Messaging Encoding, page 235

• Connecting with the SAP System, page 237

• Password Handling, page 243

• JMS Compression, page 244

• Fault Tolerance, page 246

• Using SSL Certificates from an External Directory, page 249

• Inbound BAPI Transactional Support, page 250

• Invoking BAPI/RFCs Using Transactional Semantics in SAP, page 255

• Multithreading, page 259

• Multiple Connections, page 261

• Event Driven Inbound Connections, page 269

• Connecting an Adapter Instance to Two SAP Systems with a Single Connection, page 272

• Using JMS Destination Bridges, page 274

• Saving an IDoc to a Directory, page 275

• Load Balancing Using Distributed Queue, page 277

• Configuring Valid Destinations, page 283


228 | 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 228

• Using Log4J for Logging, page 231

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:

• Using Basic Logging Features, page 228

• Using Advanced Logging Features, page 229

Using 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 60 for the options available in the tab.

By default, all the error, warning, and information messages are displayed in the console window where the configuration is started and stored in a default log file. You can locate the log file anywhere in your file system.

The adapter traces any sink in your adapter instance configuration. If you have the default STDIO and file sinks, the adapter writes to both the log file and standard I/O.

To log trace messages to the log file:

1. The adapter instance creates a file with no extension, using the file name specified in TIBCO Designer.

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.

Only errors that originate in the adapter instance itself are logged to 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 displayed in the console window where the configuration is started.


Configuring Advanced Logging Options for an Adapter Instance | 229

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 there are three log files.

5. The adapter instance overwrites the oldest file after three files have been created and the last file reaches 30 KB under the default settings.

For instructions on changing the default settings, see Using Advanced Logging Features.

Using Advanced Logging Features

When you select the Use Advanced Logging check box in the Logging tab, you can select the log sink destinations and associate desired roles with each of the destinations.

To access advanced logging features and configure the file sink for logging:

1. Select the Use Advanced Logging check box in the Logging tab, and then click Apply. The Logging tab displays the information as shown in the following figure.

Figure 79 Adapter Instance - Logging Tab for Advanced Logging

2. In the Project panel, expand adapter__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 80 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 the Debug level in the Log Sink folder. 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 sinks 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 the 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 216.

— 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 restart 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:

• Enabling Log4J for Logging, page 231

• Changing the Log Level of the Adapter, page 232

• Maintaining Logging at the Adapter Service Level, page 233

• Maintaining Logging at the Adapter Service Instance Level, page 233

Enabling Log4J for Logging

Specify the following TRA properties in TIBCO Administrator or in the TRA files to enable the adapter to use Log4J for logging:

• adr3.trace.extended ON.

• adr3.trace.log4j.properties Log4Jpropertiesfilename.

See Changing Application Properties on page 200 for how to change the properties at run time.

TIBCO ActiveMatrix Adapter for SAP provides a default Log4J properties file and template file for the adapter, TIDManager, and Discovery Agent respectively. The files are located in the TIB_ADR3_HOME/version_number/bin directory and contain the following lines. See the following figure.



Figure 81 Log4j Properties

Changing the Log Level of the Adapter

To effectively change log levels at run time, it is recommended that you select all the 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:

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.

To filter out specific trace messages, specify the log4j.appender.default.exclude property in the adapter Log4J properties file. Wildcards are not supported and multiple error codes are specified using comma as the delimiter.

To disable logging entirely, set the log level to OFF.



Maintaining 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.

To configure the Log4J logging at the adapter service level, in the Log4J properties file, add the following property for the required adapter service to specify the log level:

log4j.logger.com.tibco.SAP.adapter.services.AdapterServiceClassName=loglevel

The following table 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.SAPMessageRendererlog4j.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 behave in the same way and are set to INFO. All Publication Services are set to level ERROR. All Subscription Services are set to level DEBUG.

Maintaining Logging at the Adapter Service Instance Level

To set different log level for each service of an adapter instance:

1. In the TRA file, set the adr3.trace.service property to ON.

2. In the Log4J properties file, to specify the log level for each service of an adapter instance, add the following property:

Table 60 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.logger.com.tibco.SAP.adapter.services.SAPSubscriberImpl.AdapterServicename=loglevel

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 | 235

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 using Unicode. The data conversion is achieved in two separate phases, between 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 235

• Setting Encoding at Design Time, page 235

• Setting Encoding at Run Time, page 236

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 the following table.

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 you save the configurations of the project in a local project file, the TIBCO Messaging encoding is determined by the encoding property saved in the local project file.

To set the encoding option:

1. Start TIBCO Designer and open a project.

2. In the Configuration panel, click the root project folder in the Project panel, then click the Project Settings tab.

Table 61 TIBCO Messaging Encoding Options

Adapter Encoding Description

ISO8859-1 ISO8859-1 (Latin-1), West European

UTF-8 Unicode Transformation Format-8



3. Select the encoding value from the TIBCO Messaging Encoding list. See the following figure.

Figure 82 Setting TIBCO Messaging Encoding Options

Setting Encoding at Run TimeThe TIBCO administration server setting is used when the project is exported to a server repository or deployed by using TIBCO Administrator Enterprise Edition.

For a server-based project, the TIBCO messaging encoding is set by the repo.encoding property in the tibcoadmindomain_name.tra configuration file of the server, which is located in TIBCO_HOME\administrator\domain\Admin\bin.

The encoding is set by using the TIBCO Domain Utility to create the domain or by specifying 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 | 237

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 237

• Adapter Reconnection with the SAP System, page 238

• Adapter Connecting to Multiple Client Connection Pools, page 238

• Configuring Multiple Connections for Inbound Instance, page 238

• Configuring Multiple Connections for Outbound Instance, page 239

• Configuring SAP System for bgRFC, page 240

Managing the Connectivity with the SAP SystemAlthough you can continue to use the same connection parameters for the SAP server at design time and at run time, you also have the option to specify different design-time and runtime connection parameters. This ensures that you can switch from one SAP system to another by specifying different system details in the Design-time Connection, the Run-Time Inbound and the Run-Time Outbound tabs. Since the schemas are generated at design time using the server details specified in the Design-time Connection tab, the reference relationship is not broken if you change the SAP system details in the Run-Time Inbound and the Run-Time Outbound tabs. 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 Run-Time Inbound and the Run-Time Outbound tabs, and provide the values at run time or by using the TRA properties file of the adapter. This allows you to switch 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 clear the Use Design-time Connection For Run-time check box.

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 run time or by using the properties file of the adapter.



This ensures that the reference relationship of the schema is not broken when the runtime connection parameters of the SAP system are changed.

Adapter Reconnection with the SAP SystemThe adapter automatically tries to connect to the SAP Gateway server or client if any connection error occurs. If connection is not re-established within the maximum interval configured in the project, the corresponding server connection pool is suspended and the adapter is stopped if necessary. See Advanced Tab on page 129 of the client connection and Advanced Tab on page 136 of the server connection for configuration 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, when the service creates financial documents in the SAP system, the service requires a specific user ID.

— 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.

To add a client connection:

1. Configure an Inbound adapter instance.

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.



In the Project panel, expand Project_Name > R3Connections > ClientConnections to view the default client connection.

The name of the connection contains the name of the adapter instance. There is also 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, click the ClientConnections folder. Drag the ClientConnection icon from the Palette panel to the Design panel.

3. Select the Client connection type and click Apply.

4. Define the options in the Run-Time Inbound and the Advanced tabs. Click Apply.

5. Click Adapter_NameActiveConnections folder of the adapter instance. Drag the ConnectionReference icon from the Palette panel to the Design panel.

6. Enter an appropriate name in the Name field. Click Browse Resource to open the Select a Resource window.

7. Select the newly created client connection. Click OK to attach the client connection to this reference resource.

8. Click the Advanced tab of the adapter service for which this connection is created. In the Client Connection Reference field, click Browse Resource to open the Select a Resource window.

9. Select the client connection for this service and click Apply 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.

To add a new server connection:

1. Configure an Outbound adapter.

In the Project panel, expand Project_Name > R3Connections > ServerConnections to view the default connection. The name of the connection contains the name of the adapter instance. There is also a reference created for this connection in the ActiveConnections folder of that adapter instance. This is the default connection and you can modify the parameters of this connection if necessary.



2. Click the ServerConnections folder and drag the ServerConnection icon from the Palette panel to the Design panel.

3. Select the Server connection type and click Apply.

4. Define the options in the Run-Time Outbound and the Advanced tabs. Click Apply.

5. Click Adapter_NameActiveConnections folder of the adapter instance. Drag the ConnectionReference icon from the Palette panel to the Design panel.

6. Enter an appropriate name in the Name field. Click Browse Resource to display the Select a Resource window.

7. Select the newly created server connection. Click OK to attach the server connection to this reference resource.

8. Save and start the adapter instance.

Now whenever you start the adapter it acts as an RFCServer and create connections for all SAP application servers.

Configuring SAP System for bgRFCThe bgRFC transfer protocol provides a unified protocol between the SAP system and the adapter. It was originally introduced by the SAP system 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.

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 Create in the Configuration of RFC Connections page.

d. Enter applicable values according to your requirements into the RFC Destination page as the following figure shows.



Figure 83 RFC Destination Configuration

e. Click Yes in the Warning about selection of protocol window.

f. Click Save.

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 Display.

d. Select the BasXML supported check box on the Function Builder page as shown in the the following figure.

Figure 84 Function Builder Page


Password Handling | 243

Password Handling

At design time, the adapter uses a password to connect to the back-end application and fetch metadata. At run time, 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 298 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, select the Service check box 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 needs to be kept secret, you can set the password to type String and encrypt it.



JMS Compression

TIBCO Enterprise Message Service allows a client to compress the body of a message before sending the message to the server. JMS compression is specified for individual messages. It is especially useful when messages are stored on the server.

TIBCO ActiveMatrix Adapter for SAP provides three ways to set JMS compression:

• In TIBCO Designer, select the isCompressed check box in the Configuration tab of the JMS Publisher endpoint or JMS Rpc Client endpoint.

• In the TRA file of TIBCO ActiveMatrix Adapter for SAP, enable the following properties:

— tibco.sdk.session.jmsCompressed session_name: Specifies a list of JMS session names. All the JMS endpoints under the specified session, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

— tibco.sdk.endpoint.jmsCompressed endpoint_name: Specifies a list of JMS endpoints. All the specified JMS endpoints, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

• In the TRA file of TIBCO ActiveMatrix Adapter for SAP, add the property, adr3.<adapter_service_name>.jmsProperties JMS_TIBCO_COMPRESS=ON. Specify the name of the Publication Service. The value of ON indicates that the JMS compression for the Publication Service is enabled.

• In the TRA file of TIBCO ActiveMatrix Adapter for SAP, specify the following property:

The isCompressed check box is only shown in TIBCO Runtime Agent 5.8.0 or above.

Separate multiple session names or endpoint names with vertical bars.

This property is only available in the adapter TRA file.

If the JMS property, JMS_TIBCO_COMPRESS, is added in the TRA file, it takes precedence over the adr3.jmscompress property.


JMS Compression | 245

adr3.jmscompress ON : The default value is ON, which indicates that the JMS compression for the Publication Service enabled.

It is enough to use only one of these ways to set JMS compression. For example, when a Publication endpoint is set to be compressed in TIBCO Designer, the messages are compressed even if it is not set in the TRA file, and vice versa.

The Request-Response Service server replies to JMS messages depending on whether the request messages are compressed. If the request messages are compressed, the Request-Response Service server replies to the compressed JMS messages. Otherwise, the Request-Response Service server replies to messages according to the configuration in the TRA properties.

If the adr3.jmscompress property is set to ON, it takes precedence over the SDK properties added in the TRA file and the configuration in the TIBCO Designer in above ways.



Fault Tolerance

Fault Tolerance allows multiple adapter instances to substitute each other. When the primary adapter instance terminates unexpectedly, the token held by the primary instance is taken over by an adapter instance in the standby state. In the process of replacement, the standby adapter instance becomes the primary adapter instance.

Fault Tolerance is based on the JMS queue. Before enabling Fault Tolerance, you need to define a JMS queue and set the prefetch parameter of the JMS queue to none, and then put several JMS messages in the JMS queue as tokens. The number of tokens corresponds to the number of primary adapter instances.

The following diagram shows how Fault Tolerance works. At first, instance1 and instance 2 fetch one of the two tokens in the JMS queue respectively. They hold the tokens and process messages as primary instances. Instance 3 does not fetch tokens and runs in standby state. If instance 2 terminates unexpectedly, it releases the fetched token. Instance 3 fetches the token released by instance 2 and continues to process messages as primary instance.

• When a standby adapter instance becomes a primary adapter instance, it does not take the instance ID of the original primary adapter instance that terminated unexpectedly and still has its own instance ID.

• When running JMS topic as durable, durable names exist on EMS server for each receiver, regardless if adapter instance is primary or standby.


Fault Tolerance | 247

Figure 85 Fault Tolerance

When Fault Tolerance is enabled, the following two issues occur:

• If the number of tokens is more than 1, an exception is thrown in one of the following conditions:

— The transport type is RVCM.

— The transport type is JMS and the client ID is set value.

— The delivery mode is Durable in the Subscription Service and Request-Response Service.

• If the a primary EMS server switches to the standby state, all primary adapter instances that fetch tokens from the primary EMS server restart.

When Fault Tolerance is enabled, the following functionalities are not supported:

• Inbound transaction where the logical unit of work consisting of one or more RFC/BAPI calls.

• Inbound transaction where the logical unit of work consisting of one RFC/BAPI call and automatic commit is not enabled.

• Dynamic client connections to the SAP system from the Inbound adapter.



Enabling Fault Tolerance

To enable the fault tolerance, set the tibco.sdk.faultTolerance.ems.enabled property to ON, and set SDK fault tolerance properties accordingly. For more detailed information on the SDK fault tolerance properties, see Table 67, SDK Fault Tolerance Properties in TIBCO ActiveMatrix Adapter for SAP, on page 308.

You can also configure fault tolerance properties in TIBCO Designer and TIBCO Administrator.


Using SSL Certificates from an External Directory | 249

Using SSL Certificates from an External Directory

To use the SSL certificates from an external directory through global variables, complete the following steps:

1. Add the following property to the TRA file of TIBCO Designer.RuntimeExternalCertificatesFeature true

2. Add a global variable named RuntimeCertificatesDirectory, and then specify the value with the directory where the trusted certificates folder is located.

3. When configuring SSL in a JMS queue session, enter %%RuntimeCertificatesDirectory%% in the Trusted Certificates Folder field.

4. Configure all the related EMS information.

5. Start the adapter with latest configuration.

If you want to test whether certificates work normally at design time, follow these steps:

1. Create a folder in the project, and then import the certificates to the folder.

2. Specify the directory where the folder is located in the in the Trusted Certificates Folder field.

3. Click Test connection.



Inbound BAPI Transactional Support

The adapter supports one or more RFC/BAPI calls to be executed as a transaction or logical unit of work in the SAP system. The last RFC/BAPI call is used to commit the transaction or logical unit of work in the SAP system.

For the case where the transaction or logical unit of work consists of only one RFC/BAPI call, the adapter supports the feature of automatic commit. If the RFC/BAPI call does not return any errors, the transaction or logical unit of work can be committed.

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 the BAPI_TRANSACTION_COMMITServer instance.

To maintain the context for an individual BAPI invocation service, the Request-Response service for the BAPI transaction requires explicit commit 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.

When automatic commit is disabled, Inbound RFC/BAPI transaction support is available only when using a single adapter instance. For the support of multiple load-balanced adapters, the automatic commit feature is recommended.


Inbound BAPI Transactional Support | 251

See the following table for descriptions of the two BAPI transactions within the context of the SAP system.

Automatic CommitThe automatic commit executed by the adapter is done using the functional module BAPI_TRANSACTION_COMMIT and cannot be configurable.

To execute the automatic commit, one of the following conditions must be met:

• An EXPORT or TABLE parameter exists where the corresponding type is like BAPIRET% and the corresponding TYPE field is either “S” or blank.

• No ABAP or system exceptions are returned by the call.

By default, the bAutoCommit property is set to false.

To configure the automatic commit feature, the attribute bAutoCommit is set to true in the following steps:

1. Click the activity which you want to enable the automatic commit feature.

2. Expand the _caret_userclosure_caret_ element and set the bAutoCommit property to true. See the following figure.

Table 62 Description of BAPI Transaction

BAPI Transaction Name Description of Transaction Task

BAPI_TRANSACTION_COMMIT • Ends current transaction

• Commits changes

BAPI_TRANSACTION_ROLLBACK • Ends current transaction

• Discards changes



Figure 86 Invoke Request-Response Service Activity-Input Tab-bAutoCommit

For detail information about how to perform external commit, see"Dynamic Logon and External Commit" in TIBCO ActiveMatrix Adapter for SAP Example.

Related Transaction ConfigurationsThis section introduces related transaction configurations in Inbound transactions:

• Configuring Multiple Transactional RFC Calls, page 252

• Invoking Multiple RFC/BAPI Transactions as One Transaction in SAP, page 253

Configuring Multiple Transactional RFC Calls

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 176.

6. Provide the session ID from the first service output invocation to the input of the following service. Smilarly, provide the session ID of the second service, RFC_CLOSURE_DATA, as the input of the next service. Repeat this for all subsequent services.


Inbound BAPI Transactional Support | 253

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 Save to save the project.

Invoking Multiple RFC/BAPI Transactions as One Transaction in SAP

This section provides information on how multiple RFC/BAPI transactions in the SAP system can be treated as one transaction.

To invoke multiple RFC/BAPI Transactions as One Transaction:

1. Invoking the first RFC/BAPI transaction, see the following figure for example.

To start a transaction, the property bInTransactionContext in the RFCClosure class is set to true.

If the transaction requires a dynamic connection then you need to populate the properties in the DynamicConnection structure accordingly.

Set the contextTimeout property to a value accordingly. If the next RFC/BAPI transaction is not made within the time specified by the contextTimeout property then the transaction held inside the adapter would timeout and the resources tied up by the transaction are released.

Figure 87 Create Sales Order

2. Invoking the last RFC/BAPI transaction, see the following figure for example.

To invoke the next RFC/BAPI transaction, the session ID returned from the first RFC/BAPI transaction is passed on the RFCCLOSURE class. If the session ID is not passed on the call then a new transaction is created.

Similar to step 1, the property bInTransactionContext is set to true.

To mark the end of the transaction, the property bContextEnd is set to true.



Figure 88 Get Status

When the transaction feature is in use, the load balancing functionality of the adapter, RVCMQ and multiple instances of the adapter cannot be used.


Invoking BAPI/RFCs Using Transactional Semantics in SAP | 255

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.

To execute a one-way BAPI/RFC as a tRFC:.

1. Click the activity which you want to specify with this feature. See the following figure.

2. Expand the _caret_userclosure_caret_ element and set the bTransactional property to 1. See the following figure.

Figure 89 Invoke Request - Response Service Activity - Input Tab - Activity Input - tRFC

• When a BAPI/RFC is invoked as a tRFC, the TID is automatically generated by the adapter using the SAP system required.

• The TID must be unique in the tRFC and qRFC invocations.

• It is 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.



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.

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.

How to perform a qRFC invocation in the SAP system:

1. Click the activity which you want to specify with this feature.

2. Expand the _caret_userclosure_caret_ element and set the bQueue property to 1.

3. Specify the qName property with the name of the qRFC queue, in which the qRFC call is to be inserted. See the following figure.


Invoking BAPI/RFCs Using Transactional Semantics in SAP | 257

Figure 90 Invoke Request - Response Service Activity - Input Tab - Activity Input - qRFC.

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.

4. Click the activity which you want to specify with this feature.

5. Expand the _caret_userclosure_caret_ element and set the bQueue property to 1. See the previous figure.

This allows receiving systems in the TIBCO environment to recognize tRFC/qRFC invocations made by the Outbound adapter.

• The boolean property, bTransactional, determines whether or not the call must be invoked as a tRFC in SAP. The boolean variable, bQueue, determines whether or not the call must be invoked as a qRFC in SAP. They must not be set to 1 at the same time, or an error is generated.

For Inbound adapter services, when using the qRFC protocol, the qCount property is not supported. Since the qCount property is assigned by the SAP system when the message is received by adapter, you need to ensure that the messages are sent to the adapter in the required order and that the number of threads per adapter service is not greater than one.

For Outbound qRFC calls, the properties, qName and counter, associated to the message are not available in the RFCCLOSURE class.



Transferring IDoc through qRFCAn IDoc is transferred between the SAP system and TIBCO environment using qRFC invocation. Since the adapter sends the IDocs in a sequence, multiple threads and load balanced adapters cannot be used to enhance the performance of the adapter service.

For detal information about IDoc monitoring in SAP system, see IDoc Monitoring.

• 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.


https://help.sap.com/saphelp_nw70/helpdata/en/dc/6b815e43d711d1893e0000e8323c4f/content.htm

Multithreading | 259

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 sonnection pool is configured with Max Connections of three, there are three threads are available to receive messages from the SAP system. If the number of messages processed by the adapter needs to be increased, you need to adjust the Max Connections property accordingly. You can configure this property in one of the following ways:

• Expand Project_Name > R3Connections > ServerConnections. In the Advanced Tab, specify the Max Connections field.

• Set the number of threads through the adr3.maxconnections property in the adr3.tra file.

• Set the system:maxconnections argument on the command line.

It is recommended to specify the number of threads corresponds with the number of connections required.

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 Advanced Tab on page 136.

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, there are three threads available to receive messages from the JMS or RV destination. If the number of messages processed by the adapter service needs to be increased, 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 the load-balanced Distributed Queue or the 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, which have the same messaging transport configuration, 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 share all threads associated with that session. Even though each service has its own respective thread count, if the services share the same session, the full 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 prevents the adapter service from processing and sending the next message to the SAP system.


Multiple Connections | 261

Multiple Connections

The adapter can connect to multiple gateways or 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 the following figure 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 277 for details.

Figure 91 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 the following figure 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 277 for details.

Figure 92 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 Runtime environment installation. The following figure explains the steps involved in this dynamic discovery scenario, where gw1 and gw2 are the gateway hosts through which the SAP application servers communicate to the Outbound adapter.

Figure 93 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 91, Figure 92, and Figure 93.

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 configurations pick up the discovery message.

4. The Outbound adapter configurations register on the gateway hosts of discovered application servers.

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.

Configuration 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. You can deploy the project once you have followed these steps.

• 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 is downloaded, configure the necessary transport protocol and destination.

• Create a new session using the necessary transport protocol.

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.

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 is taken into effect.



• Using the new session , create 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, select the Enabled check box.

• In the Polling Client Reference field, enter the client that is created for the session.

• Specify the Polling Interval field accordingly. The default value is 60000 and it is maintained in milliseconds. This value is used by the 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.

• Specify the Polling Publisher Reference field with the publisher that is created for the session.

• Specify the Application Server Domain Name field accordingly. We recommend maintaining 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 58.

Running the Discovery Agent

You can start the discovery agent with the following command on the command line.adr3Discoverer --propFile adr3Discoverer.tra

Then specify the following values:

— tibco.repour <repourl>

— tibco.configurl <configurl>

The destination entered must match the destination maintained in the TRA property adr3.discovery.listenerSubject in the Outbound adapter instance.

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.



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 any 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 instance.

• adr3.discovery — Specify whether to enable the dynamic discovery feature.

The feature is commented by default. To enable the dynamic discovery feature, uncomment the property.

• adr3.discovery.pid — Specify program IDs on which to register the gateway of the discovered application server.

If the dynamic discovery feature is enabled, this is a mandatory property. An error occurs and then the adapter stops 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 — Specify the subject to be listened 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 — Specify the TIBCO Rendezvous or JMS session to use for the discovery listener.

A valid session by this name is available in the project.

Discovery Agent: The Outbound adapter log does not give any error when it establishes a connection to a Program ID sent by the discovery message, and this Program ID does not exist in the SAP System.



For example:adr3.discovery.listenerSession=MyDiscoverySession

If not specified, this property defaults to R3RVSession.

• adr3.discovery.maxconnections — 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 — 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 behaves in exactly the same way in both situations.

If an SAP Gateway server has been brought down because of a planned shutdown, it still continues 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 defaults 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 uses 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 277 for details.


Event Driven Inbound Connections | 269

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 Subscription services configured in the adapter makes use of connections created dynamically.

A dynamic connection may be created in one of the following ways:

— Based on logon parameters defined at design time

— Based on logon parameters passed at run time when explicit logon occurs

• If the Inbound adapter has set up the connection with a SAP system, there is no need to provide user ID and password each time when it needs to connect to other SAP systems under single sign-on using SNC.

Disabled Connection Pooling Inbound Configuration In 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 startup 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.

• The SAP systems must establish a trust relationship in case of single sign-on using SNC.

• 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.



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.

Configuration

To enable this feature, instruct the adapter not to establish connections on startup by clicking R3Connections > ClientConnections folder for the particular configuration and selecting the Disable Connection Pooling check box in the Advanced tab for each of the configured Client connections. For more information on the Advanced tab see Advanced Tab on page 129.

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 AESchemas/ae/SAPAdapter40/classes/Classes directory in the TIBCO Designer project. Depending on the information provided on the connection, the connection to the SAP system can either be a Dedicated connection, a 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 AESchemas folder in the Project panel. The path is as follows:AESchemas/ae/SAPAdapter40/classes/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 load balancing functionalities of the adapter, RVCMQ and multiple instances of the adapter cannot be used.


Event Driven Inbound Connections | 271

Single Sign-On Using SNCYou can set up connection with multiple SAP systems without providing the user ID and password by single sign-on, if the user ID already exists in those SAP systems and a trust relationship is established across the systems.

To enable single sign-on:

1. Click the activity which you want to specify this feature.

2. Expand the _caret_userclosure_caret_ element and set the bTransactional property to 1. See the following figure.

Figure 94 Invoke Inbound Adapter Service Activity - Input Tab - bTransactional

Single sign-on only supports the RPC server of the Inbound adapter in the SNC dynamic connection.



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 program ID 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 LCM SAP system. And 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 Display <-> Change (Ctrl + F1).

5. Enter the same values for the Gateway host and the Gateway service fields as the other SAP system, which is the CER SAP system.

6. Click Save.

7. Click Connection Test 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 | 273

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.



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 is:

[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 is configured with a JMS queue, the bridges.conf file is:

[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 | 275

Saving an IDoc to a Directory

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

• A Publication service or a Subscription service receives an IDoc whose destination is not in the list of valid destinations.

• A Subscription service configuration writes 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 can be manually changed in the file and replayed later using a TIBCO BusinessWorks process.

Configuring IDoc Logging DirectoryTo configure an IDoc logging directory:

1. Click the Advanced tab of your subscription service

2. From the Destination list, select Log to file.

3. From the Format 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 is 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 can be manually replayed if necessary. For more information, see Advanced Tab on page 102.

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.

Validation of the directory is not 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 previous precedencies:

1. TRA property adr3.IDocLogDirectory.

2. Log IDoc to Directory field in TIBCO designer project.

3. Current working directory.


Load Balancing Using Distributed Queue | 277

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 details on the subscription service options, see Transport Type: Rendezvous on page 100.

Configuration of Inbound load-balanced instances can be done either by:

• Create multiple Inbound instances where the CMQ names are the same across the instances.

• Create 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 clicking Help > Help for > Adapter Resources.

It is recommended that you have a good grasp of the following concepts 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 ConfigurationsTo 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 the following steps:

a. Click the Advanced tab of one of the Inbound services.

b. Click Go to referenced resource next to the Endpoint Reference field.

The Configuration tab for the endpoint reference displays.

See the following figure for the RVCMQ session linked to the endpoint reference, which the endpoint IDocCMQSubscriber-IDocInbound is linked to the RVCMQ session DefaultRVCMQSession. All the instances

Before changing the Quality of Service, make sure that no network sinks have a session reference, referring to the sefault 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 the CompleteTime property to a value greater than Zero.When the completeTime property is assigned Zero, the scheduler does not set a timer and does not reassign the 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 work group member.

For more information on RVCMQ parameters, see the TIBCO Rendezvous documentation.



need to have the same CMQ name to achieve load balancing using Distributed Queue.

Figure 95 Default RVCMQ Session

c. 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 of the session as shown in the following figure.

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.



Figure 96 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 are written to the same file.

1. In the project panel, expand Project_Name > Adapter_ Name > Advanced > Log Sinks > fileSink.

2. In the File Name field, enter %%LOG_FILENAME%%. It is assumed that this value is passed along with the tra file.

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.



Configuring Outbound Load-balanced InstancesThis section outlines the steps necessary to configure Outbound Load-balanced instances containing Publication services and Request-Response Invocation services.

You can configure the Outbound Load-balanced instance by using one of the following ways;

• Creating multiple Outbound instances using the same program ID for the server connections.

• 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:

1. In the Project panel, select your session and in the CM Name field enter %%PASSED_CM_NAME%%. The value of Ledger file is changed to reflect the usage of the same global variable. It is assumed that this value is passed along with the .tra file for the adapter instance.

2. To change the value of the file name for the file sink, in the Project panel, expand Project_Name > Adapter_Name.

In the Configuration panel, click the Logging tab and in the Log File field enter %%LOG_FILENAME%% global variable.

This change is 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

When creating multiple instances, make sure that the TIDManager client references the same remote TIDManager instance.

You cannot specify the File Name field for a file sink.

The global variable LOG_FILENAME is used to illustrate how to configure filenames at run time. Any unique client variable name can be used.



The files are created in the startDir which is by default the installation directory, for example c:\tibco\adapter\adr3\version_number.

For information on global variables, see TIBCO Repository Documentation.


Configuring Valid Destinations | 283

Configuring Valid Destinations

The Adapter Services tab can also be used to specify a list of destinations to which the IDocs are sent. This list of destinations applys to all IDoc types that are sent from the SAP system or to the SAP system. Typically, these destinations are logical SAP system names, but they can be a bank identifier, a customer identifier, or any partner type currently configured.

The RCVPRN field of a control record of an IDoc specifies the receiving partner for the IDoc. If the RCVPRN field of an IDoc has a value that is not configured as a valid destination, the IDoc is not published to the TIBCO environment. The IDoc is logged 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 275.

To configure valid destinations:

1. Ensure you have the publication or subscription services defined before configuring any valid destinations.

2. In the Adapter Services tab, specify the Valid Destinations field. For detailed information on Adapter Services parameters see Adapter Services Tab on page 53.

3. To add a new entry in the list, enter the name of the valid destination in the list separated by commas.

4. Click Apply.

As entries get saved, they are automatically converted to uppercase. This is done to ensure consistency with the syntax of logical systems in SAP.




| 285

Appendix A Frequently Asked Questions

This appendix lists answers to the frequently asked questions.

Topics

• Frequently Asked Questions


286 | 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 the SAP system 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 the SAP system. This dues to network overload, glitches or some transient network problems. To verify this issue, you can try to connect the SAP system from the SAP GUI installed on the same machine on which an error occurs.

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 adapter 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. This flag has to be set to 1 or 2 during adapter configuration. See Adding a Client Connection on page 125 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 need to 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 | 287

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 needs to be deleted and recreated with a new IDoc.

If the change in IDoc does not disturb the mapped parameters then the mappings are not affected. For example, if you add additional fields to an existing segment.

In your mappings you are 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 is 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 the SAP system by setting RFC trace to 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 277.

How can I use the Load Balancing feature of the adapter on the Outbound side?

For Outbound Load balancing, use TIDManager to configure. To set up TIDManager, during the adapter instance configuration, in the Adapter Services tab of the Adapter Instance select Remote from the Outbound TID Management list. For more information on this configuration, see Configuring TIDManager Options on page 139. Ensure 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 can see a banner giving you the adapter version and patch level. When you open TIBCO Designer, click Help > About, a page that displays the TIBCO Designer version and the build prompts 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 the SAP system. 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 need 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 faces 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 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

• 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 ceases 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 need I do if I do not want to have a permanent connection to SAP, but want to have a connection established by the adapter when required?

You can dynamically set up connection to the SAP system 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 269.

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 are 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 Trigger Immediately, processing in the SAP system blocks the thread, which sends the IDoc, from processing IDocs. It is recommended that the Inbound partner profile be set to Trigger by background program and processing be managed by the SAP system.

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, in 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 does not the adapter receive 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. The test connection fails 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 is specified accurately in the adapter TRA file.

When the Outbound adapter receives data from SAP, the data looks garbled or the call to the adapter fails.

Check to ensure 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 datebase is Unicode. The port type need to reflect the same type as the database.



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 fails to respond due to various reasons like errors resulting from class mismatch, records not being available in the target application or connection problems with the target application.

Why does the adapter startup fail?

Ensure that the RepoUrl syntax has been specified accurately in the adapter TRA file. Ensure that the path specified for the TRA file is correct.

Why does the adapter startup fail, and the error, 'Failed to enable CM transport', occurs?

The one of the following reasons leading to the error:

• There is another instance running under the same CM session.

• Permission to create ledger file under the specified directory is denied.

• The ledger file to be created for the CM session is corrupted.

Check all these before re-start the adapter. If you find a corrupted ledger file, delete the file. But you may 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 is 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 is observed based on the classpath specified in the TRA properties file of the adapter and 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.


| 293

Appendix B Predefined Global Variables

The following table 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 TIBCO Designer User’s Guide.

Table 63 Predefined Global Variables

Variable Description

AppServer Network name of the SAP application server host machine.


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 run time.

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.


294 | Appendix B Predefined Global Variables

You can only maintain the predefined global variables listed in the previous table 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.


| 295

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 296

• Properties File Format, page 297

• Password Handling, page 298

• Adapter Properties, page 299


296 | 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 | 297

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 run time: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 | 299

Adapter Properties

Properties are in two categories: Required Properties and TIBCO ActiveMatrix Adapter for SAP Properties. This section explains these properties.

Required PropertiesThe following table 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 64 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 65 on page 300.

• For TIDManager properties, see Table 66 on page 306.

• For SDK fault tolerance properties, see Table 67 on page 308.

• 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 65 Adapter Properties in TIBCO ActiveMatrix Adapter for SAP (Sheet 1 of 7)

Property Default Description

adr3.contextTimeout Commented out. If specified, this property overrides the contextTimeout property defined in the closure class during an Inbound transaction from TIBCO ActiveMatrix BusinessWorks.

adr3.discovery ON

Commented out.

Specify whether to enable 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 Specify whether to enable 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 termination 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.rfcBapiReplaceNullFields

WithSpace

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. Specify whether to stop the adapter when the adapter sends an IDoc to the SAP system and receives an exception back from the system.

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.

Specify whether 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.

Specify whether to print the thread ID in the adapter logs.

adr3.idocNumAndStatusIncluded ON Specify whether to include the IDoc number and its status in the IDoc confirmation message report.

For Request-Response Service (One Way only), to include IDoc number and status, ensure RFC being invoked matches one of the following funtion modules:

• Inbound_IDOC_ASYNCHONOUS

• Inbound_IDOC_IN_QUEUE

• IDOC_Inbound_PROCESS

adr3.msgReportOutboundThreadCount 1 The number of threads used to publish IDoc confirmation message report.

The maximum value is 10.

adr3.msgReportQueueNameSuffix Message.Confirmation

The suffix to identify the message queue.

adr3.msgReportQueue.serverUrl Not specified by default.

The URL of the remote EMS server.

adr3.msgReportQueue.userName Not specified by default.

The valid user name to log on to the remote EMS server.

adr3.msgReportQueue.password Not specified by default.

The valid password corresponding to the user name.





tibco.sdk.session.jmsCompressed Not specified by default.

The list of JMS session names. All the JMS endpoints under the specified session, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

tibco.sdk.endpoint.jmsCompressed Not specified by default.

The list of JMS endpoints. All the specified JMS endpoints, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

adr3.<adapter_service_name>.jmsPr

operties

<property1>=<value1>,<property2>=<value2>,<property3>=<value3>

Commented out.

The customer JMS properties.

adr3.<adapter_service_name>.jmsPr

operties JMS_TIBCO_COMPRESS

Not specified by default.

Specify whether to enable the feature of compressing messages by using TIBCO Adapter SDK, when the Publication Service is using JMS transport.

This property is only available in the adapter TRA file.

If you add this property in the TRA file, it takes precedence over the adr3.jmscompress property.

Table 66 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP


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.

Spcify whether to print the thread ID in the TIDManager logs.

Table 66 TIDManager Properties in TIBCO ActiveMatrix Adapter for SAP (Cont’d)




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 67 SDK Fault Tolerance Properties in TIBCO ActiveMatrix Adapter for SAP (Sheet 1 of 3)


tibco.sdk.faultTolerance.

ems.enabled

OFF

Commented out.

Specify wether to enable the Fault Tolerance feature.


ems.queueName

Commented out. The queue name that stores the tokens in the EMS server.


ems.sessionName

Commented out. The session name that is used for Fault Tolerance. The specified session must be a JMS queue session.


ems.providerUrl

Commented out. The URL of the EMS provider that is used for the EMS, JNDI, or SSL server. If the EMS server communicates over SSL, the prefix of the URL is ssl://. Otherwise, the prefix is tcp://.




ems.session.factoryName

Commented out. The factory name used when SDK creates the JMS connection factory for Fault Tolerance.


ems.userName

Commented out. The user name for the EMS connection.


ems.password

Commented out. The password for the EMS connection.


ems.ackTokenOnStop

OFFCommented out.

Specify whether the primary instance acknowledges its token when the adapter stops normally. A value of on indicates the token held by the primary instance is acknowledged, which means a token in the specifies EMS queue is deleted.


ems.isUsingJNDI

OFFCommented out.

Specify whether the JNDI is used. A value of on indicates JNDI is used for looking up the JMS factory.


ems.jndi.providerContextF

actory

com.tibco.tibjms.naming.TibjmsInitalContextFactory

Commented out.

The JNDI context factory.


ems.jndi.userName

Commented out. The user name of the JNDI connection.


ems.jndi.password

Commented out. The password of the JNDI connection.


ems.isUsingSSL

OFFCommented out.

Specify whether the adapter connects to the JMS server using SSL.


ems.ssl.enableTrace

OFFCommented out.

Specify whether the SSL enables tracing of the loaded certificates.


ems.ssl.enableDebugTrace

OFFCommented out.

Specify whether the SSL enables the more SSL tracing, on or off.






ems.ssl.enableVerifyHostN

ame

OFFCommented out.

Specify whether the SSL client verifies the name in the server certificate.


ems.ssl.enableVerifyHost

OFFCommented out.

Specify whether the SSL client verifies the server certificate, on or off.


ems.ssl.expectedHostName

Commented out. The name in the server certificate.Note: Required when the enableVerifyHostName and enableVerifyHost are both set to on.


ems.ssl.isStrongCipherSui

tes

OFFCommented out.

Specify whether only the strong cipher suites are allowed, on or off.


ems.ssl.trustedDir

Commented out. The full path of the folder where the required certificates are located.

Note: Required when the connection between the EMS client and EMS server is over SSL.


ems.ssl.identity

Commented out. The path of the client identity.


ems.ssl.password

Commented out. The client identity passwordNote: Required when the identity is specified.



All the SDK properties in the previous table are applicable to TIBCO ActiveMatrix Adapter for SAP, Discovery Agent and TIDManager.


| 311

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 312

• Fields of Trace Message, page 313

• Status Messages of TIBCO ActiveMatrix Adapter for SAP, page 316


312 | 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 313. 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 | 313

Fields of Trace Message

Each trace message includes the following fields:

Table 68 Trace Message Fields (Sheet 1 of 3)

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.




Fields of Trace Message | 315

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 316 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.





Status Messages of TIBCO ActiveMatrix Adapter for SAP

In this section we list 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 316

• Design-Time Trace Messages, page 357

• Trace Messages Discontinued, page 366

Trace Messages of TIBCO ActiveMatrix Adapter for SAPTrace messages are categorized in to the following groups.

• Trace Messages for Adapter Category, page 316

• Trace Messages for Application Category, page 343

• Trace Messages for Configuration Category, page 344

• Trace Messages for Data Category, page 351

• Trace Messages for Hawk Category, page 352

• Trace Messages for Publication Category, page 352

• Trace Messages for Request-Response Category, page 353

• Trace Messages for Request-Response Invocation Category, page 353

• Trace Messages for Subscription Category, page 355

• Trace Messages for System Category, page 356

Trace Messages for Adapter Category

In adapter category there are four groups of trace messages detailed as the following.

• Debug Messages, page 317

• Error Messages, page 317

• Info Messages, page 328

• Warn Messages, page 339


Status Messages of TIBCO ActiveMatrix Adapter for SAP | 317

Debug Messages

For details of debug messages for adapter category, see the following table.

Error Messages

For details of error messages for adapter category, see the following table.

Table 69 Debug Messages for Adapter Category

Status Code Role Category Description Resolution

AER3-DEBUG-ADAPTER Debug Adapter %1 Adapter debug messages. No action required.

Table 70 Error Messages for Adapter Category (Sheet 1 of 12)


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

Ensure 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.





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-000493 Error Adapter Remote TIDManager server unreachable

Check the Remote TIDManager server.

AER3-000494 Error Adapter Failed to update TID store

Check the TID store file record. For example, the length of the record is not 101 characters.

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 systems.

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

Look at earlier error messages in the log files for possible causes.

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 pools 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-970237 Error Adapter The function module is invalid for 4.x version of IDoc: %1

Use the valid function module for 4.x: IDOC_Inbound_ASYNCHRONOUS and IDOC_Inbound_IN_QUEUE.

AER3-970238 Error Adapter RFC error encountered and AutoCommit would be skipped for RFC function : %1 error: %2

Check if the return TYPE is "S" or " " in the case of associated TYPE starting with "BAPIRET" from EXPORT parameters and TABLE parameters in SAP server.





AER3-970241 Error Adapter The transaction committed failure for RFC function : %1 error: %2

Check the SAP server.

AER3-970243 Error Adapter Failed to initialize JMS Message Queue: %1

Check the message queue name specifed in Global Variables.

AER3-970244 Error Adapter Failed to stop JMS Message Queue: %1

Check the EMS server.

AER3-970245 Error Adapter Failed to stop Message Report Thread Pool

Check the thread pool for message report.

AER3-970247 Error Adapter RFC function initialization failure : %1; function name : %2

Check the connection to the SAP server, for example,user ID and password.

AER3-970248 Error Adapter RFC function execution failure : %1; function name : %2

Check the SAP server.

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 is 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


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






Info Messages

For details of info messages for adapter category, see the following table.

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 71 Info Messages for Adapter Category (Sheet 1 of 12)


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.

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-000249 Info Adapter Checking TID store for TID %1 from RFCClosure

None

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-000487 Info Adapter Checking TID store for tracking id %1

None

AER3-000488 Info Adapter Found transaction %1 for tracking id %2 in CREATED state

None

AER3-000489 Info Adapter Found transaction %1 for tracking id %2 in EXECUTED state

None

AER3-000490 Info Adapter Transaction created %1 None





AER3-000491 Info Adapter Transaction executed %1

None

AER3-000492 Info Adapter Transaction confirmed %1

None

AER3-000495 Info Adapter Pinging remote TIDManager...

None

AER3-000496 Info Adapter Pinged remote TIDManager successfully...

None

AER3-000497 Info Adapter Suspending subscription services

None

AER3-000498 Info Adapter Activating subscription services

None

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-970239 Info Adapter Invoking function: %1 ...

None

AER3-970240 Info Adapter The transaction committed successfully for RFC function : %1

None





AER3-970242 Info Adapter Writing IDOC %1, Number %2 to file: %3 in %4 format, ServiceName %5, SubjectName %6

None

AER3-970249 Info Adapter Checking TID store for TID %1 from RFCClosure

None

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





Warn Messages

For details of warn messages for adapter category, see the following table.

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.



Table 72 Warn Messages for Adapter Category (Sheet 1 of 5)


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.

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.





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 the following table.

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.



Table 73 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




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 the following table.

Table 74 Error Messages for Configuration Category (Sheet 1 of 6)


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.

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 runtime 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 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 Go To Resource

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 Go To Resource

Check out the resource and try deleting again.

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 Go To Resource

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.





Debug Messages

For details of debug messages for configuration category, see the following table.

Info Messages

For details of info messages for configuration category, see the following table.

Table 75 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.

Table 76 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




Warn Messages

For details of warn messages for configuration category, see the following table.

Trace Messages for Data Category

In data category there is one group of trace messages detailed as the following:


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


Table 76 Info Messages for Configuration Category (Cont’d)


Table 77 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.



Debug Messages

For details of debug messages for data category, see the following table.

Trace Messages for Hawk Category

In hawk category there is one group of trace messages detailed as the following:


Debug Messages

For details of debug messages for adapter category, see the following table.

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 the following table.

Table 78 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.

Table 79 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 80 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.



Trace Messages for Request-Response Category

In request-response category, there is one group of trace messages as the following:


Error Messages

For details of error messages for request-response category, see the following table.

Trace Messages for Request-Response Invocation Category

In request-response invocation category, there is one group of trace messages as the following:


Table 81 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.



Error Messages

For details of error messages for request-response invocation category, see the following table.

Table 82 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.



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.



Trace Messages for Subscription Category

In subscription category, there is one group of trace messages as the following:


Error Messages

For details of error messages for subscription category, seethe following table.



Request Response Invocation service %1 with subject %2 received error while processing reply message.

Table 82 Error Messages for Request-Response Invocation Category (Cont’d)


Table 83 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.



Trace Messages for System Category

In system category there is one group of trace messages detailed as the following:



Info Messages

For details of info messages for system category, see the following table.

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.

Table 83 Error Messages for Subscription Category (Cont’d)


Table 84 Info Messages for System Category


AER3-000004 Info System Adapter application %1 is stopped


AER3-970246 Info System Message Report Thread is stopped

None



Error Messages

For details of error messages for system category, see the following table.

Design-Time Trace MessagesDesign-time trace messages are categorized in to the following groups:

• Design-Time Trace Messages for Configuration Category, page 357

• Design-Time Trace Messages for DTA Category, page 362

• Design-Time Trace Messages for Repository Category, page 364

• Design-Time Trace Messages for Schema Category, page 364

Design-Time Trace Messages for Configuration Category

In configuration category, there is one group of design-time trace messages detailed as the following:


Table 85 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



Warn Messages

For details of warn messages for configuration category, see the following table.

Table 86 Warn Messages for Configuration Category (Sheet 1 of 5)


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.

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 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.

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.





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 the following table.

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 Go To Resource to select the resource

Ensure that this resource is added to RCS and checked in.



Table 87 Error Messages for DTA Category


AEADR3-600017 Error DTA Select an IDoc. You did not make a selection

Select an IDoc.

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.



Info Messages

For details of info messages for DTA category, see the following table.

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 87 Error Messages for DTA Category (Cont’d)


Table 88 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.

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.



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 the following table.

Design-Time Trace Messages for Schema Category

In schema category, there are two groups of design-time trace messages listed as the following:



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 88 Info Messages for DTA Category (Cont’d)


Table 89 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.



Error Messages

For details of error messages for schema category, see the following table.

Table 90 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.

AEADR3-600043 Error Schema Error while pasting. Deserialization of Schema Failed

Copy/Paste of schemas failed. Try configuring again.



Warn Messages

For details of warn messages for schema category, see the following table.

Trace Messages DiscontinuedFor trace messages discontinued from TIBCO ActiveMatrix Adapter for SAP 7.1, see the following table.

Table 91 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 to reuse existing schema. Click NO 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 92 Discontinued Trace Messages of TIBCO ActiveMatrix Adapter for SAP 7.1 (Sheet 1 of 38)


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 run time.

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.





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 37.

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 startup/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 9 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 9 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 9 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 9 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 9 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 9 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 9 for details on setting up a endpoint of Request-Response Invocation Service and a Request-Response Invocation Service.




| 405

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 406

• Available TIBCO Hawk Methods, page 407


406 | 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 | 407

Available TIBCO Hawk Methods

The following table 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 " TIBCO Adapter SDK Hawk Microagents and Methods" in TIBCO Adapter SDK Programmer’s Guide.

Table 93 Custom Microagent Methods

Method Description

getActivityStatisticsByService() Get the runtime statistics for an adapter

Note: This method replaces the following methods defined in the releases before 7.0:

• getConfiguredRFCs()

• getActivityStatisticsByOperation()

getActivityStatisticsBySchema()

getInboundConnectionData() Get the number of client connections to an Inbound adapter service at run time.

getInboundThreadData() Get the number of threads used in processing Inbound messages for an Inbound adapter service at run time.


• getConnectionStatistics()

• getThreadStatistics()

getOutboundThreadData() Get the thread information for an Outbound adapter service at run time.


• getConnectionStatistics()

• getThreadStatistics()

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.

setOutboundThreadPool() Modify the number of connections to the SAP gateway, which influences the number of threads available for processing Outbound messages.

refreshABAPRepository() When the schema in the SAP system has changed, invoke this method to refresh the schema of the Inbound service to reflect this change.

Table 93 Custom Microagent Methods (Cont’d)

Method Description


getActivityStatisticsByService() | 409

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 run time.

Parameters None.



ClientConnectionPool string Name of the client connection pool.

MaxConnections integer Maximum number of connections for the specified pool.


getInboundThreadData() | 411

getInboundThreadData()

Purpose Get the number of threads used in processing Inbound messages for an Inbound adapter service at run time.

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 run time.

Parameters None.



ServerConnectionPool string Name of the server connection pool.

GatewayHost string Gateway host.

GatewayService string Gateway service.

ProgramID string Program ID.



refreshExtendedLogging() | 413

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() | 415

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() | 417

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() | 419

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.



refreshABAPRepository() | 421

refreshABAPRepository()

Purpose When the schema in the SAP system has changed, invoke this method to refresh the schema of the Inbound service to reflect this change.

Parameters None.

Returns None.




| 423

Appendix F Migrating an Adapter Project

This appendix provides information on how to migrate an existing project using TIBCO Designer and the migration tool.

Topics

• Migration Overview, page 424

• Migrating a Project by Using TIBCO Designer, page 426

• Migrating a Project by Using the Migration Tool, page 427

• Configuration in the Migrated Project, page 432


424 | Appendix F Migrating an Adapter Project

Migration Overview

You can migrate an existing project either by using TIBCO Designer or by using the migration tool installed with TIBCO ActiveMatrix Adapter for SAP.

The migration tool can migrate one or more adapter projects built in TIBCO Designer from TIBCO ActiveMatrix Adapter for SAP 6.2 or later to 7.1. For the releases earlier than 6.2, first you must upgrade them to 6.2 or later. The tool supports migration for both non-Unicode and Unicode projects.

Migration Tool IntroductionThe 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 when saving the migrated project:

• Add new custom TIBCO Hawk methods introduced in the 7.x release.

• 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 stops. 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 adds 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 the adapter services requiring JMS Topics or Queues.

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.


Migration Overview | 425

Upon startup of a runtime adapter, if the JMS client ID is not specified, the adapter stops. To avoid this error, the tool checks if the client IDs of all the JMS sessions are specified. For any session with no client ID specified, the tool adds 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 uses 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 is refreshed:/tibco/public/class/ae/700/basic/functionModules/Z_TEST_COMPLEX

— If the version of the SAP system connecting to the design-time connection is no longer 700, the adapter continues to use the schema available in the 700 release.

— The migration tool refreshes 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 is originally configured using an older release of an SAP system then the path changes, because the release of the SAP system has changed.

This functionality is only offered as a 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.



Migrating a Project by Using TIBCO Designer

To migrate an existing project using TIBCO Designer:

1. Open the existing project in TIBCO Designer.

2. Click one of the adapter instances from the project. The Processing dialog is displayed. The message "Loading R/3 Product Classes" indicates that required configuration is added to the existing project.

3. Refresh the SAP schemas of Request-Response Invocation Services for all the adapter instances in the project.

4. Save the project.

This step is not necessary, if the command-line migration tool has been used against the project and the schema has been updated accordingly.


Migrating a Project by Using the Migration Tool | 427

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 427

• Migrating a Project, page 428

• After the Migration, page 429

Before the MigrationBefore the migration, back up the current projects to a safe location, otherwise you lose them, because the migration tool overrides the project directory with the migrated projects.

When you prepare for the migration, note the following points:

• If a project contains one or more Request-Response Invocation Services and these services contain properties relevant to dynamic logging or transactions, the project cannot be migrated by the migration tool. You must migrate the project manually by opening the project in TIBCO Designer.

• If the JMS durable name has been changed in a project, you must first recycle the EMS server before you run 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 before 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 cannot migrate the project and generates 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.

• During the migration, the tool generates the log information in the console and a file, with the syntax based on the Log4J property file specified. If you use the original adr3MigrateConfig.log4j.properties file, the log file is



created in the TIB_ADR3_HOME/tools directory and named as adr3MigrateConfig_YYYYMMDD_hhmmss.log. If you want to log the 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.

Migrating a ProjectTo To migrate an existing project using migration tool:

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

adr3MigrateConfig.log4j.properties

— UNIX ./adr3MigrateConfig -projectfile

project_directory/project_name -log:propfile

adr3MigrateConfig.log4j.properties

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

The following table lists the properties used by the migration tool.

Table 94 Migration Tool Command-Line Parameters

Property Usage Description

-projectfile Conditional The location of the TIBCO Designer project you want to migrate.

-projectdir Conditional The location of the directory containing the TIBCO Designer projects you want to migrate.

-log:propfile Required The location of the Log4J properties file.

-verbose Optional The toggle for verbose logging. The default value is off.

-help Optional The usage information.



After the migration is completed successfully, the migrated project is saved to the original directory. If any error occurs during the migration, the project is not migrated and it remains unchanged.

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 429

• Review the Configured Properties, page 430

• Replace Configuration in the saprfc.ini File, page 431

• Create a Service for Each IDoc Type, page 431

Make the Project Compatible with the Current Version

When you open the migrated project using TIBCO Designer, the Palette Versioning Issues window opens to remind you about inconsistent versions with the old project. Click Yes to continue opening the project.

The following figure shows the window displayed for a project migrated from TIBCO ActiveMatrix Adapter for SAP 7.0 to 7.1 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 97 Palette Versioning Issues Window for a Migrated Project

Review the Configured Properties

During the migration, Default values are 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 97 and Advanced Tab of Request-Response Service Configuration Reference on page 111 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 Advanced Tab on page 136 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 86 and Advanced Tab of Subscription Service Configuration Reference on page 97 for configuration details.



Replace Configuration in the saprfc.ini File

If the configuration 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.



Configuration in the Migrated Project

This section is relevant for projects migrated using TIBCO Designer or the migration tool. When a project is migrated to the 7.1 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 201 for detailed information.

• Modify any existing TIBCO Hawk rule bases based on the current set of trace messages available.

• Modify the schema to reflect the attributes in the message report. When the service publishes the message report, all attributes applicable in the MsgReport class are available regardless whether or not they are populated.

• Ensure that the messages are sent to the adapter in the required order and that the number of threads per adapter service is not greater than one, because the qCount attribute available for the Request-Pesponse service in the released versions before 7.0 is not appilcable in TIBCO ActiveMatrix Adapter for SAP 7.1.

• Review the TID management range for both the Outbound and the Inbound adapter services. If you migrate a project to the version 7.1, regardless of the range of the TID Management in the prior version, the type of the adapter service for TID management is based on the range of the TIDManagement in version 7.1.

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.


| 433

Index

A

adaptertracing 228

Adapter InstanceConfiguring the TID Management 54

Adding Adapter Services Automatically 70ALE/IDoc Interface 6Assigning CMQ Name - Inbound Load-balanced

Instance 280

C

Certified 84configure SAP instance

to run on two systems 272Configuring a User exit for a Subscription Service 277,

277Configuring Advanced Request-Response Invocation

Options 277configuring design time

remote function call 18Configuring Multiple Connections for Inbound

Instance 277Configuring Multiple Connections for Outbound

Instance 277Configuring Request-Response Invocation Service 111configuring runtime

inbound messaging 21outbound messaging 20

configuration of invoking BAPIs/RFCs from the SAP system 20

configuration of publishing IDocs from the SAP system 20

Configuring Valid Destinations 283

D

Distributed Queue 85Durable 83

E

ENV_NAME xxiiiEvent Driven Inbound Connections 269, 269Example 102, 102, 109, 109, 114, 114

F

Fault Tolerance 246Frequently Asked Questions 285, 286

G

getConnectionStatistics() 159getThreadStatistics() 159Getting Started

Creating a Project for the Adapter 10Creating and Configuring Adapter Services 13Creating and Configuring an Adapter Instance 11Starting the Adapter 14Stopping the Adapter 16

Global VariablesAttributes 30


434 | Index

I

Identifying the Publication Mode 90IDoc

records contained 91IDoc in uncompressed “exploded” format 93IDocs

compressed form 92exploded format 93metadata 92versions supported 90

Inbound BAPI Transactional Support 250Automatic Commit 251

instance name 72, 75, 75Invoking BAPIs/RFCs Using Transactional Semantics

in SAP R/3 255

L

Load Balancing 277log file options 228

M

message filter 73Mode “none” 90Multiple Application Servers 269multiple file project 32Multiple Inbound Configurations 278Multiple Program IDs 261Multithreading 259Multithreading with Distributed Queues 260

N

Non-durable 83Non-persistent 83

O

Opening Projects 28Overview 312

P

Persistent 83Procedure 272publish-subscribe 84

Q

Queue 84

R

related documentation xxReliable 85Reopening Projects 28Replacing Control Fields 277Request-Response Service 111, 111

IDoc Confirmation 117resetActivityStatistics() 159RFC Interface 6Running an Adapter Instance on Two SAP R/3 Sys-

tems with Single Connection 272RVCMQ Session Attributes 277

S

Sample Scenario 272SAP R/3 Releases 4.x 75, 77, 87, 89, 98, 100, 107, 108,

112, 113Setting Publisher Configuration Options 86Single Inbound Configuration 280Single Outbound Instance 281


Index | 435

Startup Tab 216Subscription Service

IDoc Confirmation 104system

configurl command-line argument 299, 299

T

TIB_ADR3_HOME xxiiiTIBCO Hawk Session 216TIBCO support

contacting xxviTIBCO documentation xxviTIBCOmmunity xxvi

TIBCO_HOME xxiiiTopic 83, 83, 84typographical conventions xxiii

U

use-trace-file, adapter option 228Using SSL Certificates from an External Directory 249

V

version 73

W

wire formatheader information 95
