tibco activematrix businessworks plug-in for oracle e ... · pdf fileworking with the custom...

Two-Second Adv

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Oracle E-Business Suite

User’s GuideSoftware Release 1.3March 2015

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 Administrator, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO Haw, TIBCO ActiveMatrix BusinessWorks, and TIBCO Designer are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.EJB, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README 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 © 2010-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivTIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Documentation . . . . . . . . . . . . . .xivOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivThird-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

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

Oracle E-Business Suite Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Oracle E-Business Suite Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Overview . . . . . . . . . . . . . . . . . . . . . . . 3Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 Prerequisites of Using the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Installing the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Connecting to Oracle Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Creating an Oracle E-Business Suite Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Creating a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Adding Activities to a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Testing a Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite User’s Guide

iv | Contents

Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 4 Oracle E-Business Suite Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Oracle E-Business Suite Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Test Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Oracle API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30PLSQL API Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Custom API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38PLSQL API Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Oracle Concurrent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Concurrent Program Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Custom Concurrent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Concurrent Program Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Oracle Business Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Get Event Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Chapter 5 Using the Sample Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Working with the Oracle API Activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69


Contents | v

Prepare_purchased_items Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Subassembly_item_and_bom_bill Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Working with the Custom API Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Executing the CustomAPI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Working with the Oracle Concurrent Program Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91WICMLP Concurrent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Executing the OracleCP Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Working with the Custom Concurrent Program Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100INCOIN Concurrent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Executing the CustomCP Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Working with the Oracle Business Event Activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Appendix A Backing Up TIB_BW_EBS_LOG Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

Exporting Data from Oracle E-Business Suite 12.1.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Importing Data into Oracle E-Business Suite 12.2.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Appendix B Oracle API and Custom API Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123

Oracle API and Custom API Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Appendix C Oracle Concurrent Program and Custom Concurrent Program Comparison . .125

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

SRS Concurrent Program and Non-SRS Concurrent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Sample Non-SRS Concurrent Program: GLBBSU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Suggestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Appendix D Introduction to Oracle Integration Repository . . . . . . . . . . . . . . . . . . . . . . . . . . .137

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Searching for a Business Service Interface in Oracle Integration Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Appendix E Introduction to Oracle Database JPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Oracle JPublisher Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Supported Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Running Oracle JPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Running Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Running Oracle JPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Oracle JPublisher Wrapper Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153


vi | Contents

Appendix F Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Error Messages . . . . . . . . . . . . . . . . 156

Appendix G Log Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Log Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163


Figures | vii

Figures

Figure 1 Oracle E-Business Suite Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Figure 2 Logging on to Oracle SQL*Plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Figure 3 Running the common_all.sql File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Figure 4 TIBCO Designer Start Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Figure 5 TIBCO Designer Save Project Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Figure 6 TIBCO Designer Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Figure 7 Oracle E-Business Suite Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Figure 8 Oracle E-Business Suite Connection Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Figure 9 Oracle API Configuration: Wrapper Package not Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 10 Oracle API Configuration: Wrapper Package Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 11 PLSQL API Details: Without Wrapper Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Figure 12 PLSQL API Details: With Wrapper Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Figure 13 Oracle API Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Figure 14 Oracle API Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Figure 15 Oracle API Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Figure 16 Custom API Configuration: Wrapper Package not Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 17 Custom API Configuration: Wrapper Package Needed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 18 PLSQL API Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Figure 19 Custom API Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Figure 20 Custom API Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Figure 21 Custom API Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Figure 22 Oracle Concurrent Program Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Figure 23 Oracle Concurrent Program Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Figure 24 Oracle Concurrent Program Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Figure 25 Oracle Concurrent Program Output: Wait for Response Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Figure 26 Oracle Concurrent Program Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Figure 27 Custom Concurrent Program Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Figure 28 Custom Concurrent Program Configuration: Interface Table Configuration. . . . . . . . . . . . . . . . . . . 53


viii | Figures

Figure 29 Custom Concurrent Program Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Figure 30 Custom Concurrent Program Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Figure 31 Custom Concurrent Program Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Figure 32 Custom Concurrent Program Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Figure 33 Oracle Business Event Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Figure 34 Oracle Business Event Advance Configuration: Creating a New Agent . . . . . . . . . . . . . . . . . . . . . 60

Figure 35 Oracle Business Event Advance Configuration: Selecting an Existing Agent . . . . . . . . . . . . . . . . . 60

Figure 36 Oracle Business Event Advanced Configuration: Creating a Multiple Consumer . . . . . . . . . . . . . . 61

Figure 37 Oracle Business Event Advance Configuration: Selecting an Existing Multiple Consumer . . . . . . 61

Figure 38 Oracle Business Event Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Figure 39 Oracle Business Event Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Figure 40 Sample of the Created BOM Bill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Figure 41 TIB_CPU Activity Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Figure 42 TIB_CPU Activity Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Figure 43 Define Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Figure 44 Grant Privilege and Create EGO_ITEM_PUB Synonym. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Figure 45 Master Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Figure 46 Select V1 Organization in the Prepare_Purchased_items Process . . . . . . . . . . . . . . . . . . . . . . . . 76

Figure 47 Search for the Result of Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Figure 48 The Result of the System Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Figure 49 TIB_MainMachine Activity Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Figure 50 OracleAPI Activity Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Figure 51 Wrapper File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Figure 52 TIB_MainMachine Activity Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Figure 53 OracleAPI Activity Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Figure 54 Grant Privilege and Create TIB_BOM_BO_PUB Synonym. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Figure 55 The Output of Running the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Figure 56 Select V1 Organization in the Subassembly_item_and_bom_bill Process . . . . . . . . . . . . . . . . . . . 85

Figure 57 Search for the Result of Bills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Figure 58 The Result of the Bills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Figure 59 CustomAPI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Figure 60 Sample Custom API Activity: Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90


Figures | ix

Figure 61 WICMLP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Figure 62 WICMLP CP Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Figure 63 WICMLP CP: Find Requests Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Figure 64 WICMLP CP: Request Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Figure 65 WICMLP CP: Select M1 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Figure 66 WICMLP CP: Search Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Figure 67 Discrete Jobs (M1) Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Figure 68 INCOIN CP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Figure 69 INCOIN CP Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Figure 70 INCOIN CP: Find Requests Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Figure 71 INCOIN CP: Request Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Figure 72 INCOIN CP: Select V1 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Figure 73 INCOIN CP: Search for the Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Figure 74 INCOIN CP: View the Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Figure 75 Review Disabled Business Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Figure 76 Enable the Business Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Figure 77 Select the Business Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Figure 78 Business Event Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Figure 79 Person Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Figure 80 Event Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Figure 81 Business Event Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Figure 82 Oracle Concurrent Program for GLBBSU: Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Figure 83 Oracle Concurrent Program for GLBBSU: Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Figure 84 Oracle Concurrent Program for GLBBSU: Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Figure 85 GLBBSU Detail in Oracle Integration Repository (Oracle CP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Figure 86 GLBBSU Request Detail from Oracle EBS Client (Oracle CP) . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Figure 87 Submitting a New Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Figure 88 Standard Submit Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Figure 89 The Non-Standard Request Form for GLBBSU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Figure 90 Non-Standard Submit Form for GLBBSU: Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Figure 91 Request Detail of GLBBSU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Figure 92 Custom Concurrent Program for GLBBSU: Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134


x | Figures

Figure 93 Custom Concurrent Program for GLBBSU: Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Figure 94 GLBBSU Request Details from Oracle EBS Client (Custom CP) . . . . . . . . . . . . . . . . . . . . . . . . . 135

Figure 95 Oracle E-Business Suite: Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Figure 96 Oracle Applications Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Figure 97 Oracle Integration Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Figure 98 Oracle Integration Repository Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Figure 99 Searching an API Package from Oracle E-Business Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Figure 100 Business Service Interface Details Shown in Oracle E-Business Suite . . . . . . . . . . . . . . . . . . . . 144

Figure 101 Wrapper and Non-Wrapper Data Type Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147


Tables | xi

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Table 2 Oracle E-Business Suite Connection Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 3 Oracle API Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Table 4 Oracle API Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 5 Custom API Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Table 6 Custom API Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Table 7 Oracle Concurrent Program Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Table 8 Oracle Concurrent Program Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Table 9 Custom Concurrent Program Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Table 10 Custom Concurrent Program Error Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Table 11 Oracle Business Event Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Table 12 Oracle Business Event Advanced Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Table 13 Oracle E-Business Suite Outbound Message Listener Misc Fields . . . . . . . . . . . . . . . . . . . . . . . . 64

Table 14 Inputs of TIB_CPU Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Table 15 Inputs of BOM_Bill Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Table 16 Custom API Activity Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Table 17 WICMLP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Table 18 WICMLP Open Interface Tables or Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Table 19 WICMLP CP Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Table 20 Interface Tables Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Table 21 INCOIN Interface Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Table 22 INCOIN CP Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Table 23 INCOIN CP Interface Tables Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Table 24 INCOIN CP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Table 25 JPublisher Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Table 26 Log Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160


xii | Tables


| xiii

Preface

This documentation is intended for system administrators of networks running TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite, as well as for system integrators who plan to integrate Oracle E-Business Suite with another system. It is assumed that you are experienced with the TIBCO environment and Oracle E-Business Suite.

Topics

• Related Documentation, page xiv

• Typographical Conventions, page xv

• Connecting with TIBCO Resources, page xvii


xiv | Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Documentation

The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite documentation set:

• TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Installation Read this manual for instructions on site preparation and installation.

• TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite User’s Guide Read this manual for the concepts relating to the plug-in, the applications with which the plug-in interacts, configuration and deployment information, and examples.

• TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release.

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

• TIBCO Administrator™

• TIBCO ActiveMatrix BusinessWorks™

• TIBCO Designer™

• TIBCO Hawk®

• TIBCO Runtime Agent™

• TIBCO Rendezvous®

Third-Party DocumentationYou may also find it useful to read the Oracle E-Business Suite Documentation Library which is available from the Oracle Technical Network at http://www.oracle.com/technology/documentation.


http://www.oracle.com/technology/documentation

Preface | xv

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

USER_HOME

ORACLE_DB_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. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu.

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

The directory where the Oracle E-Business Suite database server installs is referenced in documentation as ORACLE_DB_HOME. The default value of ORACLE_DB_HOME depends on the operating system.

The user’s home directory on the operating system is referenced in documentation as USER_HOME.

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]


xvi | Typographical Conventions

italic font Italic font is used in the following ways:

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

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

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

Key combinations

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

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

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

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

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

Table 1 General Typographical Conventions (Cont’d)

Convention Use


Preface | xvii

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

xviii | Connecting with TIBCO Resources


| 1

Chapter 1 Introduction

This chapter gives an overview of Oracle E-Business Suite (EBS) and TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite.

Topics

• Oracle E-Business Suite Overview, page 2

• TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Overview, page 3


2 | Chapter 1 Introduction

Oracle E-Business Suite Overview

Oracle E-Business Suite (EBS) is a complete set of business applications for managing and automating processes across your enterprise. It is also known as Oracle Enterprise Resource Planning (ERP), Oracle Apps, Oracle Applications, and Oracle Financials on the market. It is a comprehensive suite of integrated, global business applications that provides:

• a complete, integrated business intelligence portfolio

• an adaptable global business platform

• a customer-focused applications strategy

Oracle E-Business Suite ArchitectureThe Oracle E-Business Suite Architecture is a framework for multi-tiered, distributed computing that supports Oracle E-Business Suite products. In this model, various servers or services are distributed among three levels, or tiers.

Figure 1 Oracle E-Business Suite Architecture


TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Overview | 3

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business

Suite Overview

TIBCO ActiveMatrix BusinessWorks is an easy-to-use integration software that provides world-class integration technology in a rapid deployable solution that manages the entire lifecycle of integration projects. TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite plugs into TIBCO ActiveMatrix BusinessWorks. Customers can use this plug-in to configure a connection to Oracle E-Business Suite, and then use activities to integrate with Oracle E-Business Suite.

FeaturesTIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite provides the following features:

• Support for Oracle E-Business Suite. (See TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite readme.txt for supported versions.)

• Support for Oracle Business Events as outbound Business Objects.

• Support for both PL/SQL API from Oracle Integration Repository and API defined by the customer.

• Support for both Concurrent Programs from Oracle Integration Repository and Concurrent Programs defined by the customer.

• Support for Custom Oracle Business Events. This is a way to register a user created event in Oracle E-Business Suite, and the events registered are searchable in Integration Repository.

ActivitiesIn TIBCO terminology, the plug-in offers activities to the host application and to the TIBCO environment. An activity broadly encapsulates routing rules for messages handled by the activity and also custom configuration information. TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite provides the following activities:


4 | Chapter 1 Introduction

• Inbound Activities:

— Oracle API

— Custom API

— Oracle Concurrent Program

— Custom Concurrent Program

• Outbound Activity:

— Oracle E-Business Suite Connection

— Oracle Business Event

This orai18n.jar file contains the classes used for NLS support in Oracle objects and collection types. You can copy the file to the TIBCO_HOME\bw\plugins\lib directory to resolve the character set conversion issues which were caused when mapping Oracle object types (for example, event type used in queue table) to Java object types.

You can get the orai18n.jar file from http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-10201-088211.html or the ORACLE_DB_HOME/jlib/ directory.


http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-10201-088211.html

http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-10201-088211.html

| 5

Chapter 2 Prerequisites of Using the Plug-in

This chapter describes the prerequisites tasks that should be completed before you start configuring the plug-in.

Topics

• Installing the Plug-in, page 6

• Connecting to Oracle Database Server, page 7


6 | Chapter 2 Prerequisites of Using the Plug-in

Installing the Plug-in

Before starting to configure the plug-in, make sure that all the required softwares have been installed and are operating correctly. For more details about installing the plug-in, refer to TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Installation.


Connecting to Oracle Database Server | 7

Connecting to Oracle Database Server

A connection to the Oracle database server is required by the plug-in for configuration of the basic settings. As part of the installation, two SQL scripts must be issued. You have to have an Oracle Database system administrator’s account to create a plug-in user and an Oracle E-Business Suite application administrator’s account to grant privileges to the plug-in user.

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite 1.3.0 adds support for Oracle E-Business Suite 12.2.x. The steps to connect to the Oracle database server differ if you use the plug-in 1.3.0 with different version of Oracle E-Business Suite:

These following SQL scripts set up the infrastructure in the Oracle E-Business Suite database that are used by some features of the plug-in:

• create_user.sql

This script creates the database user that the plug-in uses to interact with the database. This design is conducive to more fine grain control over the privileges granted to the plug-in.

For Oracle E-Business Suite 12.2.x, the created plug-in user is only used to issue sql scripts for the Oracle Concurrent Program, Custom Concurrent Program, and Oracle E-Business Event activities at run time.

For Oracle E-Business Suite 12.1.x, the created plug-in user is used to issue sql scripts for all the plug-in activities at run time.

• common_all.sql

This script grants the plug-in user privileges to access the Oracle Database Dictionary tables, Oracle Integration Repository tables, and Oracle Concurrent Program infrastructure packages and procedures. This script also creates the log table and SQL package used by the plug-in to record the progress and result of every transaction.

• common_all_undo.sql

This script reverses all the changes made by the common_all.sql script. After issuing this script, all the privileges granted to the plug-in user are revoked, and the log tables and SQL packages used by the plug-in are deleted.

• user_upgrade.sql

This script alters the enable editions of the plug-in user. Issue this script if you used the plug-in 1.2.0 with Oracle E-Business Suite 12.1.x and want to upgrade Oracle E-Business Suite to 12.2.x and use it with the plug-in 1.3.0.



• Using the Plug-in 1.3.0 with Oracle E-Business Suite 12.1.x

• Using the Plug-in 1.3.0 with Oracle E-Business Suite 12.2.x

Using the Plug-in 1.3.0 with Oracle E-Business Suite 12.1.x

If you use the plug-in 1.3.0 with Oracle E-Business Suite 12.1.x, complete the following steps to connect to the Oracle database server:

1. Log on to Oracle SQL*Plus.

On a command line, type sqlplus. Enter the Oracle database system administrator’s user name and password, as shown in Figure 2.

Figure 2 Logging on to Oracle SQL*Plus

2. Create a plug-in user.

The plug-in requires the user that can access various schemas, objects, and data in the Oracle E-Business Suite system.

Run the create_user.sql file that is located in the TIBCO_HOME/bw/plugins/oracleebs/config/12.1 directory to create the plug-in user.

3. Initialize the plug-in user.

Run the common_all.sql file that is located in the TIBCO_HOME/bw/plugins/oracleebs/config/12.1 directory to initialize the plug-in user created in step 2.


Connecting to Oracle Database Server | 9

You are prompted to enter values for the following parameters:

— dba_username: typically system

— dba_password: typically manager

— db_connectstring: net service name

— plug-in username: as created in step 2

— plug-in password: as created in step 2

— apps_username: typically apps

— apps_password: typically apps

Figure 3 Running the common_all.sql File

Using the Plug-in 1.3.0 with Oracle E-Business Suite 12.2.x

If you use the plug-in 1.3.0 with a fresh Oracle E-Business Suite 12.2.x, complete the following steps to connect to the Oracle database server:

1. Log on to Oracle SQL*Plus.

On a command line, type sqlplus. Enter the Oracle database system administrator’s user name and password, as shown in Figure 2.

2. Create a plug-in user.



Run the create_user.sql file that is located in the TIBCO_HOME/bw/plugins/oracleebs/config/12.2 directory to create the plug-in user.

3. Initialize the plug-in user.

Run the common_all.sql file that is located in the TIBCO_HOME/bw/plugins/oracleebs/config/12.2 directory to initialize the plug-in user created in step 2.

See Figure 3 for more details.


| 11

Chapter 3 Getting Started

This chapter specifies the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite in TIBCO Designer.

Topics

• Overview, page 12

• Creating a Project, page 13

• Creating an Oracle E-Business Suite Connection, page 15

• Creating a Process, page 16

• Adding Activities to a Process, page 17

• Testing a Process, page 18

• Deploying a Project, page 19


12 | Chapter 3 Getting Started

Overview

TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy-to-use integration product suite designed for enterprise application. It uses TIBCO Designer GUI for defining business processes and uses the process engine to execute defined processes.

For detailed information about how to configure processes, see TIBCO Designer documentation, which can be accessed from Help > Designer Help in TIBCO Designer.

A typical configuration session contains the following steps:

1. Creating a Project, page 13

2. Creating an Oracle E-Business Suite Connection, page 15

3. Creating a Process, page 16

4. Adding Activities to a Process, page 17

5. Testing a Process, page 18

6. Deploying a Project, page 19


Creating a Project | 13

Creating a Project

The TIBCO Designer GUI is used to build a project. When starting TIBCO Designer, you must create or select a project. A project contains the configuration files that define options used during run time.

To create a project, complete the following steps:

1. Start TIBCO Designer.

Execute one of the following platform-specific operations to open the TIBCO Designer window:

— On Microsoft Windows

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

or

On a command line, run TIBCO_HOME\designer\version_number\bin\designer.exe

— On UNIX

At a command prompt, run TIBCO_HOME/designer/version_number/bin/designer

2. Click New Empty Project in the TIBCO Designer dialog, as shown in Figure 4.

Figure 4 TIBCO Designer Start Screen



3. In the Save Project dialog, click Select a file from the file system in the Multi-File Project tab to navigate to the location where you intend to save the project or type the path in the Project Directory field directly. Click OK to save the project, as shown in Figure 5.

Figure 5 TIBCO Designer Save Project Screen

4. The TIBCO Designer GUI is displayed with the newly created project, as shown in Figure 6.

Figure 6 TIBCO Designer Window


Creating an Oracle E-Business Suite Connection | 15

Creating an Oracle E-Business Suite Connection

Before creating or running a TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite process, you have to create an Oracle E-Business Suite connection in the existing project. This connection can be reused by all the plug-in activities.

To create an Oracle E-Business Suite connection, execute the following steps:

1. In the Project panel, expand the project folder created in Creating a Project on page 13.

2. Click the Oracle E-Business Suite Plug-in palette in the Palette tab, and drag the Oracle E-Business Suite Connection to the Design panel on the right.

3. Configure the Oracle E-Business Suite Connection. Refer to Oracle E-Business Suite Connection on page 23 for more information. Click Test Connection to ensure the connection is correct.

4. Click Apply to save the configuration.



Creating a Process

After creating a project and configuring the Oracle E-Business Suite Connection shared resource, you can create a process and add the Oracle E-Business Suite activities to it to deal with certain workflow.

To create a process, execute the following steps:

1. Click a project you created in the Project panel.

2. Add a process using either of the following ways:

— Expand the Process palette in the Palette tab and drag the Process Definition into the Design panel.

Or

— Right-click the created project and click Add Resource > Process > Process Definition from the pop-up menu.

3. Configure the process.

Refer to TIBCO Designer User’s Guide for more information about how to configure a process.

4. Click Apply to save the configuration.


Adding Activities to a Process | 17

Adding Activities to a Process

After creating a process, you can add plug-in activities to the process.

To add activities to the process, complete the following steps:

1. Click the process that was previously created in Creating a Process on page 16 in the Project panel.

The Start and End activities are displayed in the Design panel.

2. Expand the Oracle E-Business Suite palette in the Palette tab and drag one or more activities to the Design panel. You can also add activities from other palettes to the process, for example, Rendezvous activities.

3. Click Create transition on the TIBCO Designer toolbar to draw transitions between activities in the Design panel.

4. Configure each activity in the process. For configuration information, refer to Oracle E-Business Suite Palette on page 21.

If the Oracle E-Business Suite palette is not shown in the Palette tab, click Palettes > Activities > Oracle E-Business Suite from the menu to make it visible.



Testing a Process

After creating and configuring a process, you can test it in TIBCO Designer. You can check if the process works properly before deploying it. Refer to TIBCO ActiveMatrix BusinessWorks Process Design Guide for detailed information on using test mode.

For processes that contain certain activities, for example, Oracle Business Event, you need to generate an SQL script when configuring the activity. Remember to run the script before testing the process. Refer to Oracle E-Business Suite Palette on page 21 for details.


Deploying a Project | 19

Deploying a Project

To deploy a project that you have configured, you need to generate an Enterprise Archive file (EAR file) that contains configurations for the process definition you want to deploy. You can upload the archive to TIBCO Administrator to deploy the associated application. See TIBCO ActiveMatrix BusinessWorks Administration for more information.

The following is the basic procedure:

1. Save the project in the TIBCO Designer window.

2. Create an enterprise archive by clicking Tools > Create Project EAR from the menu.

3. Add processes defined in the project into the process archive.

4. Build the archive by clicking Build Archive under the Enterprise Archive panel. An enterprise archive (.ear) file is generated by TIBCO Designer which you can then deploy from TIBCO Administrator.

5. Start the TIBCO Administrator and create an application related to the project.

6. Deploy the application and start TIBCO Hawk and the process.


| 21

Chapter 4 Oracle E-Business Suite Palette

This chapter specifies the Oracle E-Business Suite palette, which includes a shared resource and several activities. After you go through this chapter, you will be familiar with the features provided by TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite.

Topics

• Palette Overview, page 22

• Oracle E-Business Suite Connection, page 23

• Oracle API, page 26

• Custom API, page 34

• Oracle Concurrent Program, page 41

• Custom Concurrent Program, page 49

• Oracle Business Event, page 58


22 | Chapter 4 Oracle E-Business Suite Palette

Palette Overview

Palettes organize resources, you can select resources in the Palette tab and drag them into the Design panel to add them into your project. TIBCO Designer contains a small number of native palettes. In addition, each TIBCO application you install that uses TIBCO Designer adds one or more palettes during installation. By installing TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite, the Oracle E-Business Suite palette is added to the Palette tab.

The Oracle E-Business Suite palette contains a shared configuration resource, Oracle E-Business Suite Connection, and five activities, Custom API, Custom Concurrent Program, Oracle API, Oracle Business Event, and Oracle Concurrent Program, as shown in Figure 7.

Figure 7 Oracle E-Business Suite Palette


Oracle E-Business Suite Connection | 23

Oracle E-Business Suite ConnectionShared Configuration

The Oracle E-Business Suite Connection resource contains the information that is necessary to establish a connection pool to the Oracle E-Business Suite server and is used by the activities to obtain connections to the server.

ConfigurationFigure 8 shows a sample Oracle E-Business Suite Connection configuration screen.

Figure 8 Oracle E-Business Suite Connection Configuration

The Configuration tab contains the following fields.

Table 2 Oracle E-Business Suite Connection Configuration Fields

Field Global Var? Description

Name No The name of the resource. The default is OracleEBSConnection.

Description No Information about the connection that you want to store in the project.



Database URL Yes The standard Oracle JDBC connection string. For example, jdbc:oracle:thin:@192.168.70.47:1521:vis.

APPS User Name

Yes The user name of an Oracle E-Business Suite application administrator used to access Oracle E-Business Suite.

For Oracle E-Business Suite 12.2.x, the apps user is used to connect to the database server for all the plug-in activities at design time, get the version number of Oracle E-Business Suite for the Oracle API, Custom API, and Oracle Business Event activities at run time, and run the Oracle API and Custom API activities at run time.

For Oracle E-Business Suite 12.1.x and 12.0.x, the apps user is used to connect to the database server for all the plug-in activities at design time and get the version number of Oracle E-Business Suite for the Oracle API, Custom API, and Oracle Business Event activities at run time, and the plug-in user is used to run all the plug-in activities at run time.

APPS User Password

Yes The password of an Oracle E-Business Suite application administrator used to access Oracle E-Business Suite.

Plug-in User Name

Yes The user name used to run the plug-in activities at run time.

For Oracle E-Business Suite 12.2.x, the plug-in user is used to run the Oracle Concurrent Program, Custom Concurrent Program, and Oracle E-Business Event activities at run time.

For Oracle E-Business Suite 12.1.x, the plug-in user is used to run all the plug-in activities at run time.

Note: For Oracle E-Business Suite 11.5.10, you must enter the apps user name in this field for the Custom API activity.

Plug-in User Password

Yes The password of the plug-in user used to run plug-in activities at run time.

Note: For Oracle E-Business Suite 11.5.10, you must enter the apps user password in this field for the Custom API activity.

Table 2 Oracle E-Business Suite Connection Configuration Fields (Cont’d)



Oracle E-Business Suite Connection | 25

Test Connection The Test Connection button is used to test whether the connection to Oracle E-Business Suite can be established. This will test whether the JDBC libraries are correctly referenced and whether the provided credentials are correct.

Maximum Number of Reconnect Attempts

Yes The maximum number of reconnection attempts to make when the connection is lost.

The default value is 3.

Note: If you set the value of this field to -1, the plug-in will attempt to reconnect to Oracle E-Business Suite indefinitely once a connection fails.

Interval between Reconnect Attempts(ms)

Yes The time interval in milliseconds to elapse between each reconnection attempt.

The default value is 5000 milliseconds.

Maximum Connections

Yes The maximum number of connections between the plug-in and Oracle E-Business Suite that are maintained in the plug-in connection pool. The importance of this number becomes clear at run time. When a project has more than one process simultaneously triggered at run time, the processes may need to request more connections than are allowed by the maximum number. In this case some processes will be suspended until free connections are released.

The default value is 3.

Login Timeout(s)

Yes The timeout interval required to log in.

The default value is 30 seconds.

Table 2 Oracle E-Business Suite Connection Configuration Fields (Cont’d)




Oracle APIActivity

You can use the Oracle API activity to call the PL/SQL APIs that are listed in the Oracle Integration Repository. This activity can inspect the Integration Repository for parameter input and output information and present this information in a friendly user interface for configuration.

The Oracle API activity provides the following functions:

• At design time

— Loads the PL/SQL procedure information from Oracle Integration Repository.

— Saves this information to a file.

• At run time

— Loads the PL/SQL procedure information from the file.

— Generates a calling SQL statement.

— Calls the PL/SQL procedure.

ConfigurationFigure 9 and Figure 10 show sample Oracle API configuration screens.

Oracle Integration Repository is shipped with Oracle E-Business Suite 12.0.x , 12.1.x, and 12.2.x, thus the Oracle API activity is applicable in these versions. Refer to Appendix D, Introduction to Oracle Integration Repository, on page 137 for details on Oracle Integration Repository.

A comparison between Oracle API activity and Custom API activity is provided in Appendix B, Oracle API and Custom API Comparison, on page 123.


Oracle API | 27

Figure 9 Oracle API Configuration: Wrapper Package not Needed

Figure 10 Oracle API Configuration: Wrapper Package Needed

The API Procedure Name label in the Configuration tab refers to the API procedure or function. It is labeled as API Procedure Name due to the limited space available.

When conducting searches for the API Package Name, API Procedure Name, Wrapper Package Name, and Wrapper Procedure Name, ensure that you provide the name prefixes, or as much as you know about the name into the name fields before clicking the Search buttons in order to reduce the search time.




Table 3 Oracle API Configuration Fields


Name No The name of the resource. The default is OracleAPI.

Description No Information about the activity that you want to store in the project.

Shared Connection

No The path to the shared configuration resource containing the Oracle E-Business Suite connection information. Click Browse to open the Select a Resource dialog. All usable connections are listed in the dialog. Select one to apply to your current activity.

Note: Before running the Oracle API activity, ensure that the apps user name that you specified in the Shared Connection is correct.

API Package Name

No The business service interface that is exposed by Oracle E-Business Suite. Click Search Package and select a package from the Package List.

API Procedure Name

No A procedure from the API Package. Click Search Procedure and select a procedure from the Procedure List.

Wrapper Package Name

No The name given to a package of wrapper procedures or functions. Some business objects in the Oracle database cannot be accessed via the Oracle JDBC driver directly. This field is shown only when a wrapper package is needed. In this case you will need to create the wrapper package first using Oracle JPublisher. Refer to Appendix E, Introduction to Oracle Database JPublisher, on page 145 for details on how to create a wrapper package using JPublisher. Click Search Package and select a package from the Package List.

Wrapper Procedure Name

No The name given to a wrapper procedure or function used to delegate an API procedure or function. This field is shown only when a wrapper procedure or function is needed. Click Search Procedure and select a procedure from the Procedure List.

Call Procedure Timeout(s)

Yes The maximum waiting time for calling the procedure. The default is 60 seconds. If the procedure call exceeds this limit, the attempt will be stopped.

Entering 0 will result in an unlimited waiting time.


Oracle API | 29

Generate SQL Script

After configuring the Oracle API activity, click Generate SQL Script, as shown in Figure 9.

Two SQL scripts named Process Name_Activity Name_API Package Name.API Procedure Name.sql and Process Name_Activity Name_API Package Name.API Procedure Name_undo.sql are created in the TIBCO_HOME/bw/plugins/oracleebs/sql directory.

Run SQL Script

Run the Process Name_Activity Name_API Package Name.API Procedure Name.sql script in the Oracle database that the plug-in connected to before starting the process in which the Oracle API activity has been added.

Show Parameter Details

No Select this check box to show the PLSQL API Details tab.

When specifying API Package Name, API Procedure Name, Wrapper Package Name, and Wrapper Procedure Name, always click Search Package or Search Procedure even if you know the names. By selecting a Package Name or a Procedure Name from their respective lists, certain background operations will be executed.

Table 3 Oracle API Configuration Fields (Cont’d)


For Oracle E-Business Suite 12.2.x, the plug-in uses the apps user to run the Oracle API activity at run time, therefore you do not have to generate and run the sql script.

For Oracle E-Business Suite 12.1.x and 12.0.x, the plug-in uses the plug-in user to run the Oracle API activity at run time, therefore you have to generate and run the sql script to grant privileges to the plug-in user so that it can access the objects being configured. The plug-in uses the apps user entered in the Oracle E-Business Suite Connection shared resource to get the information to generate this script. Once this script is executed, the plug-in user will be able to access the tables and procedures configured for the activity.

The script with the _undo suffix reverses the privilege grants thus undoing the changes to the database. This permits the cleansing of the privileges for objects that are no longer used by obsolete or unwanted activities.



PrerequisiteThe Prerequisite tab is used to call some Set Client Info and Initialization procedures before calling the main procedure picked in the Configuration tab. You can add new procedure calls and their corresponding package information in the Prerequisite tab. When the procedure needs to be wrapped, you should enter a wrapper package and select a procedure for the wrapper package.

PLSQL API Details

Figure 11 and Figure 12 show samples of the PLSQL API Details screen.

Figure 11 PLSQL API Details: Without Wrapper Package

Figure 12 PLSQL API Details: With Wrapper Package

If the procedure name for the wrapper package contains a single dollar sign ($), the $ in the procedure name will be converted to a hyphen (-) in the Input and Output tabs.

Select the Show Parameter Details check box in the Configuration tab to make the PLSQL API Details tab visible.


Oracle API | 31

The Parameter Name, Parameter Type, and Parameter Direction columns of the API procedure and Wrapper procedure (if wrapper procedure exists) in the PLSQL API Details tab are configured in the Configuration tab.

If the API procedure contains parameters of PLSQL data type, such as PLSQL record type, and PLSQL table type which defined in the PLSQL package and BOOLEAN type, the plug-in requires the related wrapper package and procedure generated from Oracle JPublisher. And you should execute the wrapper SQL generated by JPublisher under apps user.

The Parameter Direction column shows whether the parameter is an input, output or both for the API procedure.

InputFigure 13 shows a sample Oracle API Input screen.

Figure 13 Oracle API Input

I The Return parameter in the PLSQL API Details tab, as Figure 11 shows, specifies that GL_JOURNAL_IMPORT_PKG.GET_LAST_SQL is an Oracle database function, and the return value can be used as an output.



The Input tab lists the input data for the activity. All the parameters of the API procedure or Wrapper procedure with the Parameter Direction IN or IN/OUT in the PLSQL API Details tab are listed in the Activity Input column.

OutputFigure 14 shows a sample Oracle API Output screen.

Figure 14 Oracle API Output

The Arguments node in the Output tab lists all the parameters of the API procedure or Wrapper procedure with the Parameter Direction OUT or IN/OUT in the PLSQL API Details tab. The Error_Messages node lists the FND (Oracle Application Object Library) error message when the API encounters error in the Oracle E-Business Suite System.

Error OutputFigure 15 shows a sample Oracle API Error Output screen.

The parameters listed in the Activity Input column can be configured manually or automatically by defining a global variable.

For example, bom_bill_item is a global variable defined by user, and its value is TIB_MainMachine, as shown in Figure 13.

You can click Open Advanced Editor in the Global Variables panel to define a global variable.


Oracle API | 33

Figure 15 Oracle API Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity.

Table 4 Oracle API Error Output

Exception Cause

OracleEBSPluginAQConnectionException

Occurs when:

AQ Connection does not initialize.

a JMSException happens during an incoming message delivery.

OracleEBSPluginConnectionNotFoundException

Occurs when the connection can not be created.

OracleEBSPluginSQLException

Occurs when an SQL Exception happens.

OracleEBSPluginTimeoutException

Occurs when calling the procedure for PLSQL API.



Custom APIActivity

The Custom API activity provides the ability to call packages created by the customer to integrate with Oracle E-Business Suite that's not been registered with the Oracle Integration Repository. In such cases, the metadata that defines this package is not contained in the Oracle Integration Repository. The plug-in will instead use Oracle Database Dictionary to get detailed information about this API.

The Custom API activity provides the following functions:

• At design time

— Loads PL/SQL procedure information from Oracle Database Dictionary.

— Saves this information to a file.

• At run time

— Loads PL/SQL procedure information from the file.

— Generates a calling SQL statement.

— Calls the PL/SQL procedure.

ConfigurationFigure 16 and Figure 17 show sample Custom API Configuration screens.

Custom API is applicable in Oracle E-Business Suite 11.5.10, 12.0.x, 12.1.x, and 12.2.x.

A comparison between Oracle API and Custom API is provided in Appendix B, Oracle API and Custom API Comparison, on page 123.

If you create a Custom API, and register it into the Integration Repository, it becomes a regular Oracle E-Business Suite API and will be treated as such.


Custom API | 35

Figure 16 Custom API Configuration: Wrapper Package not Needed

Figure 17 Custom API Configuration: Wrapper Package Needed


Table 5 Custom API Configuration Fields


Name No The name of the resource. The default is CustomAPI.




Shared Connection


Note: Before running the Custom API activity, ensure that the apps user name that you specified in the Shared Connection is correct.

API Package Name

No The business service interface that is defined by the custom on the base of Oracle Data Directory.

Click Search Package and select a package from the Package List.

API Procedure Name

No Specify the API procedure to invoke. Click Search Procedure and select a procedure from the Procedure List.

Wrapper Package Name

No The name given to a package of wrapper procedures or functions. Some business objects in the Oracle database cannot be accessed via the Oracle JDBC driver directly. This field is shown only when a wrapper package is needed. In this case you will need to create the wrapper package first using Oracle JPublisher. Refer to Appendix E, Introduction to Oracle Database JPublisher, on page 145 for details on how to create a wrapper package using JPublisher. Click Search Package and select a package from the Package List.

Wrapper Procedure Name

No The name given to a wrapper procedure or function used to delegate an API procedure or function. This field is shown only when a wrapper procedure or function is needed. Click Search Procedure and select a procedure from the Procedure List.

Call Procedure Timeout(s)

Yes The maximum waiting time for calling the procedure. The default is 60 seconds. If the procedure call exceeds this limit, the attempt will be stopped.

Entering 0 will result in an unlimited waiting time.

Show Parameter Details

No Select this check box to show the PLSQL API Details tab.

Table 5 Custom API Configuration Fields (Cont’d)



Custom API | 37

Generate SQL Script

After configuring the Custom API, click Generate SQL Script, as shown in Figure 16.

Two SQL scripts named Process Name_Activity Name_API Package Name.API Procedure Name.sql and Process Name_Activity Name_API Package Name.API Procedure Name_undo.sql are created in the TIBCO_HOME/bw/plugins/oracleebs/sql directory.

Run SQL Script

Run the Process Name_Activity Name_API Package Name.API Procedure Name.sql script in the Oracle database that the plug-in is connected to before starting the process in which the Custom API activity is added.

When specifying API Package Name, API Procedure Name, Wrapper Package Name, and Wrapper Procedure Name, always click Search Package or Search Procedure even if you know the names. By selecting a Package Name or a Procedure Name from their respective lists, certain background operations will be executed.

For Oracle E-Business Suite 12.2.x and 11.5.10, the plug-in uses the apps user to run the Custom API activity at run time, therefore you do not have to generate and run the sql script.

For Oracle E-Business Suite 12.1.x and 12.0.x, the plug-in uses the plug-in user to run the Custom API activity at run time, therefore you have to generate and run the sql script to grant privileges to the plug-in user so that it can access the objects being configured. The plug-in uses the apps user entered in the Oracle E-Business Suite Connection resource to get the information to generate this script. Once this script is executed, the plug-in user will be able to access the tables and procedures configured for the activity.




PrerequisiteThe Prerequisite tab is used to call some Set Client Info and Initialization procedures before calling the main procedure picked in the Configuration tab. You can add new procedure calls and their corresponding package information in the Prerequisite tab. When the procedure needs to be wrapped, you should enter a wrapper package and select a procedure for the wrapper package.

PLSQL API DetailsFigure 18 shows a sample PLSQL API Details screen.

Figure 18 PLSQL API Details

The Parameter Name, Parameter Type, and Parameter Direction columns of the API procedure in the PLSQL API Details tab are configured in the Configuration tab. The Parameter Direction column shows whether the parameter is an input, output or both for the API procedure.

InputThe Input tab lists the input data for the activity.

If the procedure name for the wrapper package contains a single dollar sign ($), the $ in the procedure name will be converted to a hyphen (-) in the Input and Output tabs.


Custom API | 39

Figure 19 Custom API Input

OutputThe Output tab lists the output data for the activity.

Figure 20 Custom API Output

The Arguments node in the Output tab lists all the parameters of the API procedure or Wrapper procedure with the Parameter Direction OUT or IN/OUT in the PLSQL API Details tab. The Error_Messages node lists the FND error message when the API encounters error in the Oracle E-Business Suite System.

Error OutputFigure 21 shows a sample Custom API Error Output screen.



Figure 21 Custom API Error Output


Table 6 Custom API Error Output

Exception Cause


Occurs when:




Occurs when the connection cannot be created.



OracleEBSPluginTimeoutException

Occurs when calling the procedure for PLSQL API.


Oracle Concurrent Program | 41

Oracle Concurrent ProgramActivity

You can use the Oracle Concurrent Program activity to populate Oracle interface tables, execute Concurrent Programs, and retrieve status information about the execution. This activity can inspect the Integration Repository for the schema of the interface tables for the selected Concurrent Programs as well as the parameters required to execute the Concurrent Program and present this information in a friendly user interface for configuration.

The Oracle Concurrent Program activity provides the following functions:

• At design time

— Loads Concurrent Program parameters from the FND table.

— Loads Inbound Interface Tables or Views from Oracle Integration Repository.

— Saves the information to a file.

• At run time

— Loads Concurrent Program parameters and Interface Tables or Views from the file.

— Uses JDBC to insert data into Interface Tables or Views.

— Uses JDBC to submit a Concurrent Program request.

ConfigurationFigure 22 shows a sample Oracle Concurrent Program Configuration screen.

Oracle Concurrent Program is applicable in Oracle E-Business Suite 12.0.x, 12.1.x, and 12.2.x. Refer to Appendix D, Introduction to Oracle Integration Repository, on page 137 for details on Oracle Integration Repository.

A comparison between Oracle Concurrent Program and Custom Concurrent Program is provided in Appendix C, Oracle Concurrent Program and Custom Concurrent Program Comparison, on page 125.



Figure 22 Oracle Concurrent Program Configuration


Table 7 Oracle Concurrent Program Configuration Fields


Name No The name of the resource. The default is OracleConcurrentProgram.


Shared Connection


Note: Before running the Oracle Concurrent Program activity, ensure that the plug-in user name that you specified in the Shared Connection is correct.



Language No The language that the Oracle E-Business Suite user interface is shown in. Click Search Language to open the Installed Language List dialog. All the languages that are installed in Oracle E-Business Suite are listed in the dialog. Select one to apply to your current activity. The contents of the Concurrent Program Name, Responsibility Name, and Output will change accordingly.

Concurrent Program Name

No Programs that can be called by a concurrent manager. Click Search Concurrent Program Name and select a Concurrent Program from the Concurrent Program List.

Responsibility Name

No A responsibility is a level of authority in Oracle E-Business Suite that lets users access only those functions and data appropriate to their roles in the organization. Click Search Responsibility Name and select a responsibility name from the Responsibility Name List.

User Name No The name of the user whose information is stored in Oracle E-Business Suite. Click Search User Name and select a user name from the User Name List.

Concurrent Request

No If this check box is selected, the plug-in will insert records into interface tables and submit the concurrent request. Otherwise the plug-in will only insert records into interface tables.

Wait for Response

No Select this check box if you want the Concurrent Program to retrieve the REQUEST_ID, PHASE, STATUS, and MESSAGE information, which will be shown in the Output tab. If this check box is not selected, the response time will be shorter, but only the REQUEST_ID will be retrieved.

Check Interval(s)

Yes This field shows the time interval for checking the result of executing the Concurrent Program. The default is 15 seconds.

Note: When running the Oracle Concurrent Program activity, if the total wait time that you set for checking the result of the Concurrent Program activity is shorter than the check interval time, the plug-in will still check the result at least once. Actually, the total wait time is equal to the check interval time.

Table 7 Oracle Concurrent Program Configuration Fields (Cont’d)




Generate SQL Script

After configuring the Oracle Concurrent Program, click Generate SQL Script, as shown in Figure 22.

Two SQL scripts named Process Name_Activity Name_Concurrent Program Name.sql and Process Name_Activity Name_Concurrent Program Name_undo.sql are created in the TIBCO_HOME/bw/plugins/oracleebs/sql directory.

Wait Time(s) Yes This field shows the total amount of time allowed for checking the result of executing the Concurrent Program. The time set in this field should be a multiple of the time set in the Check Interval(s) field. The default is 0, which means the plug-in will wait until the Concurrent Program execution is completed.

Show Concurrent Program Details

No Select this check box to show the Concurrent Program Details tab.

When specifying Concurrent Program Name, Responsibility Name, and User Name, always click search even if you know the names. By selecting a Concurrent Program Name, Responsibility Name, or User Name in their respective lists, certain background operations will be executed.

If the execution of the Concurrent Program takes a significant time, you can clear the Wait for Response check box, and just get the REQUEST_ID in the Output tab. Or it is a good practice that you select the Wait for Response check box, and set the Wait Time(s) field to a limited time, therefore Concurrent Program will return the output data no matter the execution of the Concurrent Program is completed or not.

Table 7 Oracle Concurrent Program Configuration Fields (Cont’d)


The plug-in generates these scripts to grant privileges to the plug-in user so that it can access the objects being configured. It uses the apps user entered in the Oracle E-Business Suite Connection resource to get information to generate this script. Once this script is executed, the plug-in user will be able to access the tables and procedures configured for the activity.




Run SQL Script

Run the Process Name_Activity Name_Concurrent Program Name.sql script in the Oracle database that the plug-in is connected to before starting the process in which the Oracle Concurrent Program activity is added.

Concurrent Program DetailsFigure 23 shows a sample Oracle Concurrent Program Details screen.

Figure 23 Oracle Concurrent Program Details

The FND_REQUEST.OPTION and FND_REQUEST.SUBMIT_REQUEST procedures in the plug-in user schema and the related Interface Tables or Views (if they exist) are displayed in this tab.

InputThe Input tab lists the input data for the activity. The parameters in the Activity column correspond to those shown in the Concurrent Program Details tab, with the following exceptions: application, program, description, start_time, and sub_request.

Select the Concurrent Request check box in the Configuration tab to show FND_REQUEST.SUBMIT_REQUEST.



Figure 24 Oracle Concurrent Program Input

OutputThe Output tab lists the output information for the activity. If the Wait for Response check box is selected in the Configuration tab, the REQUEST_ID, PHASE, STATUS, and MESSAGE information will all be displayed in this tab. Otherwise, only the REQUEST_ID will be retrieved.

The ResponsibilityName and UserName are dynamic parameters. They are configured in the Configuration tab. The plug-in also supports the ability to change the ResponsibilityName and UserName parameters in the Input tab during run time.

It should be noted that the parameters set in the Input tab takes precedence over those set in the Configuration tab.

If you clear the Concurrent Request check box in the Configuration tab, the output will be empty.



Figure 25 Oracle Concurrent Program Output: Wait for Response Enabled

Error OutputFigure 26 shows a sample Oracle Concurrent Program Error Output screen.

Figure 26 Oracle Concurrent Program Error Output




Table 8 Oracle Concurrent Program Error Output

Exception Cause


Occurs when:








Custom Concurrent Program | 49

Custom Concurrent ProgramActivity

You can use the Custom Concurrent Program activity to call custom concurrent programs written to integrate with Oracle E-Business Suite that are not registered with the Oracle Integration Repository. In this case, the plug-in activity will require the user to specify more information about the concurrent program and interface tables. Once this information is provided, you can easily configure the plug-in activity through the user interface.

The Custom Concurrent Program activity provides the following functions:

• At Design time

— Loads Concurrent Programs from the FND table.

— Selects Interface Tables or Views from the database manually.

— Saves the information to a file.

• At run time

— Loads the Concurrent Program parameters and Interface Tables or Views from the file.

— Uses JDBC to insert data into Interface Tables.

— Uses JDBC to submit a Concurrent Program request.

ConfigurationFigure 27 shows a sample Custom Concurrent Program Configuration screen.

Custom Concurrent Program is applicable in Oracle E-Business Suite 11.5.10, 12.0.x, 12.1.x, and 12.2.x.

A comparison between Oracle Concurrent Program and Custom Concurrent Program is provided in Appendix C, Oracle Concurrent Program and Custom Concurrent Program Comparison, on page 125.

If you create a Custom Concurrent Program, and register it into the Integration Repository, it becomes a regular Oracle Concurrent Program and will be treated as such.



Figure 27 Custom Concurrent Program Configuration


Table 9 Custom Concurrent Program Configuration Fields


Name No The name of the resource.

The default is CustomConcurrentProgram.


Shared Connection


Note: Before running the Custom Concurrent Program activity, ensure that the plug-in user name that you specified in the Shared Connection is correct.



Language No The language that the Oracle E-Business Suite user interface is shown in. Click Search Language to open the Installed Language List dialog. All the languages that are installed in Oracle E-Business Suite are listed in the dialog. Select one to apply to your current activity. The contents of the Concurrent Program Name, Responsibility Name, and Output will change accordingly.

Concurrent Program Name

No Programs that can be called by a concurrent manager. Click Search Concurrent Program Name and select a Concurrent Program from the Concurrent Program List.

Responsibility Name

No A responsibility is a level of authority in Oracle E-Business Suite that lets users access only those functions and data appropriate to their roles in the organization. Click Search Responsibility Name and select a responsibility name from the Responsibility Name List.

User Name No The name of the user whose information is stored in Oracle E-Business Suite. Click Search User Name and select a user name from the User Name List.

Concurrent Request

No If this check box is selected, the plug-in will insert records into interface tables and submit the concurrent request. Otherwise the plug-in will only insert records into interface tables.

Wait for Response

No Select this check box if you want the Concurrent Program to retrieve the REQUEST_ID, PHASE, STATUS, and MESSAGE information, which will be shown in the Output tab. If this check box is not selected, the response time will be shorter, but only the REQUEST_ID will be retrieved.

Check Interval(s)

Yes This field shows the time interval for checking the result of executing the Concurrent Program.

The default is 15 seconds.

Note: When running the Custom Concurrent Program activity, if the total wait time that you set for checking the result of the Concurrent Program activity is shorter than the check interval time, the plug-in checks the result of the activity at least once. Actually, the total wait time is equal to the check interval time.

Table 9 Custom Concurrent Program Configuration Fields (Cont’d)




Interface Table Configuration

Click this button in the Configuration tab to add the Interface Tables or Views (if they exist) related to the Concurrent Program, as shown in Figure 28.

Wait Time(s) Yes This field shows the total amount of time allowed for checking the result of executing the Concurrent Program. The time set in this field should be a multiple of the time set in the Check Interval(s) field. The default is 0, which means the plug-in will wait until the Concurrent Program execution is completed.

Show Concurrent Program Details

No Select this check box to show the Concurrent Program Details tab.

When specifying Concurrent Program Name, Responsibility Name, and User Name, always click search even if you know the names. By selecting a Program Name, a Responsibility Name, or a User Name from their respective lists, certain background operations will be executed.

If the execution of the Concurrent Program takes a significant time, you can clear the Wait for Response check box, and just get the REQUEST_ID in the Output tab. Or it is good practice that you select the Wait for Response check box, and set the Wait Time(s) field to a limited time, therefore Concurrent Program will return the output data no matter the execution of the Concurrent Program is completed or not.

Table 9 Custom Concurrent Program Configuration Fields (Cont’d)




Figure 28 Custom Concurrent Program Configuration: Interface Table Configuration

Generate SQL Script

After configuring the Custom Concurrent Program, click Generate SQL Script as shown in Figure 27.

Two SQL scripts named Process Name_Activity Name_Concurrent Program Name.sql and Process Name_Activity Name_Concurrent Program Name_undo.sql are created in the TIBCO_HOME/bw/plugins/oracleebs/sql directory.

Run SQL Script

Run the Process Name_Activity Name_Concurrent Program Name.sql script in the Oracle database that the plug-in is connected to before starting the process in which this Oracle Concurrent Program activity is added.

Different with the Oracle Concurrent Program, Integration Repository does not provide the relevant information of Interface Table for Custom Concurrent Program, therefore, you should get such information from custom defined Interface Table configured in the Interface Table Configuration figure, as shown in Figure 28, or from Oracle documentation and Oracle Support.

For Oracle E-Business Suite 12.2.x, 12.1.x, 12.0.x, and 11.5.10, the plug-in uses the plug-in user to run the Custom Concurrent Program activity at run time, therefore you have to generate and run the sql script to grant privileges to the plug-in user so that it can access the objects being configured. The plug-in uses the apps user entered in the Oracle E-Business Suite Connection resource to get information to generate this script. Once this script is executed, the plug-in user will be able to access the tables and procedures configured for the activity.




Concurrent Program Details

Figure 29 shows a sample Concurrent Program Details screen.

Figure 29 Custom Concurrent Program Details

The FND_REQUEST.SUBMIT_REQUEST procedure and the Interface Tables or Views are displayed in this tab.

InputThe Input tab lists the input data for the activity. The parameters in the Activity Input column correspond to those shown in the Concurrent Program Details tab, with the following exceptions: application, program, description, start_time, and sub_request.

Select the Show Concurrent Program Details check box in the Configuration tab to make the Concurrent Program Details tab visible.

The FND_REQUEST.SUBMIT_REQUEST procedure is shown only when you select the Concurrent Request check box in the Configuration tab. The parameters of the FND_REQUEST.SUBMIT_REQUEST procedure, argument1 to argument100, are listed without showing the name of each parameter or whether the parameter is required. This is the standard implementation for FND_REQUEST.SUBMIT_REQUEST procedure. User can find the real arguments by the scripts in the Custom Concurrent Program example. Also, for non-SRS Concurrent Programs, you must use this standard way. Refer to Appendix C, Oracle Concurrent Program and Custom Concurrent Program Comparison, on page 125 for more details.



Figure 30 shows a sample Custom Concurrent Program Input screen.

Figure 30 Custom Concurrent Program Input

OutputThe Output tab lists the output information for the activity. If the Wait for Response check box is selected in the Configuration tab, the REQUEST_ID, PHASE, STATUS, and MESSAGE information will all be displayed in this tab. Otherwise only the REQUEST_ID will be retrieved.

The ResponsibilityName and UserName are dynamic parameters. They are configured in the Configuration tab. The plug-in also supports the ability to change the ResponsibilityName and UserName parameters in the Input tab during run time.

It should be noted that the parameters set in the Input tab takes precedence over those set in the Configuration tab.

If you clear the Concurrent Request check box in the Configuration tab, the output will be empty.



Figure 31 Custom Concurrent Program Output

Error OutputFigure 32 shows a sample Custom Concurrent Program Error Output screen.

Figure 32 Custom Concurrent Program Error Output




Table 10 Custom Concurrent Program Error Output

Exception Cause


Occurs when:









Oracle Business EventActivity

A business event represents an action or occurrence triggered by a business process in an application or system. This event may be significant to other programs, applications, processes or external agents. In Oracle E-Business Suite, events can be triggered by business object manipulation (such as an update or change) or by different processes (such as the approval of a purchase order).

The Oracle Business Event activity will listen for an Oracle Business Event triggered in the Oracle E-Business Suite application. Upon the triggering of this event, the activity will pull the event data from the Oracle event queue and make the data available to the TIBCO environment. Custom business events configured in Oracle E-Business Suite and registered to the Oracle Integration Repository will be compatible with this activity.

The Oracle Business Event activity provides the following functions:

• At design time

— Generates PL/SQL scripts to help users subscribe a Business Event to a specified Oracle Advance Queue (AQ).

— Connects to the AQ, retrieves an event, and parses the event schema.

• At run time

— Connects to the AQ and listens to the message (event) from AQ.

— Parses the event content.

Configuration TabFigure 33 shows a sample Oracle Business Event configuration screen.


Oracle Business Event | 59

Figure 33 Oracle Business Event Configuration


Table 11 Oracle Business Event Configuration Fields


Name No The name of the activity in the process definition. The default is OracleBusinessEvent.


Shared Connection


Note: Before running the Oracle Business Event activity, ensure that both the apps user name and plug-in user name that you specified in the Shared Connection are correct.

Event Name No The name of the Business Event. Always click Search Event to select an Oracle Business Event from the Oracle Business Event List even if you know the event name. By selecting an Event Name from the List, certain background operations will be executed. The Business Event can be checked in Oracle E-Business Suite. There are two types of Business Events, Event and Group. Only the Event type Business Events are supported in this release.



Advanced Configuration

Click Advanced Configuration to show the Advanced Configuration dialog box.

Figure 34, Figure 35, Figure 36, and Figure 37 show samples Oracle Business Event Advanced Configuration screens.

Figure 34 Oracle Business Event Advance Configuration: Creating a New Agent

Figure 35 Oracle Business Event Advance Configuration: Selecting an Existing Agent



Figure 36 Oracle Business Event Advanced Configuration: Creating a Multiple Consumer

Figure 37 Oracle Business Event Advance Configuration: Selecting an Existing Multiple Consumer

The Advanced Configuration window contains the following fields.

Table 12 Oracle Business Event Advanced Configuration Fields


Select an existing agent?

No Select this check box to use an existing agent. If this check box is selected, the Agent Name, Queue Name, and Queue Table Name fields will gray out and the Select Agent button will be applicable.

Agent Name No Enter a name for the Agent that you intend to create to receive messages from Oracle Business Event System.

Queue Name No Enter a name for the Queue to receive messages from the Agent.



When a Business Event is triggered in Oracle E-Business Suite, the plug-in will listen to the event.

• If you want this event message to be received by only one consumer, create a new set of Agent, Queue, and Queue Table for the subscription, or use an existing set of Agent, Queue, and Queue Table for the same Business Event.

— To create a new set of Agent, Queue, and Queue Table, give their names in their respective fields and uncheck the Select An Existing Agent check box, as shown in Figure 34. The Agent, Queue, and Queue Table will be created in Oracle E-Business Suite after running the SQL script that will be generated according to the instructions provided in Generate SQL Script on page 63.

— To use an existing set of Agent, Queue, and Queue Table, select the Select An Existing Agent check box. In this case, the Agent Name, Queue Name, and Queue Table Name fields will gray out and the Select Agent button will be applicable. Click Select Agent to select an existing Agent for the subscription, and the related Queue and Queue Table will be obtained simultaneously, as shown in Figure 35.

• If you want the event message to be received by multiple consumers, you should first create a set of Agent, Queue, and Queue Table for the subscription of event messages.

— To create a new set of Agent, Queue, and Queue Table for the subscription of event messages to be received by multiple consumers, uncheck the Select

Queue Table Name

No Enter a name for the Queue Table.

Multiple Consumer

No Select this check box if you want the message to be consumed by multiple subscribers. In this case, the message will be propagate using the topic method. Otherwise it will be propagated using the queue method.

Subscriber Name

No Enter a name of the subscriber you want to consume the message or click Select Subscriber to select an existing subscriber. This field is applicable only when the Multiple Consumer check box is selected.

When giving values for the Agent Name, Queue Name, Queue Table Name, and Subscriber Name, the input will be capitalized automatically.

Table 12 Oracle Business Event Advanced Configuration Fields (Cont’d)




An Existing Agent check box and give the names for Agent, Queue, and Queue Table in their respective fields. Select the Multiple Consumer check box and give a name for the subscriber that will receive the event message in the specific configuration, as shown in Figure 36. The Agent, Queue, Queue Table, and Subscriber will be created in Oracle E-Business Suite after running the SQL script that will be generated as shown in Generate SQL Script on page 63.

— To use this set of Agent, Queue, and Queue Table in other configurations, for example, Figure 37, select the Select An Existing Agent check box and then choose this Agent. The related Queue and Queue Table will also be obtained simultaneously. Give a name for the subscriber. It will be created in Oracle E-Business Suite after running the SQL script that will be generated as shown in Generate SQL Script on page 63. This subscriber can then receive messages from the same set of Agent, Queue, and Queue Table.

Generate SQL Script

After configuring the Oracle Business Event, click Generate SQL Script, as shown in Figure 33.

Two SQL scripts named Process Name_Activity Name_Event Name.sql and Process Name_Activity Name_Event Name_undo.sql are created in the TIBCO_HOME/bw/plugins/oracleebs/sql directory.

Run SQL Script

Run the Process Name_Activity Name_Event Name.sql script before starting the process that this Oracle Business Event is added to.

Get Event AttributesThe attributes of an Oracle Business Event will be parsed from XML format and displayed in this tab.

The script generated creates the necessary infrastructure that make the event available for use by the plug-in Oracle Business Event activity without having to manually configure this event in Oracle E-Business Suite. This involves the creation of a subscription, an agent, and the required linking of the Oracle business event to these entities. The second script generated revokes all the changes brought by the creation script, permitting a rollback of the changes to the database by this activity.



Figure 38 Oracle Business Event Attributes

MiscThe Misc tab contains the following fields.

OutputThe Output tab lists the output information for the activity.

Table 13 Oracle E-Business Suite Outbound Message Listener Misc Fields

Field Description

Sequencing Key

This field contains an XPath expression that specifies which processes should run and in what order. Process instances with run sequencing keys with identical values will be executed sequentially in the order in which the process instance was created.

See TIBCO BusinessWorks Process Design Guide for more information about controlling the execution order of process instances and about XPath expressions.

Customer Id This field contains an XPath expression that specifies a custom ID for the process instance. This ID is displayed in the View Service dialog of TIBCO Administrator, and it is also available in the $_processContext process variable.



Figure 39 Oracle Business Event Output


| 67

Chapter 5 Using the Sample Project

This chapter introduces the five examples provided with the plug-in installation that demonstrate how the plug-in interacts with TIBCO ActiveMatrix BusinessWorks.

Topics


• Working with the Oracle API Activity, page 69

• Working with the Custom API Activity, page 88

• Working with the Oracle Concurrent Program Activity, page 91

• Working with the Custom Concurrent Program Activity, page 100

• Working with the Oracle Business Event Activity, page 111


68 | Chapter 5 Using the Sample Project

Overview

The sample project provided with the plug-in installation demonstrates the use of the plug-in in dealing with inbound and outbound business objects between the TIBCO environment and Oracle E-Business Suite.

The files for the sample projects are located in the TIBCO_HOME/bw/plugins/oracleebs/examples directory and demonstrate:

• Working with the Oracle API Activity, page 69

• Working with the Custom API Activity, page 88

• Working with the Oracle Concurrent Program Activity, page 91

• Working with the Custom Concurrent Program Activity, page 100

• Working with the Oracle Business Event Activity, page 111


Working with the Oracle API Activity | 69

Working with the Oracle API Activity

In this example, the OracleAPI project demonstrates how to create the Inventory items and the BOM (Bill of Material) bills by Oracle PL/SQL Interface via TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite.

There are two processes configured in the OracleAPI project, prepare_purchased_items process and subassembly_item_and_bom_bill process respectively. In these two processes, BOM Bill, Assembly Item, and Inventory Item are created, as shown in Figure 40.

Figure 40 Sample of the Created BOM Billl

This example requires the use of the Vision Demo environment. It relies on the responsibility, users, and data in the demo installation.

This example is configured to work against the Oracle E-Business Suite Vision Demo Environment. All the inputs are valid under this environment.



Prepare_purchased_items ProcessTo create the Inventory items by TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite, execute the following tasks:

1. Configure the Oracle E-Business Suite Connection.

Refer to Oracle E-Business Suite Connection on page 23 for more details about how to configure the connection.

2. Configure the Oracle API activities.

In this example, there are five activities created, namely, TIB_CPU, TIB_HD, TIB_RAM, TIB_RAM1, and TIB_MAINBOARD.

Figure 41 shows a sample of configuring the TIB_CPU activity in the prepare_purchased_items process.

When configuring each of the activities, if you have switched to different Oracle E-Business Suite version, you must click Search Procedure to reselect the PROCESS_ITEM procedure. This is because the parameter number of the PROCESS_ITEM procedure in the EGO_ITEM_PUB package changes when you connect to different version of Oracle E-Business Suite. In Oracle E-Business Suite 12.1.x, the parameter number of the PROCESS_ITEM procedure is 74, while in Oracle E-Business Suite 12.2.x, the parameter number is 75.

You can create one activity by changing the value of the parameters to generate different items, or you can create several activities at a time to generate different items simultaneously.



Figure 41 TIB_CPU Activity Configuration

3. Generate the SQL Script.

Click Generate SQL Script in the Configuration tab to generate the SQL Script. Refer to Generate SQL Script on page 29 for more details.

4. Configure the input.

Figure 42 shows the TIB_CPU activity input screen.

As defined in Oracle Integration Repository, EGO_ITEM_PUB.PROCESS_ITEM is a convenience wrapper to Process_Item. Use this API to create or update an item by passing only the most important and/or commonly used item attributes.



Figure 42 TIB_CPU Activity Input

There are 75 parameters in EGO_ITEM_PUB.PROCESS_ITEM API in Oracle E-Business Suite 12.2.x, but in Oracle E-Business Suite 12.1.x, there are 74 parameters. In this example, there are 17 parameters configured.

Table 14 shows the type and input of each parameter.

Table 14 Inputs of TIB_CPU Activity

Parameter Type Input

P_API_VERSION NUMBER 1.0

P_INIT_MSG_LIST VARCHAR2 T

P_COMMIT VARCHAR2 T

P_TRANSACTION_TYPE VARCHAR2 CREATE

P_LANGUAGE_CODE VARCHAR2 US

P_TEMPLATE_ID NUMBER 259

P_TEMPLATE_NAME VARCHAR2 Purchased Item

P_ITEM_NUMBER VARCHAR2 TIB_CPU

P_SEGMENT1 VARCHAR2 TIB_CPU

P_ORGANIZATION_ID NUMBER 204

P_ORGANIZATION_CODE VARCHAR2 V1

P_CATALOG_STATUS_FLAG VARCHAR2 N



Figure 43 Define Global Variable

5. Grant privilege to the plug-in user by apps user and create the synonym EGO_ITEM_PUB for apps.EGO_ITEM_PUB under the plug-in user. Issue the SQL script generated in step 3.

P_DESCRIPTION VARCHAR2 TIBCO EBS Plug-in Create CPU item

P_PRIMARY_UOM_CODE VARCHAR2 Ea

P_INVENTORY_ITEM_STATUS_CODE VARCHAR2 Active

P_BOM_ENABLED_FLAG VARCHAR2 Y

P_ENG_ITEM_FLAG VARCHAR2 N

These parameters can be configured manually or automatically by defining a global variable.

You can click Open Advanced Editor in the Global Variables tab to define a global variable, shown as Figure 43.

Table 14 Inputs of TIB_CPU Activity (Cont’d)




Figure 44 shows the command line about how to grant privilege and create the synonym.

Figure 44 Grant Privilege and Create EGO_ITEM_PUB Synonym

6. Run the process.

To run the process in TIBCO Designer, select the process in the Project panel and click Start testing viewed process in the Tester tab.

To check if the process runs successfully, you can check the value of X_RETURN_STATUS in the Output tab. "S" stands for success, and "E" stands for error. In this example, the output for each activity is successful.

7. Check the result in Oracle E-Business Suite.

Log in to the Oracle E-Business Suite System with the user name MFG and password welcome. When you log in to the system, the following steps should be executed to check the result:

a. Select Inventory > Items > Master Items to open the Navigator - Inventory dialog.

b. Double-click the Master Items as show in Figure 45.



Figure 45 Master Items

c. Select V1 organization, and then click OK.



Figure 46 Select V1 Organization in the Prepare_Purchased_items Process

d. Click OK in the Enter Reduction Criteria for Long-List dialog to search for the created items.

Figure 47 shows the screen with notes on the four steps.



Figure 47 Search for the Result of Items

When clicking OK in the Enter Reduction Criteria for Long-List dialog, the result of the created items will pop out. The result is shown in Figure 48.



Figure 48 The Result of the System Items

Subassembly_item_and_bom_bill ProcessTo create the BOM bills by using TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite, execute the following steps:

1. Configure the Oracle E-Business Suite connection.

Refer to Oracle E-Business Suite Connection on page 23 for more details about how to configure the connection..

2. Configure the Oracle API activities.

In this example, there are two activities created, namely, the TIB_MainMachine activity and the OracleAPI activity.

Figure 49 and Figure 50 show the configuration of these two activities in the subassembly_item_and_bom_bill processs.

Note: When configuring the TIB_MainMachine activity, you must click Search Procedure to reselect the PROCESS_ITEM API procedure if you switch to different Oracle E-Business Suite version. This is because the parameter number of the PROCESS_ITEM procedure in the EGO_ITEM_PUB package changes when you connect to the version of Oracle E-Business Suite. In Oracle E-Business Suite 12.1.x, the parameter number of the PROCESS_ITEM procedure is 74, while in Oracle E-Business Suite 12.2.x, the parameter number is 75.



Figure 49 TIB_MainMachine Activity Configuration



Figure 50 OracleAPI Activity Configuration

3. Execute the BOM_BO_PUB.sql file using apps user on the command line.

The BOM_BO_PUB.PROCESS_BOM procedure contains package types, you must use JPublisher to generate wrapper package first. In this example, two sets of PL/SQL files are generated. Execute the BOM_BO_PUB.sql and BOM_BO_PUB_drop.sql files that are located under the OracleAPI\wrapperFile\12_1\ directory if you use Oracle E-Business Suite 12.1.x, and execute the BOM_BO_PUB.sql and BOM_BO_PUB_drop.sql files that are located under the OracleAPI\wrapperFile\12_2\ directory if you use Oracle E-Business Suite 12.2.x, see Figure 51.

As defined in Oracle Integration Repository, you can use the BOM_BO_PUB.PROCESS_BOM method for creating, updating, or deleting entities of a single Structure/BOM. The method takes in a single Structure/BOM Header, all its Components, Revisions, Reference Designators, and Substitute Components.



Figure 51 Wrapper File

Refer to Appendix E, Introduction to Oracle Database JPublisher, on page 145 for more details.

4. Generate the SQL script.

Click Generate SQL Script to generate the SQL script, as shown in Figure 49 and Figure 50. Refer to Generate SQL Script on page 29 for more details.

5. Configure the input of the Oracle API activities.

Figure 52 and Figure 53 show examples of the Subassembly_Item and BOM_Bill input screens respectively.

After using the JPublisher to generate the wrapper package for the BOM_BO_PUB.PROCESS_BOM procedure, if you firstly issue the BOM_BO_PUB.sql, and then issue the BOM_BO_PUB_drop.sql, and afterwards reissue the BOM_BO_PUB.sql and run the process, the "invalid data type error" exception is thrown. To solve this issue, you can restart TIBCO Designer, and then run the process again.



Figure 52 TIB_MainMachine Activity Input

Figure 53 OracleAPI Activity Input

BOM_BO_PUB.PROCESS_BOM (Process Single Structure/BOM) has 21 parameters with the PL/SQL Table types and PL/SQL Record types defined

In this example the value of the global variable bom_bill_item is TIB_MainMachine. It can be used automatically to configure inputs.

Figure 43 shows more details about how to define a global variable.



in the package. Table 15 shows the main parameters and associated inputs of BOM Header, Revision, Components, Reference Designators, and Substitute Components.

6. Grant privilege to plug-in user by apps user and create the synonym TIB_BOM_BO_PUB for apps.TIB_BOM_BO_PUB under plug-in user.

Figure 54 shows more details about how to execute the generated SQL script.

Figure 54 Grant Privilege and Create TIB_BOM_BO_PUB Synonym

7. Run the process.

Table 15 Inputs of BOM_Bill Activity

Parameter Input

P_BOM_HEADER_REC ASSEMBLY_ITEM_NAME TIB_MainMachine

ORGANIZATION_CODE V1

TRANSACTION_TYPE CREATE

P_BOM_REVISION_TBL REVISION B

P_COMPONENT_TBL COMPONENT_ITEM_NAME TIB_CPU or TIB_HD or TIB_RAM or TIB_MAINBOARD

P_BOM_REF_DESIGNATOR_TBL

REF_DESIGNATOR_COMMENT

This is TIBCO CPU

P_BOM_SUB_COMPONENT_TBL

COMPONENT_ITEM_NAME TIB_RAM

SUBSTITUTE_COMPONENT_NAME

TIB_RAM1



To run the process in TIBCO Designer, select the process in the Project panel and click Start testing viewed process in the Tester tab.

To check if the process runs successfully, you can check the value of RETURN_STATUS in the Output tab. "S" stands for success, and "E" stands for error.

Figure 55 shows the output of running the process.

Figure 55 The Output of Running the Process

8. Check the result in Oracle E-Business Suite.

When running the process, if one of the following error messages is displayed for the Oracle API activity, you have to reselect the PROCESS_ITEM procedure in the BOM_BO_PUB package in the Configuration tab:

invalid name pattern: APPS.BOM_BO_PUB_BOM_REF_DESIGNATO9

invalid name pattern: APPS.BOM_BO_PUB_BOM_REF_DESIGNATO2



Log in to the Oracle E-Business Suite web system with the user name MFG and password welcome. When you log in to the system, the following steps should be executed to check the result:

a. Select Manufacturing and Distribution Manager > Bills of Materials: Bills > Bills.

b. Select the V1 organization item and click OK to continue, as shown in Figure 56.

Figure 56 Select V1 Organization in the Subassembly_item_and_bom_bill Process

c. Click the button as shown in Figure 56, enter TIB% in the Item field, and then click Find to review the search result.



Figure 57 Search for the Result of Bills

Figure 58 shows the result in the Oracle E-Business Suite web system.



Figure 58 The Result of the Bills



Working with the Custom API Activity

The CustomAPI project demonstrates how to use the Custom API activity to call a PL/SQL procedure from Oracle Database Dictionary.

Custom API is used to execute the packages that are in Oracle Database Dictionary, but not in Oracle Integration Repository. Custom API is also used to execute customized packages that are created by the customer.

ACCOUNT_MGR Package

The ACCOUNT_MGR package is the test package provided by Oracle that is in Oracle Database Dictionary, but not in Oracle Integration Repository.

Executing the CustomAPI ProjectTo run the CustomAPI project, execute the following steps:

1. Open the CustomAPI project in TIBCO Designer.


Note: If you use the plug-in with Oracle E-Business Suite 11.5.10, you must enter the apps user name in the Plug-in User Name field in the Oracle E-Business Suite Connection for the Custom API activity.

3. Configure the ACCOUNT_MGR package.



Working with the Custom API Activity | 89

Figure 59 CustomAPI Configuration

4. Execute the SQL script.

a. Click Generate SQL Script to generate the SQL script as shown in Figure 59.

b. Execute the SQL script on a command line to grant the execute privilege on ACCOUNT_MGR to the plug-in user.

5. Configure the input of the Custom API activity.

Table 16 lists the inputs of the Custom API activity.

6. Run the example process.

Figure 60 shows the output of this activity.

Table 16 Custom API Activity Inputs


API_VERSION Number 1.0

P_PARTY_ID Number 4509



Figure 60 Sample Custom API Activity: Output


Working with the Oracle Concurrent Program Activity | 91

Working with the Oracle Concurrent Program Activity

The OracleCP project demonstrates how to use the Oracle Concurrent Program WICMLP to call JDBC to insert data into interface tables, and to submit a Concurrent Program request.

WICMLP Concurrent ProgramThe WICMLP Concurrent Program executes the open interface for work orders. It can be used either to create a new job or schedule, or update an existing job or schedule information. It processes the records from the following tables: WIP_JOB_SCHEDULE_INTERFACE, WIP_JOB_DTLS_INTERFACE.

Parameters

Table 17 shows the parameters in the WICMLP Concurrent Program.

Open Interface Tables or Views

Table 18 shows the open interface tables or views.


Table 17 WICMLP Parameters

Name Type Required Displayed Description

Group ID FND_NUMBER15_REQUIRED

Yes Yes Used to batch the interface records.

Validation Level

FND_NUMBER15 Yes No Indicates what validation should be performed.

Print Report WIP_SRS_YES_NO_MAND

Yes Yes Indicates whether the report is printed.

Table 18 WICMLP Open Interface Tables or Views

Name Direction Status Description

WIP_JOB_SCHEDULE_INTERFACE

Inbound Active Contains the requests to create or modify discrete jobs or repetitive schedules.



Executing the OracleCP ProjectIn this example, the plug-in will perform the following tasks:

1. Import the Job Header.

The plug-in inserts the jobs (tib_job01 and tib_job02) into the interface table WIP_JOB_SCHEDULE_INTERFACE.

The name of the jobs (tib_job01 and tib_job02) are defined in the global variable WIP_input.

2. Submit the CP request.

The plug-in submits the CP request.

The request group ID (request_group_id) is defined in the global variable WIP_input. Users can create new jobs with different request group ids by changing the global variable.

To run the OracleCP project, execute the following steps:

1. Open the OracleCP project in TIBCO Designer.


For the information about how to configure the connection, refer to Oracle E-Business Suite Connection on page 23.

3. Configure the WICMLP Concurrent Program.

You have to select a valid responsibility, and then select the user related to that responsibility.

WIP_JOB_DTLS_INTERFACE Inbound Active Contains requests to add, delete, and modify material and/or resource requirements for existing discrete jobs or repetitive schedules.

Table 18 WICMLP Open Interface Tables or Views (Cont’d)

Name Direction Status Description

The responsibility and the user selected in this example are valid in the Vision Demo environment.



Figure 61 WICMLP Configuration


a. Click Generate SQL Script to generate the SQL script, as shown in Figure 61.

b. Execute the SQL script on a command line to grant the insert privilege to the plug-in user for the interface table.

5. Enter the data for the interface table and the concurrent request.

Table 19 lists the inputs of the WICMLP Concurrent Program.

Table 19 WICMLP CP Inputs


Group_ID VARCHAR2 Refer to global variable WIP_input/Request_GroupID

Print_Report VARCHAR2 2



Table 20 lists the important inputs of the interface tables.


To run the process in TIBCO Designer, select the process in the Project panel and click Start testing the viewed process in the Tester tab.

To check if the process runs successfully, you can check the value of STATUS in the Output tab.

Table 20 Interface Tables Inputs


Group_ID Number Refer to global variable WIP_input/Request_GroupID

SOURCE_CODE VARCHAR2 WICDOL

ORGANIZATION_ID NUMBER 207

CLASS_CODE VARCHAR2 Discrete

JOB_NAME VARCHAR2 Refer to global variable WIP_input/JobName1

DESCRIPTION VARCHAR2 Refer to global variable WIP_input/JobName1

ORGANIZATION_CODE VARCHAR2 M1

ROUTING_REVISION VARCHAR2 A

BOM_REVISION VARCHAR2 A

COMPLETION_SUBINVENTORY VARCHAR2 FGI

ALLOW_EXPLOSION VARCHAR2 Y

If you use the Concurrent Program activity to insert the data into the interface table, clear the Concurrent Request check box in Configuration tab. You may also use TIBCO ActiveMatrix BusinessWorks JDBC activity or other tools to insert the records into the interface table.

The Group_ID input value should be identical within the example. Otherwise an empty request will be submitted.



Figure 62 WICMLP CP Output

7. Check the concurrent request result in Oracle E-Business Suite.

a. Log in to the Oracle E-Business Suite application as the MFG user that is the user name defined in configuration.

b. Click Manufacturing and Distribution Manager > Other > Concurrent to open the Find Requests dialog.



Figure 63 WICMLP CP: Find Requests Dialog

c. Click Find to view the search result.

Figure 64 WICMLP CP: Request Result



8. Check the job header in Oracle E-Business Suite.


b. Select Manufacturing and Distribution Manager > Other > Concurrent.

c. Close the Find Requests dialog. In the Navigator-Manufacturing and Distribution Manager dialog, expand WIP > Discrete, and then double-click Discrete Jobs.

d. In the Organizations dialog, select the M1 organization that is defined in input, and then click OK.



Figure 65 WICMLP CP: Select M1 Organization

e. In the Find Discreet Jobs (M1) dialog, enter the tib_job0% in the Find field, and then click Find. The following figure shows the Jobs dialog.



Figure 66 WICMLP CP: Search Results

f. Click OK to view the Discrete Jobs details.

Figure 67 Discrete Jobs (M1) Details



Working with the Custom Concurrent Program Activity

The CustomCP project demonstrates how to use the custom Concurrent Program INCOIN to call JDBC to insert data into interface tables, and to submit a Concurrent Program request.

INCOIN Concurrent ProgramYou can import items from any source into Oracle Inventory and Oracle Engineering using the INCOIN Item Open Interface. With this interface, you can convert inventory items from another inventory system, migrate assembly and component items from a legacy manufacturing system, convert purchased items from a custom purchasing system, and import new items from a product data management package.

Open Interface Tables or Views

The INCOIN Concurrent Program contains 5 interface tables. Table 21 shows the interface tables details.


Table 21 INCOIN Interface Tables

Name Description

INV.MTL_SYSTEMS_ITEM_INTERFACE

Use this table for your new item numbers and all item attributes. This is the main Item Open Interface table. It may be the only table that you choose to use.

INV.MTL_ITEM_REVISIONS_INTERFACE

Use this table if you are importing revision details for your new items. This table is used only for revision information. It is not required.

INV.MTL_ITEM_CATEGORIES_INTERFACE

Use this table to import item category assignments. It stores data about item assignments to category sets, and categories to be imported into the Oracle Inventory MTL_ITEM_CATEGORIES table.

INV.MTL_DESC_ELEM_VAL_INTERFACE

Use this table to describe elements that apply to your item.


Working with the Custom Concurrent Program Activity | 101

Executing the CustomCP ProjectIn this example, the plug-in will execute the following tasks:

1. Import the inventory items.

The plug-in inserts the inventory items into the interface table INV.MTL_SYSTEMS_ITEM_INTERFACE.

2. Submit the CP request.

To run the CustomCP project, execute the following steps:

1. Open the CustomCP project in TIBCO Designer.


For the information about how to configure the connection, refer to Oracle E-Business Suite Connection on page 23.

3. Configure the INCOIN Concurrent Program as shown in Figure 68.

INV.MTL_DESC_ELEM_VAL_INTERFACE

Use this table to record error messages for failed records in the interface table.

This example only uses the INV.MTL_SYSTEMS_ITEM_INTERFACE table to import the items.

The open interface is not exposed in Oracle E-Business Suite Integration Repository, therefore you must go through the EBS Plug-in Custom Concurrent program activity to access it. You need to implement this activity using the standard parameters for calling FND_REQUEST.SUBMIT_REQUEST. So do not put the arguments’ name for Concurrent Program and replace them with argumentnumber.

Table 21 INCOIN Interface Tables (Cont’d)

Name Description



Figure 68 INCOIN CP Configuration

4. Configure the interface table.

The following steps show how to configure the interface table:

a. Click Interface Table Configuration, as shown in Figure 68.

b. In the Interface Table Configuration dialog, click Add to add an interface table.

c. Select INV > MTL_SYSTEM_ITEMS_INTERFACE, and then click Apply.

d. In the Interface Table Configuration dialog, review the selected table, and then click OK.


a. Click Generate SQL Script to generate the SQL script, as shown in Figure 68.

b. Execute the SQL script on a command line to grant the insert privilege to plug-in user for the interface table.

6. Enter the data for the interface table and the concurrent request.

In this example, the interface table has already been configured. Therefore you may skip this step.



Table 22 lists the inputs of the INCOIN Concurrent Program.

Table 23 lists the important inputs of the interface tables.

Table 22 INCOIN CP Inputs


argument1 VARCHAR2 204





argument6 VARCHAR2 Refer to global variable INCOIN_input/arg6_set_process_id


Table 23 INCOIN CP Interface Tables Inputs


ORGANIZATION_ID Number 204

DESCRIPTION VARCHAR2 Refer to global variable INCOIN_input/item_name

SEGMENT1 VARCHAR2 Refer to global variable INCOIN_input/item_name

ATTRIBUTE1 VARCHAR2 2001

CUSTOMER_ORDER_FLAG VARCHAR2 Y

CUSTOMER_ORDER_ENABLED_FLAG

VARCHAR2 Y

PROCESS_FLAG Number 1

ORGANIZATION_CODE VARCHAR2 V1

TRANSACTION_TYPE VARCHAR2 CREATE



7. Issue the following SQL script to find the Concurrent Program parameters:

SELECT cp.concurrent_program_name CP_Name, -- The Concurrent Program namedfcu.end_user_column_name Column_name, -- The real argument name lv.meaning data_type, -- The data type of argumentffv.maximum_size, -- The lenght of the argumentdfcu.required_flag, -- The argument required or notdfcu.display_flag, -- The argument displayed or not on Oracle Form dfcu.default_value, -- The default value of the argumentdfcu.column_seq_num -- The argument sequence number FROM fnd_concurrent_programs_vl cp LEFT OUTER JOIN fnd_descr_flex_col_usage_vl dfcu ON dfcu.descriptive_flexfield_name

='$SRS$.'||cp.concurrent_program_name LEFT OUTER JOIN fnd_flex_value_sets ffv ON ffv.flex_value_set_id = dfcu.flex_value_set_id LEFT OUTER JOIN fnd_lookup_values_vl lv ON lv.lookup_code = ffv.format_type AND lv.lookup_type = 'FIELD_TYPE'AND lv.enabled_flag = 'Y'AND lv.security_group_id = 0AND lv.view_application_id = 0WHERE cp.CONCURRENT_PROGRAM_NAME LIKE UPPER('&CONC_PROG_NAME' || '%')ORDER BY cp.concurrent_program_name, dfcu.column_seq_num;

You can issue the SQL script in one of the following ways:

• Issue the script by using the Oracle SQL * Plus with the apps user.

If you fail to search for any data using this way, you have to add the following SQL statement in front of the SQL script, and then run them together.

ALTER SESSION SET

NLS_LANGUAGE='AMERICAN';

• Issue the script by using the Oracle PL/SQL Developer.

If you fail to search for any data using this way, you have to run the following SQL statement firstly, and then run the SQL script.

ALTER SESSION SET

NLS_LANGUAGE='AMERICAN';

SET_PROCESS_ID Number Refer to global variable INCOIN_input/arg6_set_process_id

Table 23 INCOIN CP Interface Tables Inputs (Cont’d)




Table 24 shows the result of the INCOIN Concurrent Program parameters.


To run the process in TIBCO Designer, select the process in the Project panel and click Start testing the viewed process in the Tester tab.

To check if the process runs successfully, you can check the value of STATUS in the Output tab.

Table 24 INCOIN CP Parameters

No CP_NAME ARGUMENT COLUMN_NAME DATA_TYPE MAXIMUM_SIZE

1 INCOIN argument1 p_org_id Number 15

2 INCOIN argument2 p_all_org Char 80

3 INCOIN argument3 p_val_item_flag Char 80

4 INCOIN argument4 p_pro_item_flag Char 80

5 INCOIN argument5 p_del_rec_flag Char 80

6 INCOIN argument6 p_xset_id Number 15

7 INCOIN argument7 p_run_mode Char 1

8 INCOIN argument8 p_gather_stats Char 80



Figure 69 INCOIN CP Output

9. Check the concurrent request result in Oracle E-Business Suite.


b. Select Manufacturing and Distribution Manager > Inventory > Requests to open the Find Requests dialog.



Figure 70 INCOIN CP: Find Requests Dialog

c. Click Find to view the search results.

Figure 71 INCOIN CP: Request Result



10. Check the inventory items in Oracle E-Business Suite.


b. Select Inventory > Items > Master Items.

c. In the Organizations dialog, select the V1 organization, and then click OK.

Figure 72 INCOIN CP: Select V1 Organization

d. In the Find Master Items (V1) dialog enter the TIBCO% in the Item field, and then click Find.



Figure 73 INCOIN CP: Search for the Results

e. In the Enter Reduction Criteria for Long-List dialog, click OK to review the search results.



Figure 74 INCOIN CP: View the Search Results


Working with the Oracle Business Event Activity | 111

Working with the Oracle Business Event Activity

The BusinessEvent project demonstrates how to use the Oracle Business Event oracle.apps.per.api.person.update_person to listen to the update of a person’s information from Oracle Advanced Queue.

To run the BusinessEvent project, execute the following steps:

1. Review the business event.

a. Log in to the Oracle E-Business Suite web site as the sysadmin user.

b. Select Workflow Administrator Web Applications > Administrator Workflow > Business Events.

c. Enter oracle.apps.per.api.person.update_person in the Name field, and click Go to review the status of the business event.

Figure 75 Review Disabled Business Event



2. Enable the business event.

a. Click the icon to update the business event.

b. In the Status list in the Update Event panel, select Enabled to enable the business events.

c. Click Apply.

Figure 76 Enable the Business Event

3. Open the BusinessEvent project in TIBCO Designer.

4. Configure the Oracle E-Business Suite connection.

5. Configure the Oracle Business Event activity.

a. Click Search Event in the Configuration tab, select the enabled business event, and then click OK.



Figure 77 Select the Business Event

b. Configure the Agent, Queue, and Queue Table.

Click Advanced Configuration as shown in Figure 77. In the Advanced Configuration dialog, add suffix _PER to the value of the Agent Name, Queue Name, and Queue Table Name fields. Click Apply.

Figure 78 Business Event Advanced Configuration

c. Generate and execute the SQL Script.

Click Generate SQL Script to generate the SQL script, as shown in Figure 77.

Run the SQL script on a command line, or with the Oracle SQL Developer to grant the insert privilege to the plug-in user for the interface table.



6. Trigger an event in Oracle E-Business Suite.

a. Log in to the Oracle E-Business Suite application as the Operations user.

b. Select Human Resources, Vision Enterprises > People > Enter and Maintain.

c. Enter A% in the Full Name field in the Find Person dialog to find a person’s name that begins with an A, and then click Find.

d. Select Alexander, and click OK to review the person’s information.

e. Update the value in the Office field from Building 500 to Building 1000, and then click the icon. Click Update in the pop-up dialog. The following figure shows the updated person information of Alexander.

Figure 79 Person Information

7. Get the event attributes in TIBCO Designer.

Click Get Event Attributes in the Event Attributes tab to get the event attributes.

I If you do not generate or execute the SQL script, an error JMS-190: Queue plugin.TIB_WF_Q_PER not found will occur.

If you do not trigger an event first, an error Please trigger an event in Oracle E-Business Suite first will occur.



Figure 80 Event Attributes

8. Run the process, and review the output for the information you updated.

Figure 81 Business Event Output


| 117

Appendix A Backing Up TIB_BW_EBS_LOG Table

This appendix explains how to back up the data in the TIB_BW_EBS_LOG table if you want to upgrade Oracle E-Business Suite 12.1.x to 12.2.x.

Topics

• Exporting Data from Oracle E-Business Suite 12.1.x, page 118

• Importing Data into Oracle E-Business Suite 12.2.x, page 120


118 | Appendix A Backing Up TIB_BW_EBS_LOG Table

Exporting Data from Oracle E-Business Suite 12.1.x

The TIB_BW_EBS_LOG table records the log information of all the plug-in activities that you have used.

Before upgrading Oracle E-Business Suite 12.1.x to 12.2.x, you have to back up the data in the TIB_BW_EBS_LOG table in Oracle E-Business Suite 12.1.x.

To back up the data, complete the following steps:

1. Connect to the database of Oracle E-Business Suite 12.1.x using the plug-in user.

2. Run the TIB_BW_EBS_LOG_BACKUP_TABLE.sql file, which is located in the TIBCO_HOME\bw\plugins\oracleebs\config\12.2\upgrade\backupLogTable directory, to create the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables.

3. Run the TIB_BW_EBS_LOG_BACKUP.prc file, which is located in the TIBCO_HOME\bw\plugins\oracleebs\config\12.2\upgrade\backupLogTable directory, to create a stored procedure.

4. Issue the stored procedure created in step 3 to copy the data from the TIB_BW_EBS_LOG table to the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables.

5. Use the exp command provided by Oracle to export the TIB_BW_EBS_LOG_TEM and WF_PARAMETER_T_TEMP tables to your local machine.

The following is an example of using the exp command. Enter the command at a command prompt on one line.

exp plugin/<password>@<Net Service Name> file=<D:\TIB_BW_EBS_LOG.dmp>

tables=(TIB_BW_EBS_LOG_TEMP,WF_PARAMETER_T_TEMP)

In this example, plugin stands for the plug-in user name, password stands for the password of the plug-in user, and Net Service Name stands for the name of net service that you use. After running the command, the TIB_BW_EBS_LOG_TEM and WF_PARAMETER_T_TEMP tables are exported to the D:\TIB_BW_EBS_LOG.dmp directory of your local machine.

6. Run the post_export.sql, which is located in the TIBCO_HOME\bw\plugins\oracleebs\config\12.2\upgrade\backupLogT

Before using the exp command, you must install corresponding Oracle database client. For Oracle E-Business Suite 12.1.x, you must install the Oracle 11gR1 client.


Exporting Data from Oracle E-Business Suite 12.1.x | 119

able directory, to drop the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables and the stored procedure created by the TIB_BW_EBS_LOG_BACKUP.prc file from the database of Oracle E-Business Suite 12.1.x.



Importing Data into Oracle E-Business Suite 12.2.x

After upgrading Oracle E-Business Suite to 12.2.x, you can import the data, which have been exported from the Oracle E-Business Suite 12.1.x, into Oracle E-Business Suite 12.2.x.

To import the data into the TIB_BW_EBS_LOG table in Oracle E-Business Suite 12.2.x, complete the following steps:

1. Connect to the database of Oracle E-Business Suite 12.2.x by using the plug-in user.

2. Use the imp command provided by Oracle to import the TIB_BW_EBS_LOG_TEM and WF_PARAMETER_T_TEMP tables from your local machine into the database of Oracle E-Business Suite 12.2.x.

The following is an example of using the imp command. Enter the command at a command prompt on one line.

imp plugin/<password>@<Net Service Name>

file=<D:\TIB_BW_EBS_LOG.dmp>

tables=(TIB_BW_EBS_LOG_TEMP,WF_PARAMETER_T_TEMP) ignore=y

In this example, plugin stands for the plug-in user name, password stands for the password of the plug-in user, and Net Service Name stands for the name of net service that you use. After running the command, the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables are imported from D:\TIB_BW_EBS_LOG.dmp directory of your local machine into the database of Oracle E-Business Suite 12.2.x.

3. Run the TIB_BW_EBS_LOG_IMPORT.prc file, which is located in the TIBCO_HOME\bw\plugins\oracleebs\config\12.2\upgrade\backupLogTable directory, to create a stored procedure.

4. Execute the stored procedure created in step 3 to copy the data from the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables to the TIB_BW_EBS_LOG table in the database of Oracle E-Business Suite 12.2.x.

5. Run the post_import.sql file, which is located in the TIBCO_HOME\bw\plugins\oracleebs\config\12.2\upgrade\backupLogT

Before using this command, you must install corresponding Oracle database client. For Oracle E-Business Suite 12.2.x, you must install the Oracle 11gR2 client.

Make sure the TIB_BW_EBS_LOG table is empty before importing the data.


Importing Data into Oracle E-Business Suite 12.2.x | 121

able directory to drop the TIB_BW_EBS_LOG_TEMP and WF_PARAMETER_T_TEMP tables and the stored procedure created by the TIB_BW_EBS_LOG_IMPORT.prc file from the database of Oracle E-Business Suite 12.2.x.


| 123

Appendix B Oracle API and Custom API Comparison

This appendix provides a comparison between the Oracle API activity and Custom API activity.

Topics

• Oracle API and Custom API Comparison, page 124


124 | Appendix B Oracle API and Custom API Comparison

Oracle API and Custom API Comparison

The differences between Oracle API and Custom API are listed as follows:

• Supported Oracle E-Business Suite versions

Oracle API is applicable for Oracle E-Business Suite 12.0.x, 12.1.x, and 12.2.x.

Custom API is applicable for Oracle E-Business Suite 11.5.10, 12.0.x, 12.1.x, and 12.2.x.

• Configuration

In TIBCO Designer, Oracle API and Custom API use difference palettes.

Oracle API loads the PL/SQL package and procedure parameters information from Oracle Integration Repository.

Custom API loads the PL/SQL package or procedure parameters information from Oracle Database Dictionary.

• Oracle E-Business Suite Connection

When configuring the Oracle E-Business Suite Connection for Custom API activity for Oracle E-Business Suite 11.5.10, the plug-in user name in Configuration tab should be the apps user name.

This is because in Oracle E-Business Suite 11.5.10, PLSQL API is defined with AUTHID CURRENT_USER, take the following codes for example: CREATE OR REPLACE PACKAGE BOM_BO_PUB AUTHID CURRENT_USER ...

In this example, when calling the procedure under BOM_BO_PUB package, the invoker’s right is needed. Therefore, the invoker must have the privilege for the reference object, such as Table, View, and other packages in this package.


| 125

Appendix C Oracle Concurrent Program and Custom Concurrent Program Comparison

This appendix provides a comparison between the Oracle Concurrent Program activity and Custom Concurrent Program activity.

Topics


• SRS Concurrent Program and Non-SRS Concurrent Program, page 127


126 | Appendix C Oracle Concurrent Program and Custom Concurrent Program Comparison

Overview

The differences between Oracle Concurrent Program and Custom Concurrent Program are listed as follows:

• Supported Oracle E-Business Suite versions

— Oracle Concurrent Program is applicable in Oracle E-Business Suite 12.0.x, 12.1.x, and 12.2.x.

— Custom Concurrent Program is applicable in Oracle E-Business Suite 11.5.10, 12.0.x, 12.1.x, and 12.2.x.

• Configuration

In TIBCO Designer, Oracle Concurrent Program and Custom Concurrent Program use difference palettes.

— Oracle Concurrent Program loads the Inbound Interface Tables or Views from Oracle Integration Repository.

— Custom Concurrent Program requires you to select Interface Tables or Views from the database manually.

• Concurrent Program

There are two types of Concurrent Programs in Oracle Integration Repository:

— Standard Request Submission (SRS) Concurrent Program

— non-SRS Concurrent Program

The concurrent program supported by each activity is different:

— Oracle Concurrent Program only supports the SRS Concurrent Program.

— Custom Concurrent Program supports both the SRS Concurrent Program and non-SRS Concurrent Program.

See SRS Concurrent Program and Non-SRS Concurrent Program, page 127 for more details about the different between the two types of the Concurrent Programs and how to use them.


SRS Concurrent Program and Non-SRS Concurrent Program | 127

SRS Concurrent Program and Non-SRS Concurrent Program

Depending on the approach to submit a request in Oracle E-Business Suite, two types of Concurrent Programs are available in Oracle Integration Repository.

• Standard Request Submission (SRS) is an Oracle E-Business Suite feature that you can use to select and run your Concurrent Programs from a single, standard form (Submit Request) or window (Schedule Request). Requests to run Concurrent Programs are called concurrent requests.

• Non-Standard Request Submission is not available through Standard Request Submission. You can run a non-SRS Concurrent Program by submitting a non-standard request form.

This section will give an example of a non-SRS Concurrent Program, and then provide suggestions on how to run a non-SRS Concurrent Program.

Sample Non-SRS Concurrent Program: GLBBSUThis section describes how to run the sample non-SRS Concurrent Program GLBBSU.

The configuration of the activity in TIBCO Designer is shown in Figure 82.

Figure 82 Oracle Concurrent Program for GLBBSU: Configuration

Figure 83 shows the two parameters for the activity and their inputs.



Figure 83 Oracle Concurrent Program for GLBBSU: Input

Run the process in TIBCO Designer. An error message is displayed in the output tab, as shown in Figure 84, indicating that the number of arguments is wrong.

Figure 84 Oracle Concurrent Program for GLBBSU: Output

The detailed information of GLBBSU in Oracle Integration Repository is shown in Figure 85.



Figure 85 GLBBSU Detail in Oracle Integration Repository (Oracle CP)

The request details of GLBBSU from Oracle E-Business Suite Client are shown in Figure 86.



Figure 86 GLBBSU Request Detail from Oracle EBS Client (Oracle CP)

Open the request form by clicking View > Request from the menu.



Figure 87 Submitting a New Request

Click OK to choose the SRS Concurrent Program. The Upload Budget Amounts program cannot be found in the standard submit form.



Figure 88 Standard Submit Form

Since the request cannot be submitted using the standard request form, Oracle provides the following non-standard request form:



Figure 89 The Non-Standard Request Form for GLBBSU

Click Upload to show the Upload Budgets window. The input for this Concurrent Program is shown in Figure 90. Note that these parameters are different from those shown in Figure 85.

Figure 90 Non-Standard Submit Form for GLBBSU: Input

Submit the request. The Request Detail shows that the request has 7 parameters.



Figure 91 Request Detail of GLBBSU

Configure a Custom Concurrent Program activity in TIBCO Designer to run GLBBSU. Copy the input from Figure 91 for this activity.

Figure 92 Custom Concurrent Program for GLBBSU: Input

Run the Custom Concurrent Program activity and output as shown in Figure 93.



Figure 93 Custom Concurrent Program for GLBBSU: Output

The process runs without error. The Custom Concurrent Program details for GLBBSU in Oracle E-Business Suite Client are shown in Figure 94.

Figure 94 GLBBSU Request Details from Oracle EBS Client (Custom CP)



SuggestionThe example shows that some parameters for non-SRS Concurrent Program are not visible from both TIBCO Designer and Oracle Integration Repository. To run such non-SRS Concurrent Programs, it is recommended that you use the Concurrent Program activity in TIBCO Designer. You should validate the parameters before starting the activity.

To check a Concurrent Program is a SRS Concurrent Program or a non-SRS Concurrent Program, use the SQL to query the SRS flag. For example:======== the sql to query SRS flag ========

select CONCURRENT_PROGRAM_ID, CONCURRENT_PROGRAM_NAME, SRS_FLAG,ENABLED_FLAG,USER_CONCURRENT_PROGRAM_NAME

from fnd_concurrent_programs_vl where concurrent_program_name='GLBBSU'

======== the sql to query SRS flag ========

To find the parameters for a Concurrent Program, execute the following SQL command:

======== the sql to query parameters for GLBBSU ========SELECT cp.concurrent_program_name CP_Name, -- The Concurrent Program namedfcu.end_user_column_name Column_name, -- The real argument name lv.meaning data_type, -- The data type of argumentffv.maximum_size, -- The lenght of the argumentdfcu.required_flag, -- The argument required or notdfcu.display_flag, -- The argument displayed or not on Oracle Form dfcu.default_value, -- The default value of the argumentdfcu.column_seq_num -- The argument sequence number FROM fnd_concurrent_programs_vl cp LEFT OUTER JOIN fnd_descr_flex_col_usage_vl dfcu ON dfcu.descriptive_flexfield_name

='$SRS$.'||cp.concurrent_program_name LEFT OUTER JOIN fnd_flex_value_sets ffv ON ffv.flex_value_set_id = dfcu.flex_value_set_id LEFT OUTER JOIN fnd_lookup_values_vl lv ON lv.lookup_code = ffv.format_type AND lv.lookup_type = 'FIELD_TYPE'AND lv.enabled_flag = 'Y'AND lv.security_group_id = 0AND lv.view_application_id = 0WHERE cp.CONCURRENT_PROGRAM_NAME = 'GLBBSU'

ORDER BY cp.concurrent_program_name, dfcu.column_seq_num;

======== the sql to query parameters for GLBBSU ========


| 137

Appendix D Introduction to Oracle Integration Repository

This appendix provides a brief introduction to Oracle Integration Repository and describes how to search for a business service interface in it.

Topics


• Searching for a Business Service Interface in Oracle Integration Repository, page 139


138 | Appendix D Introduction to Oracle Integration Repository

Overview

The Oracle Integration Repository is a compilation of information about the service endpoints exposed by the Oracle E-Business Suite of applications. It provides a complete catalog of Oracle E-Business Suite's business service interfaces.


Searching for a Business Service Interface in Oracle Integration Repository | 139

Searching for a Business Service Interface in Oracle Integration

Repository

This section lists the necessary steps in order to view the details of a business service interface in Oracle Integration Repository with Oracle E-Business Suite 12.1.1.

1. Log on to Oracle E-Business Suite using a system administrator’s account.

Figure 95 Oracle E-Business Suite: Logon

2. Expand Integrated SOA Gateway > Integration Repository in the Main Menu panel.



Figure 96 Oracle Applications Home Page

Oracle Integration Repository is displayed as shown in Figure 97.



Figure 97 Oracle Integration Repository

3. Click Search in the upper right corner to show the search page.



Figure 98 Oracle Integration Repository Search Page

4. Enter the Internal Name of a business service interface, select the Interface Type from the list, and then click Go to show its details.

For example, enter the Oracle API Package name BOM_BO_PUB in the Internal Name field. In the Interface Type field, select PL/SQL from the list. Click Go, and the API Package BOM_BO_PUB will be found in Oracle E-Business Suite.

5. Click the name of the business service interface to show its details.



Figure 99 Searching an API Package from Oracle E-Business Suite



Figure 100 Business Service Interface Details Shown in Oracle E-Business Suite


| 145

Appendix E Introduction to Oracle Database JPublisher

This appendix describes how to create wrapper packages using Oracle JPublisher.

Topics


• Oracle JPublisher Installation, page 149

• Running Oracle JPublisher, page 151

• Oracle JPublisher Wrapper Details, page 153


146 | Appendix E Introduction to Oracle Database JPublisher

Overview

Oracle JPublisher is a command line utility provided by Oracle. It can generate Java classes and PL/SQL scripts to enable the access to the database objects such as tables, stored procedures, and data structures through Java code.

When supplied with the correct parameters, Oracle JPublisher generates two types of output:

• It generates a PL/SQL script that exposes the custom data types, stored procedures and functions contained in a package by creating SQL types, and a wrapper package that permits the internals of the original package to be more accessible and callable.

• It generates Java classes which utilize the generated wrapper PL/SQL scripts. These wrapper Java classes model the database objects and can be used programmatically to execute the contents of the selected package.

Wrapper and Non-Wrapper Data type

Wrapper data types are listed as follows:

• PLSQL BOOLEAN

• TABLE

• PLSQL TABLE

• RECORD

• VARRAY

The following codes show an example:CREATE OR REPLACE PACKAGE WRAPPER_DATA_TYPE_PKG

AS

TYPE PER_INFO_RECORD IS RECORD

(FIRST_NAME VARCHAR2 (20)

, LAST_NAME VARCHAR2 (20)

When using Oracle JPublisher 9.2.0.1 to generate PL/SQL wrapper files in Oracle E-Business Suite 11.5.10, if the runtime12.jar, translator.jar, and ojdbc14.jar files used to install Oracle JPublisher 9.2.0.1 are copied from the ORACLE_HOME/oc4j/sqlj/lib and ORACLE_HOME/jdbc/lib directories in Oracle E-Business Suite 11.5.10 server , the PL/SQL wrapper files are not successfully generated. In this situation, you can use the runtime12.jar, translator.jar, and ojdbc14.jar files in Oracle E-Business Suite 12.1 server as a substitute or contact TIBCO support or Oracle support for help.


Overview | 147

, SEX VARCHAR2 (1)

, AGE NUMBER (3)

, PER_ID NUMBER

)

TYPE PER_TAB IS table of PER_INFO_RECORD;

PROCEDURE CREATE_PERSONS (P_PERS PER_TAB, P_COMMIT BOOLEAN);

PROCEDURE CREATE_PERSON (P_PER PER_INFO_RECORD, P_STATUS VARCHAR2);

END;

In this example, P_COMMIT is PLSQL BOOLEAN type, P_PERS is TABLE type, and P_PER is PLSQL RECORD type.

Non-wrapper data types are listed as follows:

• VARCHAR2

• LONG

• CHAR

• CLOB

• NUMBER

• INTEGER

• DATE

• FLOAT

• BINARY_INTEGER

• PLS_INTEGER

The difference between the wrapper and non-wrapper data type is shown in Figure 101.

Figure 101 Wrapper and Non-Wrapper Data Type Comparison

Oracle/Custom API

Non-Wrapper Type API: No need to use JPublisher

Wrapper Type API: Need to use the scripts generated by JPublisher under

application user



Oracle JPublisher Usage in the Plug-in

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite relies on Oracle JPublisher to generate PL/SQL scripts in some instances where programmatically accessing the database objects is not possible.

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite does not need the generated Java classes because the plug-in utilizes a general framework that allows the invocation of the stored packages’ procedures.

In particular, Oracle E-Business Suite APIs that require data structures defined within the API packages require the wrappers generated by Oracle JPublisher because these data structure definitions are not accessible outside of the package.

Using the wrappers, TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite can thus invoke the procedures contained inside the Oracle E-Business Suite APIs packages.

Only Oracle E-Business Suite APIs that contain complex types such as table types and record types require Oracle JPublisher PL/SQL wrappers.


Oracle JPublisher Installation | 149

Oracle JPublisher Installation

Oracle JPublisher is maintained by Oracle, and the packaging and usage are subject to change. If any of the information conveyed below is no longer valid, check with Oracle Support or contact TIBCO Support for more information.

PrerequisitesBefore starting the installation procedure, ensure that your system meets the following requirements:

• Java JDK 1.5 or higher is installed on your system.

• The bin directory is in the path. On Windows systems, you have to verify that Java is accessible by typing java –version on a command line. Although it is not required, it is good practice to verify the Javac is accessible in order to reduce the chance of errors.

Supported VersionsThe following versions of Oracle JPublisher from Oracle web site can generate compatible PL/SQL wrappers for the plug-in:

• Oracle JPublisher 10.2

• Oracle JPublisher 10.1.0.3

• Oracle JPublisher 9.2.0.1

And you can make the Oracle JPublisher 11.x shipped with the Oracle database 11.x by copying the runtime12.jar, and translator.jar from ORACLE_HOME/oc4j/sqlj/lib directory to the BW_HOME/plugins/oracleebs/examples/jpublisher/lib JPublisher library directory which is normally called Jpub_LIB_DIR.

Oracle JPublisher requires JDBC libraries, which can be downloaded from the Oracle web site http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html.

The following are examples of the names of these JDBC Java libraries:

• ojdbc14.jar

• ojdbc5.jar


http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html



• ojdbc6.jar

InstallationTo install Oracle JPublisher, complete the following steps:

1. Download a supported version of Oracle JPublisher from the Oracle web site http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html.

Check whether the version of your JPublisher is supported. See Supported Versions, page 149 for details.

2. Extract the package to a local folder in your system.

3. Reference runtime12.jar, translator.jar, and the JDBC library in the Java classpath.

• On Microsoft Windows platforms:

a. Select Start > Control Panel > System.

b. In the System Properties dialog, click the Advanced tab, and then click Environment Variables in this tab.

c. In the System variables area, select CLASSPATH and click Edit.

d. Add runtime12.jar, translator.jar, and the JDBC library to the Variable value field. Click OK.

• On Windows platforms using console window:

Execute the following command:

set

CLASSPATH=JPUB_LIB_DIR/runtime12.jar;JPUB_LIB_DIR/translator.jar;JPUB_LIB_DIR/ojdbc5.jar

• On UNIX platforms:

Execute the following command: export CLASSPATH=JPUB_LIB_DIR/runtime12.jar:JPUB_LIB_DIR/translator.jar:JPUB_LIB_DIR/ojdbc5.jar

JDBC Java library ojdbc14.jar is for JPublisher 9.2.0.1, 10.1.x, and 10.2.x; ojdbc5.jar and ojdbc6.jar are for JPublisher 11.x.

It is good practice to put the JDBC library in the same folder as the runtime12.jar and translator.jar directory.




Running Oracle JPublisher | 151

Running Oracle JPublisher

Oracle JPublisher is a command line utility. To run Oracle JPublisher, the command accepts a few parameters. See Table 25 for detailed descriptions of the parameters that matter in the execution of JPublisher to generate the PL/SQL wrappers.

Running AccountThe execution of Oracle JPublisher requires the logged-in user to have access to the package, and all the database objects related to the package for which the wrapper is being generated from.

Table 25 JPublisher Parameters

Parameter Description

-user Specifies the credentials to use to log in to the database to extract the API information. Note that this login will need to have all the privileges to the API packages as well as Oracle’s data dictionary tables. It is recommended that the apps user be used here to avoid any privilege issues.

-url Contains the JDBC connection string used to connect to the database. Typically, the format is jdbc:oracle:thin:@[Database Server]:[Port]:[SID]. For example, jdbc:oracle:thin:@oracle-ebs-server:1521:VIS.

-plsqlmap Initializes Oracle JPublisher to generate the PL/SQL script wrapper. Its value is always. For example, -plsqlmap=always.

-sql Specifies the package name in the Oracle database that is used to generate the PL/SQL wrapper.

-plsqlpackag

e

Specifies the name of the generated wrapper package which is user-defined. It is recommended that the TIB_ be used as a prefix for the API package name. For example, if -sql=BOM_BO_PUB, then -plsqlpackage=TIB_BOM_BO_PUB.

-plsqlfile Specifies the filename of the generated PL/SQL wrapper. It is recommended that you use either the SQL package name or the PLS package name (for example, BOM_BO_PUB or TIB_BOM_BO_PUB) so that the filename can be used to identify the package referenced by the PL/SQL wrapper.

-dir Specifies the directory to save the PL/SQL wrapper file.



The apps user typically has access to all the packages. Ensure that the apps user is used to execute Oracle JPublisher for script generation. If this is not desirable, then an exhaustive exercise needs to be conducted to identify all the procedures, related packages, tables, and other items used by the package for which the wrapper is being generated from. If the apps user can not be used directly, privilege to the desired package should be granted to the plug-in user by the apps user using the following SQL statement: (where username is the plug-in user): GRANT EXECUTE ON BOM_BO_PUB TO username;

CREATE SYNONYM BOM_BO_PUB FOR APPS.BOM_BO_PUB;

Running Oracle JPublisherTo run Oracle JPublisher, open a command line window and execute the following example command:java oracle.jpub.Main -user=apps/apps -url=jdbc:oracle:thin:@10.105.176.40:1521:VIS -sql=BOM_BO_PUB -plsqlpackage=TIB_BOM_BO_PUB -plsqlmap=always -dir=java/BOM_BO_PUB -plsqlfile=sql/BOM_BO_PUB/BOM_BO_PUB.sql

Tables, other packages and the tables they may reference, and other objects accessed by any dependent packages will also need to be accessible by the plug-in user to run this script. As such, it is advisable to run this script using the apps user once, and privileges need not be granted to the plug-in user.

Execution may take some time depending on the size of the API package specified and the database server resources available (a few minutes for each PL/SQL wrapper). During execution, Oracle JPublisher will list the database types that have been wrapped.

Oracle JPublisher may attempt to compile the Java classes generated by running the Java compiler. This step may fail because -plsqlmap=always was selected, however, it does not affect the generation of the PL/SQL wrappers themselves.


Oracle JPublisher Wrapper Details | 153

Oracle JPublisher Wrapper Details

Once Oracle JPublisher has executed successfully, two PL/SQL files will be generated. One is the wrapper file which exposes data structure types and stored procedures for execution through JDBC. The other file generated with the drop suffix contains scripts to undo the changes of the wrapper, allowing the database to return to its prior state.

In the above example, the files generated by Oracle JPublisher are:

• BOM_BO_PUB.sql

• BOM_BO_PUB_drop.sql

Inspection of the generated wrapper file shows that package types are mapped to general SQL types, and package procedures and functions are mapped to identical procedures in the generated wrapper package. The SQL type and wrapper package are accessible by the Oracle E-Business Suite apps user or users with equivalent privileges.

It is possible to edit this file to restrict the access of certain procedures and types so that the entire package content need not be exposed. However, this will require extensive knowledge of PL/SQL, the API package, and API and type relationships for the particular API that is being configured. Ensure that the unmodified file is run in its entirety.

Using an SQL execution tool such as Oracle SQL Developer, login as the plug-in user if the privilege to the package has been granted, or simply use the apps user and execute this script.

Execution of the wrapper files may require a SQL tool that can accommodate very long individual lines. It is recommended that Oracle SQL Developer be used to execute this script, since SQL*Plus may encounter problems executing lines that are very long, even after increasing the line size.


| 155

Appendix F Error Messages

This appendix lists the error messages used by TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite.

Topics

• TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Error Messages, page 156


156 | Appendix F Error Messages

TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business

Suite Error Messages

BW-ORACLEEBS-100001: JMS Exception: %1

Role: errorRole

Category: BW-ORACLEEBS

Description: A JMS exception occurred. The diagnosis depends on the error message returned.

Resolution: Check the JMS server status.

BW-ORACLEEBS-100007: Global variable %1 is not defined.

Role: errorRole

Category: BW-Plugin

Description: The referenced global variable was not defined.

Resolution: Define the referenced global variable.

BW-ORACLEEBS-100008: Configuration test failed: %1

Role: errorRole

Category: BW-Plugin

Description: The configuration validation failed.

Resolution: Ensure that the activity is correctly configured with all the required settings and values.

BW-ORACLEEBS-100010: SQL Exception: %1

Role: errorRole

Category: BW-Plugin

Description: A SQL execution failed.

Resolution: Ensure that you are connecting to the right database.


TIBCO ActiveMatrix BusinessWorks Plug-in for Oracle E-Business Suite Error Messages | 157

BW-ORACLEEBS-100012: Load Resource Exception: %1

Role: errorRole

Category: BW-Plugin

Description: Cannot find the Shared Resource name. The Oracle Connection cannot be located.

Resolution: Make sure to select a connection resource for the activity.

BW-ORACLEEBS-100013: Exception: %1

Role: errorRole

Category: BW-Plugin

Description: General exception.

Resolution: Inspect the error message to diagnose the issue.

BW-ORACLEEBS-100014: Event Name Exception: %1

Role: errorRole

Category: BW-Plugin

Description: The Event Name specified may not exist.

Resolution: Check that the Event Name specified is correct.

BW-ORACLEEBS-100015: Connection Parameters Exception: %1

Role: errorRole

Category: BW-Plugin

Description: The connection parameters may be incorrect. For example, the input maximum connections or the login timeout value may be blank.

Resolution: Check the connection parameters.


158 | Appendix F Error Messages

BW-ORACLEEBS-100016: Advanced Queue connection failed: %1

Role: errorRole

Category: BW-Plugin

Description: The connection to Oracle Advanced Queue failed.

Resolution: Check the connection parameters and the Oracle database.

BW-ORACLEEBS-100018: PLSQL API or Concurrent Program Execute Error: %1

Role: errorRole

Category: BW-Plugin

Description: An error occurred when executing SQL commands submitted by PLSQL API or Concurrent Program.

Resolution: Inspect the error message to diagnose the error.

BW-ORACLEEBS-100019: Connection to AQ server failed. Can't get connection.

Role: errorRole

Category: BW-Plugin

Description: The connection to Oracle Advanced Queue failed.

Resolution: Check the connection parameters and the Oracle database.

BW-ORACLEEBS-100020: Configuration Error: %1

Role: errorRole

Category: BW-Plugin

Description: A configuration error occurred with the plug-in activity.

Resolution: Ensure that all the settings and values are correct for the plug-in activity.


| 159

Appendix G Log Table Structure

Oracle E-Business Suite keeps a record of the plug-in activities in the TIB_BW_EBS_LOG table. The structure of the log table is shown in this appendix.

Topics

• Log Table Structure, page 160


160 | Appendix G Log Table Structure

Log Table Structure

The structure of the TIB_BW_EBS_LOG table is shown in Table 26.

The common_all.sql script contains the create script for the Log Table. It also contains the common procedure for all records into the Log Table.

Table 26 Log Table Structure

Column Names Data Type Null? Default

Value Description

ID NUMBER No An auto increment sequence ID.

PROCESS_ID VARCHAR2 (20) Yes Sequence ID; Created automatically for each process by TIBCO ActiveMatrix BusinessWorks.

NAME VARCHAR2 (100) No The name of the API/Wrapper procedure, Concurrent Program, or business event.

TYPE VARCHAR2 (50) No The type of the activity configured in TIBCO Designer.

REQUEST_ID VARCHAR2 (20) Yes The ID of the request to run a Concurrent Program in Oracle E-Business Suite.

LOG_TIME DATE Yes SYSDATE The time when the process is recorded.

STATUS VARCHAR2 (50) No The status of the process: Success, Error, or Ignore.

EVENT_QUEUE VARCHAR2 (50) Yes This field applies to Oracle Business Event only. The name of the Queue that received the message from the Event Agent.


Log Table Structure | 161

EVENT_AGENT VARCHAR2 (50) Yes This field applies to Oracle Business Event only. The name of the Agent that received the message from the Oracle Business Event System.

EVENT_SUBSC

RIBER

VARCHAR2 (50) Yes This field applies to Oracle Business Event only. The name of the Subscriber that consumed the message.

EVENT_DATA APPS_NE.WE_EVENT_T

(Note: In Oracle E-Business Suite 12.1.x and 12.0.x, the data type is APPS.WF_EVENT_T)

Yes This field applies to Oracle Business Event only. The user data of the business event message. For more information, refer to the APPS.WF_EVENT_T data type definition in Oracle database.

DESCRIPTION VARCHAR2 (4000) Yes The simple format output result for Oracle API, Custom API, Oracle CP, and Custom CP.

Table 26 Log Table Structure (Cont’d)

Column Names Data Type Null? Default

Value Description


162 | Appendix G Log Table Structure


| 163

Index

A

activitiesCustom API 4Custom Concurrent Program 4Oracle API 4Oracle Business Events 4Oracle Concurrent Program 4

B

business service interface 139

C

connection to Oracle database server 7connection to the Oracle database server 7create a project 13Custom API 34Custom Concurrent Program 49customer support xvii

E

EAR file 19ENV_NAME xv

I

Inbound Interface Tables or Views 41

N

Non-Standard Request Submission 127

O

Oracle API 26, 26Oracle Business Event 4, 58Oracle Concurrent Program 41Oracle Database Dictionary 34Oracle Database Server 7Oracle EBS 1Oracle E-Business Suite 2Oracle E-Business Suite Architecture 2Oracle E-Business Suite Connection 4, 23Oracle Integration Repository 26, 138Oracle SQL*Plus 8, 9ORACLE_HOME xv

P

palette 22Parameter Direction 32

S

SRS 127Standard Request Submission 127support, contacting xvii


164 | Index

T

technical support xviiTIBCO ActiveMatrix Business 3TIBCO ActiveMatrix BusinessWorks 12TIBCO ActiveMatrix BusinessWorks Plug-in for Ora-

cle E-Business Suite palette 22TIBCO_HOME xv

U

USER_HOME xv

W

Wrapper Package 28Wrapper procedure 28


tibco activematrix businessworks plug-in for oracle e ... · pdf fileworking with the custom...

Documents