TIBCO ActiveMatrix BusinessWorks™ Plug-in for ActiveSpaces ...

TIBCO ActiveMatrix BusinessWorks™ Plug-in for ActiveSpaces® User’s Guide Software Release 1.1.0 February 2012

Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN 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, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer, TIBCO Runtime Agent, TIBCO ActiveMatrix BusinessEvents, TIBCO IntegrationManager, TIBCO Hawk, TIBCO Rendezvous, and TIBCO ActiveSpaces 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 © 2011- 2012 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Documentation . . . . . . . . . . . . . . . . . . . . . . . xiii Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi

Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Product Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 ActiveSpaces Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Shared Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 ActiveSpaces Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Metaspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Test Connection Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Adding Spaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Export... Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Space Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces User’s Guide

iv

| Contents Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14 14 14 15 15

Take . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

16 16 16 17 17

Begin Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18 18 18 18 19

Commit Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20 20 20 20 20

Rollback Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22 22 22 22 22

Entry Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24 24 25 26 26 26

Event Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27 27 27 29 29 29

Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31 31 31 32

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces User’s Guide

Contents v

|

Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Snapshot Iterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 3 Working with TIBCO ActiveMatrix BusinessWorks . . . . . . . . . . . . . . . . . . . . . . . . . .37 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Starting TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Creating a Metaspace Shared Resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Creating a Space Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Creating a Space Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Creating a ActiveSpaces Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Adding Activities to the Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Testing the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapter 4 Using Sample Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Running the Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Appendix A Managing ActiveSpaces Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Appendix B Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65


vi

| Contents


Figures vii

|

Figures

Figure 1

ActiveSpaces Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Figure 2

Space Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Figure 3

Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Figure 4

Save Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Figure 5

DatebaseCache Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Figure 6

QueryUserInfo Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Figure 7

BaseDire Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


viii

| Figures


Tables ix

|

Tables

Table 1

General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

Table 2

Metaspace Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Table 3

Space Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Table 4

Space Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Table 5

Space Connection Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Table 6

Put Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Table 7

Put Activity — Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Table 8

Put Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Table 9

Get Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Table 10

Get Activity — Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Table 11

Get Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Table 12

Take Activity — Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Table 13

Take Activity — Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Table 14

Take Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Table 15

Begin Transaction Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Table 16

Begin Transaction Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Table 17

Commit Transaction Activity — Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Table 18

Commit Transaction Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Table 19

Rollback Transaction Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 20

Rollback Transaction Activity — Error Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 21

Entry Browser Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 22

Entry Browser Activity — Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 23

Entry Browser Activity — Misc Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 24

Entry Browser Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 25

Event Listener Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Table 26

Event Listener Activity — Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Table 27

Event Listener Activity — Misc Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Table 28

Event Listener Activity — Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces User’s Guide

x

| Tables Table 29

Event Listener Activity — Error Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Table 30

Snapshot Activity — Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Table 31

Snapshot Activity — Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Table 32

Snapshot Activity — Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Table 33

Snapshot Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Table 34

Snapshot Iterator Activity — Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 35

Snapshot Iterator Activity — Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Table 36

Snapshot Iterator Activity — Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Table 37

Snapshot Iterator Activity — Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Table 38

Snapshot Iterator Activity — Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Table 39

MySpace Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Table 40

QueryUserInfo Process Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Table 41

Log Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56


| xi

Preface

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces plugs into TIBCO ActiveMatric BusinessWorks and can be installed separately. You can use this plug-in to utilize all the benefits of TIBCO ActiveSpaces without any coding.

Topics •

Changes from the Previous Release of this Guide, page xii

•

Related Documentation, page xiii

•

Typographical Conventions, page xiv

•

Connecting with TIBCO Resources, page xvi


xii

| Changes from the Previous Release of this Guide Changes from the Previous Release of this Guide This section itemizes the major changes from the previous release of this guide. Output Schema for the Put, Get, and Take Activities The ResultList, Result, Status, HasError, and Error fields have been added to the Output tab of the Pub, Get, and Take activities. See the Put, Get, and Take sections in ActiveSpaces Palette on page 3 for details. Sample Example Change The Map Date and CatchError activities have been added to the QueryUserInfo Process. See Chapter 4, Using Sample Projects, on page 49 for details. Managing ActiveSpaces Logs Logs are used to trace and troubleshoot ActiveSpaces exceptions at design time and runtime. You can configure logs by adding the logging properties to the TRA files. See Appendix A, Managing ActiveSpaces Logs, on page 55 for details. Trace Messages Error messages used by TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces are listed in Appendix B, Trace Messages, on page 57.


Preface xiii

|

Related Documentation This section lists documentation resources you may find useful.

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces documentation set: •

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Installation Read this manual for instructions on site preparation and installation.

•

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces User’s Guide Read this manual for instructions on how to use the product.

•

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces 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 Documentation You may find it useful to read the documentation for the following TIBCO products: •

TIBCO ActiveSpaces®

•

TIBCO ActiveMatrix BusinessWorks™

•

TIBCO Designer™

•

TIBCO Administrator™

•

TIBCO Rendezvous®

•

TIBCO Hawk®

•

TIBCO Runtime Agent™

•

TIBCO Enterprise Message Service™


xiv

| Typographical Conventions Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention

Use

ENV_NAME

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.

TIBCO_HOME

An installation environment consists of the following properties:

ASBW_HOME

code font

•

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.

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces is installed into a directory within TIBCO_HOME. This directory is referenced in documentation as ASBW_HOME. The default value of ASBW_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco\bw\plugins\activespaces\. 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]


Preface xv

|

Table 1 General Typographical Conventions (Cont’d) Convention

Use

italic font

Italic font is used in the following ways:

Key combinations

•

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


xvi

| Connecting with TIBCO Resources Connecting with TIBCO Resources

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

How to Access All TIBCO Documentation After you join TIBCOmmunity, you can access the documentation for all supported product versions here: http://docs.tibco.com/TibcoDoc

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

For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: http://www.tibco.com/services/support

•

If you already have a valid maintenance or support contract, visit this site: https://support.tibco.com Entry to this site requires a username and password. If you do not have a username, you can request one.


|1 Chapter 1

Introduction

This chapter gives an introduction to TIBCO ActiveSpaces and TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces.

Topics •

Product Overview, page 2


2

| Chapter 1

Introduction

Product Overview TIBCO ActiveSpaces is a distributed peer-to-peer in-memory data grid, a form of virtual shared memory that leverages a distributed hash table with configurable replication. It allows you to easily create distributed applications that exchange and modify data shared between processes, and across a network. TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop integration projects. TIBCO ActiveMatrix BusinessWorks uses the TIBCO Designer graphical user interface (GUI) for defining business processes and the TIBCO ActiveMatrix BusinessWorks process engine for executing them. TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces plugs into TIBCO ActiveMatrix BusinessWorks and can be installed separately. You can use this plug-in to utilize all the benefits of TIBCO ActiveSpaces without any coding.


|3 Chapter 2

ActiveSpaces Palette

This chapter describes the ActiveSpaces Palette, which contains shared resources and ActiveSpaces activities for TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces.

Topics •

Overview, page 4

•

Metaspace, page 6

•

Space, page 8

•

Put, page 12

•

Get, page 14

•

Take, page 16

•

Begin Transaction, page 18

•

Commit Transaction, page 20

•

Rollback Transaction, page 22

•

Entry Browser, page 24

•

Event Listener, page 27

•

Snapshot, page 30

•

Snapshot Iterator, page 32


4

| Chapter 2


Overview The ActiveSpaces palette includes Shared Resources and ActiveSpaces Activities. It is in the Palettes panel, as shown in Figure 1. Figure 1 ActiveSpaces Palette .

Shared Resources The shared resources for TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces are listed below: •

Metaspace, page 6

•

Space, page 8

•

Space Connection, page 11

ActiveSpaces Activities To achieve different functionalities, ActiveSpaces activities can be divided into the following four groups: •

Basic Operation Activities are as follows:

— Put — Get — Take


Overview 5

|

•

Transaction Activities are as follows:

— Begin Transaction — Commit Transaction — Rollback Transaction •

Browser Activities are as follows:

— Entry Browser — Event Listener •

Snapshot Activities are as follows:

— Snapshot — Snapshot Iterator


6

| Chapter 2


Metaspace Shared Resource

A metaspace is an instance of a cluster of application processes (typically, but not necessarily, deployed on multiple hosts interconnected by a network) using ActiveSpaces. It is an administrative container for a set of spaces (system spaces and user spaces). In TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces, Metaspace is a BusinessWorks shared resource representing a metaspace.

Configuration Tab The Configuration tab has the following fields listed in Table 2. Table 2 Metaspace Configuration Fields Field

Global Var?

Description

Name

No

(Required) The name for the metaspace shared resource. The default name is Metaspace.

Description

No

(Optional) Short description of the metaspace.

Metaspace Name

No

(Required) The Metaspace Name. The metaspace name is a string containing the name of that particular metaspace instance. The name can not start with a "$" or "_", and cannot contain the special characters "." , ">", or "*". The default metaspace name is ms. Note that When you copy and paste a metaspace to the same TIBCO Designer project, the Metaspace Name should be changed to a different name.

Discovery URL

Yes

(Optional) The URL is specified by the metaspace members who intend to become members of the same metaspace. TIBCO Rendezvous and Pragmatic General Multicast (PGM) are two discovery mechanism used in TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces. The default discovery mechanism is PGM. Refer to TIBCO ActiveSpaces User’s Guide for detailed information.

Listening URL

Yes

(Optional) The URL to specify which interface and port the administrative process should create its listening TCP socket on. The format of the Listening URL is tcp://interface:port. Refer to TIBCO ActiveSpaces User’s Guide for detailed information.


Metaspace 7

|

Test Connection Button The Test Connection button allows you to test whether the specified configuration fields result in a valid connection to the metaspace.

Adding Spaces To create a space from the specified metaspace, click one of the following three buttons: •

Introspect Button

•

Import Button

•

Add Space Button

Introspect Button When you click the Introspect button, TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces introspects the metaspace and retrieves all spaces currently existing in the metaspace. When you select one of them from the Space list, the plug-in will generate a space shared resource with the exact space definition as in the metaspace. Only space definition is imported. You need to create Space Connection for introspected spaces. Introspected spaces are read-only. If you want to modify a introspected space, you need to re-create one. Import Button When you click the Import Button, TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces can create a space definition from an XML file. Add Space Button When you click the Add Space Button, TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces can create a space definition manually. The other way to add a space is dragging a space icon from the ActiveSpaces palette into the design panel on the right.


8

| Chapter 2


Space Shared Resource

A space provides shared virtual storage for data. It is a shared entity that can be accessed by multiple applications concurrently, each one of which has the same coherent view of the data contained in the space. The spaces in ActiveSpaces are called tuple spaces, and the items stored in them are called tuples. A space is also a virtual entity distributed and implemented collaboratively by a group of processes located on multiple hosts communicating over the network. In TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces, Space is a BusinessWorks shared resource representing a space. After a space is created in a metaspace, any changes to the space shared resource will not apply to the created space until you re-create the space shared resource.

Configuration Tab The Configuration tab has the following fields listed in Table 3. Table 3 Space Configuration Fields Field

Global Var?

Description

Name

No

(Required) The name for the space and space shared resource. The name cannot start with a "$" or "_" and cannot contain special characters"." , ">", or "*". The default name is Space.

Fields

No

(Required) A field is a portion of a tuple, similar to a single value (or row) in a column of a database table. A field is associated with a name, a type, whether or not the field is the key, and whether or not the field is nullable. If a field is nullable, the value for this field can be null. Click the

button to add fields, as shown in Figure 2.

Note: You must set one or more fields as the key or keys when adding fields in a space.


Space 9

|

Figure 2 Space Configuration Tab

Advanced Tab The Advanced tab has the following fields listed in Table 4. Table 4 Space Configuration Fields Field

Description

Distribution Policy

(Required) Determines whether management of entries in the space is shared among the seeders that have joined the space (distributed) or a single seeder is responsible for all entries in the space (non_distributed). The default value is DISTRIBUTED.

Entry Time to Live (ms)

(Required) Time to live in milliseconds.

Lock Time to Live (ms)

(Required) Specifies in milliseconds the duration of a lock placed on the space.

Lock Wait (ms)

(Required) For a space that is locked, specifies how long a member process will wait for it to become unlocked. The default is 0. Other valid values are any positive value or -1(forever).

The default is -1 (forever).

The default is -1 (forever).

The unit of measure is milliseconds. Eviction Policy

(Required) The policy of the eviction to be applied when a space operation would cause the capacity to be exceeded. It can be none (no eviction) or LRU (least recently used eviction).

Update Transport

(Required) The transport protocol used to distribute notifications of updates to the data stored in the space. It can be either the reliable UNICAST protocol or the reliable MULTICAST protocol.

Capacity

(Required) The capacity of the space in number of entries per seeder. -1

Minimum Seeder Count

indicates infinite number of entries per seeder.

(Required) The minimum number of seeders that need to be joined to the space before the space becomes ready.


10

| Chapter 2


Table 4 Space Configuration Fields (Cont’d) Field

Description

Replication Count

(Required) The replication count is displayed. The default is 0, meaning there is no replication.

Sync Replicated

(Required) It can be true or false.

Persisted

(Required) A value of true means that the space needs to be persisted. The default value is false.

Export... Button When you click the Export... button, the definition of the current space created for TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces will be exported to a file. The content of the file is in XML format.


Space Connection 11

|

Space Connection Shared Resource

Once a space has been defined in a metaspace, it can then be joined by applications and will be automatically joined by agents if the space is distributed. A space can be joined as a distribution role of SEEDER or LEECH, which is specified in Space Connection. Each space can have multiple Space Connections.

It is recommended that you use the same Space Connection type per JVM member for each space.

Configuration Tab The Configuration tab has the following fields listed in Table 3. Table 5 Space Connection Configuration Fields Field

Global Var?

Name

No

Description (Required) The name for the space connection shared resource. The default name is Space Connection.

Distribution Role

No

(Required) The role specifies if applications want to join the space as a SEEDER or as a LEECH. •

SEEDER is a member that joins a space and lends resources, such as memory

and processing power, to the scalability of the space. •

LEECH is a member that joins a space but does not lend any resources to the

space, such as memory or processing power. The default choice is SEEDER.


12

| Chapter 2


Put Activity

The Put activity is used to store tuples in a space.

Configuration The Configuration tab has the following fields listed in Table 6. Table 6 Put Activity — Configuration Tab Field

Global Var?

Description

Name

Yes

The name for the activity in the process definition.

Description

Yes

Short description of the activity.

Space Connection

Yes

Click the button to open the Select A Resource... dialog. All usable spaces are listed in the dialog. Select one to apply to your current activity.

Input The Input tab lists only those tuples you want to put in the associated space. You need to input all the fields specified in the space. Nullable fields are optional.

Output The Output tab has the following fields. Table 7 Put Activity — Output Tab Field

Description

ResultList HasError

Boolean value. The value is true if one or more results have errors.

Result

An Activity Output contains one or more Results listed in the ResultList field.


Put 13

|

Table 7 Put Activity — Output Tab Field

Description Status

The ActiveSpaces status code returned by TIBCO ActiveSpaces functions. See TIBCO ActiveSpaces Java API Reference for more information.

Tuple

A Result can contain one tuple, or none. If there is already an entry containing a tuple with the same key field values stored in the space at the time the Put activity is invoked, the old tuple is returned. If a new tuple is initially put in the space, no tuple is returned.

HasError

Boolean value. The value is true if an error is retured in the Error field.

Error

Each Result has an error field where an exception, if thrown within ActiveSpaces during Tuple processing, will be listed.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 8 Put Activity — Error Output Tab Exception

Description

msg

TIBCO ActiveSpaces error message description.

msgCode

The error code, which is BW-AS-100000. It represents TIBCO ActiveSpaces errors.

ASStatus

The status code returned by TIBCO ActiveSpaces functions. Refer to TIBCO ActiveSpaces Java API Reference for more information.


14

| Chapter 2


Get Activity

The Get activity is used to query tuples from a space.

The Get activity only returns existing tuples. No errors are reported if there are no matched tuples.

Configuration The Configuration tab has the following fields listed in Table 9. Table 9 Get Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Space Connection

Yes


Input For this activity, the input parameters are the keys you specified in the associated space. The Input activity uses the keys to query tuples from the space. For example, when you select MySpace as the Space Connection, MySpace uses ID as the key. In this case, the input parameter will be ID. You need to input all the keys specified in the space. Nullable keys are optional.


Get 15

|

Output The Output tab has the following fields. Table 10 Get Activity — Output Tab Field

Description

ResultList HasError


Result

An Activity Output contains one or more Results listed in the ResultList field. Status


Tuple

This field lists the tuple queried from the space. A Result can contain one tuple, or none.

HasError


Error

Each Result has an error field where an exception, if thrown within ActiveSpaces during tuple processing, will be listed.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 11 Get Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



16

| Chapter 2


Take Activity

The Take activity is used to get and remove tuples from a space.

Configuration The Configuration tab has the following fields listed inTable 12. Table 12 Take Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Space Connection

Yes


Input For this activity, the input parameters are the keys, which you specified in the associated space. The Take activity uses the keys to query tuples and then delete the tuples from the space. For example, when you select MySpace as the space connection, MySpace uses ID as the key. In this case, the input parameter will be ID. You need to input all the keys specified in the space. Nullable keys are optional.


Take 17

|

Output The Output tab has the following fields. Table 13 Take Activity — Output Tab Field

Description

ResultList HasError


Result

An Activity Output contains one or more Results listed in the ResultList field. Status


Tuple

This field lists the tuple that has been removed from the associated space. A Result can contain one tuple, or none.

HasError


Error

Each Result has an error field where an exception, if thrown within ActiveSpaces during tuple processing, will be listed.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 14 Take Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



18

| Chapter 2


Begin Transaction Activity

Begin Transaction is used to start a transaction in an ActiveSpaces process.

Begin Transaction must be used to start a transaction. When calling a TIBCO ActiveMatrix BusinessWorks sub-process in a transaction, do not use the Spawn option. Only Basic operation activities with the same metaspace as the Transaction activities in a TIBCO ActiveMatrix BusinessWorks process are affected by Transaction activities’ behaviors. Transaction activity behavior does not affect activities with metaspaces that differ from the Transaction activities, even though they are in the same TIBCO ActiveMatrix BusinessWorks process.

Configuration The Configuration tab has the following fields listed inTable 15. Table 15 Begin Transaction Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Metaspace

Yes

Select a metaspace on which this activity is invoked. Click the button to open the Select A Resource... dialog. All usable metaspaces are listed in the dialog. Select one to apply to your current activity.

Input This activity has no input.

Output This activity has no output.


Begin Transaction 19

|

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 16 Begin Transaction Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



20

| Chapter 2


Commit Transaction Activity

Commit Transaction commits all of the space operations invoked since Begin Transaction is called.

Configuration The Configuration tab has the following fields listed inTable 17. Table 17 Commit Transaction Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Metaspace

Yes

Select a metaspace on which this activity is invoked. Click the button to open the Select a Resource... dialog. All usable metaspaces are listed in the dialog. Select one to apply to your current activity.



Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 18 Commit Transaction Activity — Error Output Tab Exception

Description

msg



Commit Transaction 21

|

Table 18 Commit Transaction Activity — Error Output Tab Exception

Description

msgCode


ASStatus



22

| Chapter 2


Rollback Transaction Activity

Rollback Transaction reverts all of the space operations invoked since Begin Transaction is called.

Configuration The Configuration tab has the following fields listed in Table 19. Table 19 Rollback Transaction Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Metaspace

Yes

Select a metaspace on which this activity is invoked. Click the button to open the Select A Resource... dialog. All usable metaspaces are listed in the dialog. Select one to apply to your current activity.



Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 20 Rollback Transaction Activity — Error Output Tab Exception

Description

msg



Rollback Transaction 23

|

Table 20 Rollback Transaction Activity — Error Output Tab Exception

Description

msgCode


ASStatus



24

| Chapter 2


Entry Browser Activity

Entry Browser is used to iterate through the contents of a space.

The sequence by which ActiveMatrix BusinessWorks Plug-in for ActiveSpaces invokes Entry Browser and Event Listener can affect the retrieval of some events. For example, if process A is Entry Browser, and process B is Event Listener, and you run processes A and B at the same time, the plug-in can invoke the activities in any order. If the plug-in invokes Entry Browser first, Event Listener might not retrieve any events that may occur between the time Entry Browser and Event Listener are invoked. If the plug-in invokes Event Listener first, Entry Browser might not retrieve any events that may occur between the time Event Listener and Entry Browser are invoked.

Configuration The Configuration tab has the following fields listed in Table 21. Table 21 Entry Browser Activity — Configuration Tab Field

Global Var?

Description

Name

Yes


Description

Yes


Space Connection

Yes



Entry Browser 25

|

Advanced The Advanced tab has the following fields listed inTable 21. Table 22 Entry Browser Activity — Advanced Tab Field

Global Var?

Description

Filter

Yes

(Optional) Specify a filter string in this field. A filtered entry browser only returns entries that match the specified filter. The way filters work in the plug-in is similar to the way message selectors work in JMS (Java Message Service). Note that you must make sure that the filter syntax is correct according to the TIBCO ActiveSpaces documentation. If an invalid filter is given, no results are reported. Refer to TIBCO ActiveSpaces User’s Guide for detailed information on how to use filters.

Distribution Scope

Browser Type

No

No

The distribution scope can be used to narrow down the set of entries being browsed.

•

The ALL item is used to browse over all the entries in the space.

•

The SEEDED item is used to browse only over the entries actually distributed to the member creating the browser.

A GET browser gets and returns the next unread entry. A TAKE browser takes and returns the next unread and unlocked entry.

Time Scope

No

The time scope can be used to narrow down the period of time of interest.

•

The ALL item means that the browser starts with all the entries in the space, and is continuously updated with new entries.

•

The NEW item means that the browser starts empty, and is updated only with entries put into the space after the moment of the browser’s creation.

Misc The Misc tab has the following fields listed in Table 23. Refer to TIBCO ActiveMatrix BusinessWorks Palette Reference for more information about these fields. Table 23 Entry Browser Activity — Misc Tab Field

Description

Sequencing Key

This field can contain an XPath expression that specifies which processes should run in order. Process instances with sequencing keys that evaluate to the same value will be executed sequentially in the order the process instance was created.


26

| Chapter 2


Table 23 Entry Browser Activity — Misc Tab Field

Description

Custom ID

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

Output The Output tab lists any matched tuples in the associated space.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 24 Entry Browser Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



Event Listener 27

|

Event Listener Activity

The Event Listener process starter creates a process instance for incoming events in a specified space. It can listen for the Put, Take, and Expire events, which happened in the space. A listener is similar to a subscriber in a publish-subscribe messaging system.

Configuration The Configuration tab has the following fields listed in Table 25. Table 25 Event Listener Activity — Configuration Tab Field

Global Var?

Description

Name

Yes

(Required) The name for the activity in the process definition

Description

Yes

(Optional) Short description of the activity.

Space Connection

Yes

(Required) Click the button to open the Select A Resource... dialog. All usable spaces are listed in the dialog. Select one to apply to your current activity.

Advanced The Advanced tab contains the fields listed in:Table 26. Table 26 Event Listener Activity — Advanced Tab Field

Global Var?

Description

Filter

Yes

(Optional) Specify a filter string in this field. A filtered event listener only returns events that match the specified filter. The way filters work in the plug-in is similar to the way message selectors work in JMS (Java Message Service). Note that you must make sure that the filter syntax is correct according to the TIBCO ActiveSpaces documentation. If an invalid filter is given, no results are reported. Refer to TIBCO ActiveSpaces User’s Guide for detailed information on how to use filters.


28

| Chapter 2


Table 26 Event Listener Activity — Advanced Tab Field

Global Var?

Description

Time Scope

No

The time scope can be used to narrow down the period of time of interest.

Distribution Scope

No

•

The ALL item means that the listener starts with all the entries currently in the space at creation time (which will be presented as an initial set of PUT events). The set is continuously updated according to changes in the space.

•

The NEW item means that the listener starts empty and is updated only with events related to new or overridden entries in the space.

•

The NEW_EVENTS item means that the listener starts empty, and is updated with all events that occur in the space after creation time. Unlike the NEW time scope, NEW_EVENTS includes events (such as TAKE or EXPIRE events) related to entries already contained in the space at creation time.

The distribution scope can be used to narrow down the set of entries or events being browsed. •

The ALL item is used to listen to events related to all entries in the space.

•

The SEEDED item is used to listen only to events associated with the entries in the space that are seeded by this member. It will be empty unless the member is a seeder on the space.

If distribution scope is SEEDED, there will be additional event types: SEEDED events and UNSEEDED events. Listen for Put Events

No

Listen for the Put events. ActiveSpaces will notify applications whenever a tuple is inserted, updated, or overwritten in the space.

Listen for Take Events

No

Listen for the Take events. ActiveSpaces will notify applications whenever a tuple is removed from the space.

Listen for Expire Events

No

Listen for the Expire events. ActiveSpaces will notify applications whenever a tuple has reached its time to live and has expired in the space.

Listen for Seeded Events

No

This field is visible only when you select the SEEDED item in the Distribution Scope drop-down list. Listen for the SEEDED events. ActiveSpaces will notify applications whenever there is redistribution after an existing seeder leaves the space and now the local node is seeding additional entries.

Listen for Unseeded Events

No

This field is visible only when you select the SEEDED item in the Distribution Scope drop-down list. Listen for the UNSEEDED events. ActiveSpaces will notify applications whenever there is redistribution after a new seeder joins the space and now the local node stops seeding some of the entries.


Event Listener 29

|

Misc The Misc tab contains the fields listed in Table 28. Refer to TIBCO ActiveMatrix BusinessWorks Palette Reference for more information about these fields. Table 27 Event Listener Activity — Misc Tab Field

Description

Sequencing Key

This field can contain an XPath expression that specifies which processes should run in order. Process instances with sequencing keys that evaluate to the same value will be executed sequentially in the order the process instance was created.

Custom ID

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

Output The output items for the activity is listed in Table 28. Table 28 Event Listener Activity — Output Tab Output Item

Description

Type

Event type. The value can be PUT, TAKE, EXPIRE, SEEDED, or UNSEEDED.

Tuple

The matched tuples in the associated space.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 29 Event Listener Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



30

| Chapter 2


Snapshot Activity

The Snapshot activity retrieves the entries that match the conditions you specified in the associated space.

The Snapshot activity cannot get tuples in the associated space between Begin Transaction and Commit Transaction.

Configuration The Configuration tab has the following fields listed in Table 21. Table 30 Snapshot Activity — Configuration Tab Field

Global Var?

Description

Name

Yes

The name for the activity in the process definition

Description

Yes


Space Connection

Yes


Advanced The advanced tab has the following fields listed in Table 31. Table 31 Snapshot Activity — Advanced Tab Field

Description

DistributionScope

(Required) The distribution scope can be used to narrow down the set of entries being browsed.

BrowserType

•

The ALL item is used to get over all the entries in the space.

•

The SEEDED item is used to get only over the entries actually distributed to the member when this activity is invoked.

(Required) There are two entry browser types: •

A GET browser gets and returns all the matched entries.

•

A TAKE browser removes the matched entries.


Snapshot 31

|

Input The input for the activity is listed in Table 32. Table 32 Snapshot Activity — Input Tab Input Item

Data Type

Description

Filter

String

(Optional) Specify a filter string in this field. A filtered snapshot only returns entries that match the specified filter. The way filters work in the plug-in is similar to the way message selectors work in JMS (Java Message Service). Note that you must make sure that the filter syntax is correct according to the TIBCO ActiveSpaces documentation. If an invalid filter is given, no results are reported. Refer to TIBCO ActiveSpaces User’s Guide for detailed information on how to use filters.

Output The Output tab lists any matched tuples in the associated space.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 33 Snapshot Activity — Error Output Tab Exception

Description

msg


msgCode


ASStatus



32

| Chapter 2


Snapshot Iterator Activity

The Snapshot Iterator activity gets one entry each time. This activity is usually used in a TIBCO BusinessWorks group.

The Snapshot Iterator activity cannot get tuples in the associated space between Begin Transaction and Commit Transaction.

Configuration The Configuration tab has the following fields listed in Table 34. Table 34 Snapshot Iterator Activity — Configuration Tab Field

Global Var?

Description

Name

Yes

The name for the activity in the process definition

Description

Yes


Space Connection

Yes


Advanced The Advanced tab has the following fields listed in Table 35. Table 35 Snapshot Iterator Activity — Advanced Tab Field

Description

DistributionScope

(Required) The distribution scope can be used to narrow down the set of entries being browsed.

BrowserType

•

The ALL item used to get all the entries in the space.

•

The SEEDED item is used to get only the entries actually distributed to the member when this activity is invoked.

(Required) There are two entry browser types: •

A GET browser, which gets and returns one entry at each time.

•

A TAKE browser, which removes one entry at each time.


Snapshot Iterator 33

|

Input The input for the activity is listed in Table 36. Table 36 Snapshot Iterator Activity — Input Tab Input Item

Data Type

Description

Filter

String

(Optional) Specify a filter string in this field. A filtered Snapshot Iterator only returns one entry that matches the specified filter at each time. The way filters work in the plug-in is similar to the way message selectors work in JMS (Java Message Service). Note that you must make sure that the filter syntax is correct according to the TIBCO ActiveSpaces documentation. If an invalid filter is given, no results are reported. Refer to TIBCO ActiveSpaces User’s Guide for detailed information on how to use filters. Note that a filter might be reseted when working in a group. Once it is reseted, the filter will evaluate tuples based on the new filter string.

Output The output items for the activity is listed in Table 37. Table 37 Snapshot Iterator Activity — Output Tab Output Item

Description

Tuple

One matched tuple in the associated space.

IsLast

The date type is boolean. •

True means

that the current tuple is the last tuple.

•

False means

that the current tuple is not the last tuple.

Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity at runtime. Table 38 Snapshot Iterator Activity — Error Output Tab Exception

Thrown when

msg


msgCode



34

| Chapter 2


Table 38 Snapshot Iterator Activity — Error Output Tab Exception

Thrown when

ASStatus



| 35 Chapter 3

Working with TIBCO ActiveMatrix BusinessWorks

This chapter describes the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces in TIBCO Designer.

Topics •

Overview, page 36

•

Starting TIBCO Designer, page 37

•

Creating a Project, page 38

•

Creating a Metaspace Shared Resource, page 40

•

Creating a Space Shared Resource, page 41

•

Creating a ActiveSpaces Process, page 43

•

Adding Activities to the Process, page 44

•

Testing the Process, page 45

•

Deploying a Project, page 46


36

| Chapter 3


Overview TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop and test integration projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user interface, TIBCO Designer, for defining business processes and an engine that executes the process. For detailed information about how to configure TIBCO BusinessWorks processes, refer to TIBCO Designer User’s Guide and TIBCO BusinessWorks Process Design Guide. Before starting work, you should ensure that all required software has been installed and is operating correctly. For a list of required software, refer to TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Installation.


Starting TIBCO Designer 37

|

Starting TIBCO Designer TIBCO Designer is used to configure TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces instances. To start TIBCO Designer, execute one of the following platform-specific commands to open the TIBCO Designer window: •

On Microsoft Windows: From the Start menu, select All Programs > TIBCO > TIBCO Designer version_number > TIBCO Designer or From the command line, run TIBCO_HOME\designer\version_number\bin\designer.exe

•

On UNIX: TIBCO_HOME/designer/version_number/bin/designer


38

| Chapter 3


Creating a Project When starting TIBCO Designer, you must create or select a project. A project contains the configuration files that define options used by a runtime plug-in. After a project is configured, it is converted to a repository file and available for use by the runtime plug-in. To create a project: 1. Start TIBCO Designer. 2. Click the New Empty Project button in the TIBCO Designer dialog, as shown in Figure 3. Figure 3 Create a Project

3. Select the Multi-File Project tab (if it is not selected) in the Save Project dialog. Click the Browse button to save the new created project in the desired location, or directly type the path in the Project Directory field. For example, type D:\SampleProjects\ActiveSpaces in the Project Directory field, as shown in Figure 4.


Creating a Project 39

|

Figure 4 Save Project

4. Click the OK button to save the TIBCO Designer Project and open the TIBCO Designer window.


40

| Chapter 3


Creating a Metaspace Shared Resource Before creating or running a TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces instance, you need to create a metaspace shared resource in the existing project. To create a metaspace shared resource, follow these steps: 1. Expand the project folder created in Creating a Project, which is now located in the Project panel. 2. Click the ActiveSpaces palette in the Palettes panel, and drag the Metaspace icon to the design panel on the right. 3. Configure the created metaspace shared resource. Under the Configuration tab, enter the desired metaspace name in the Metaspace Name field, for example, type MyMetasapce in the field. The default name of the metaspace Name is ms. The Metaspace Name field is mandatory. If the Metaspace Name is left blank, TIBCO Designer will throw an error. 4. This can be changed if you want to change it. For more information about configuration, refer to Chapter 2, ActiveSpaces Palette, Metaspace on page 6. 5. Click the Apply button to save the configuration. 6. Save the project.


Creating a Space Shared Resource 41

|

Creating a Space Shared Resource After creating a metaspace shared resource, you need to create space shared resources in the metaspace shared resource. To create a space shared resource, follow these steps: 1. In the Project panel, select the created metaspace shared resource, for example, myMetaspace, to open the metaspace shared resource design panel on the right. 2. Drag the Space icon from the ActiveSpaces palette into the metaspace shared resource design panel. 3. Configure the created space shared resource. For more configuration information, refer to Space on page 8. 4. Click the Apply button to save the configuration. 5. Save the project.


42

| Chapter 3


Creating a Space Connection Shared Resource After creating a space shared resource, you need to create a space connection shared resource in the space shared resource. To create a space connection shared resource, follow these steps: 1. In the Project panel, select the created space shared resource to open the space shared resource design panel on the right. 2. Drag the Space Connection icon from the ActiveSpaces palette into the space shared resource design panel. 3. Configure the created space connection shared resource. For more configuration information, refer to Space Connection on page 11. 4. Click the Apply button to save the configuration. 5. Save the project.


Creating a ActiveSpaces Process 43

|

Creating a ActiveSpaces Process After creating the space, you need to create an ActiveSpaces process to deal with certain workflow. To create an ActiveSpaces process, follow these steps: 1. Expand the project folder created in Creating a Project, which is now located in the Project panel. 2. Expand the Process palette in the Palettes panel and drag the Process Definition resource into the design panel on the right. 3. Configure the process. For more information, refer to TIBCO Designer User’s Guide. 4. Click Apply to save the configuration. 5. Save the project.


44

| Chapter 3


Adding Activities to the Process To add activities to the process, perform the following procedure: 1. Double-click a process in the Project panel, for example, the ActiveSpacesProcess process. The Start and End activities should be displayed in the design panel on the right. 2. Expand the ActiveSpaces palette in the Palettes panel. If the ActiveSpaces palette is not one of the available palettes, choose Palettes > Activities > ActiveSpaces to make the palette visible.

3. Drag one or more activities from the ActiveSpaces palette into the design panel, and then create transitions between each activity on the design panel. For example, add the GET activity to the process and create a transition between each activity. You also can select activities to add from other palettes in the Palettes panel, for example, JDBC activities. 4. Configure each activity in the process. See Chapter 2, ActiveSpaces Palette, on page 3 for more information. 5. Test the process in the Tester panel after adding all needed activities in the process.


Testing the Process 45

|

Testing the Process After creating and configuring a process, you can test it with TIBCO Designer. This allows you to make sure the process works correctly before you deploy it. Refer to TIBCO BusinessWorks Process Design Guide for detailed information about using test mode.


46

| Chapter 3


Deploying a Project When you are ready to deploy your project, generate an Enterprise Archive that contains the configuration for the process definitions you want to deploy. You can upload the archive to TIBCO Administrator to deploy the associated application. See TIBCO 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, then create a process archive in it. 3. Add processes defined in the project to the process archive. 4. Click the Build Archive button under the Enterprise Archive panel to build the archive. When you click the button, TIBCO Designer generates an Enterprise Archive (EAR) file that you can then deploy from TIBCO Administrator. 5. Start the TIBCO Administrator and upload the EAR file for the project. 6. Deploy the application and start the process.


| 47 Chapter 4

Using Sample Projects

This chapter describes the sample project packaged with TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces. Working through the sample project helps you understand how to use TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces.

Topics •

Overview, page 48

•

Running the Sample, page 51


48

| Chapter 4


Overview This sample project gives you a quick overview of how to use ActiveMatrix BusinessWorks Plug-in for ActiveSpaces. The sample project is located in the ASBW_HOME\samples directory. Opening the Sample Project in TIBCO Designer To open the sample project, follow these steps: 1. Start TIBCO Designer. 2. In TIBCO Designer, select the Open item from the Project menu. 3. Select the Multi-File Project tab in the Open Project dialog. 4. Specify the sample project directory in the Project Directory field as follows: ASBW_HOME\samples\DatebaseCache.

5. Click the OK button. The DatebaseCache project is opened, as shown in Figure 6. Figure 5 DatebaseCache Project

Table 39 lists the fields specified in MySpace. Table 39 MySpace Fields Field

Description

id

User ID. It is the key.

name

Username.

email

User’s email. It can be null.

age

User’s age.


Overview 49

|

QueryUserInfo Process This sample project includes a preconfigured process, QueryUserInfo, as shown in Figure 6. The process simulates a Database cache. The flow of events are as follows: •

A user ID change is detected. The process is started.

•

The Get From space activity queries tuples in MySpace with the ID. If there is a tuple that matches the ID, the output will be written in the output.txt file. The output.txt file is located in the ASBW_HOME\samples\DatebaseCache\data directory.

•

If there is no matched tuple, the Read Database File activity queries the database.data file with the ID. The database.data file is located in the ASBW_HOME\samples\DatebaseCache\data directory

•

The Parse Data activity parses the output of the Read Database File activity.

•

If there is no matched tuple, the error log will be written in the output.txt file.

•

If there is a matched tuple, the Map Date activity defines a new process variable called root. The structure of root is defined based on the data format specified in Myspace. The Map Date activity maps the data values to the elements of the root variable.

•

The Cache Into Space will store the tuple in MySpace and the output will be written in the output.txt file.

•

If an error occurs during tuple processing, the error log will be written in the output.txt file.

Figure 6 QueryUserInfo Process

The activities in the process are described in Table 40.


50

| Chapter 4


Table 40 QueryUserInfo Process Activities Activity

Description

File Poller

It polls the input.txt file with the ID, which is the key specified in Myspace. When the ID is created or changed, it starts the process. The input.txt file is located in the ASBW_HOME\samples\DatebaseCache\data directory.

Get From Space

It queries tuples in Myspace with the ID specified in the input.txt file.

Get Success Log

It writes the output of the Get From Space to the output.txt file.

Read Database File

It reads the database.data file and place its contents into this activity’s output.

Parse Data

It takes the input from the Read Database File activity and turns it into the schema tree based on the data format specified in Myspace.

Error Log

It writes the error log to the output.txt file if no tuple is found in the database.

Map Date

It defines a new process variable called root. The structure of root is defined based on the data format specified in Myspace. If there is matched user information, the Map Date activity maps the data values to the elements of the root variable.

Cache Into Space

It stores the output of the Map Date activity into Myspace.

Success Log

It writes the output of the Cache Into Space activity to the output.txt file.

CacheError

If the Cache Into Space activity fails to store the tuple into Myspace, the error will be written to the output.txt file.


Running the Sample 51

|

Running the Sample To run the sample, follow these steps: 1. Start TIBCO Designer. 2. Open the sample project. Refer to Opening the Sample Project in TIBCO Designer on page 48 for more information on how to open the project. 3. Modify the BaseDir global variable for the DatabaseCache project as shown in Figure 7. BaseDir=ASBW_HOME\samples\DatebaseCache\data

Figure 7 BaseDire Global Variable

4. From the Tools menu, select Tester > Start. 5. Select the QueryUserInfo process and click the Load Selected button. The process is started. 6. Type a user ID in the ASBW_HOME\samples\DatebaseCache\data\input.txt file and then save the file. For example: type 001. You will get a log similar to the following in the ASBW_HOME\samples\DatebaseCache\data\output.txt file: Time Stamp Found user - ID: 001, Name: Charlie, Email: [email protected], Age: 22

If you input a user ID, not found in MySpace nor in the ASBW_HOME\samples\DatebaseCache\data\database.data file, you will get an error log

similar to the following: Time Stamp Can't find user - ID: 009


52

| Chapter 4



| 55 Appendix A

Managing ActiveSpaces Logs

This appendix describes how to manage ActiveSpaces logs.

Topics •

Managing Logs, page 56


56

| Appendix A

Managing ActiveSpaces Logs

Managing Logs Logs are used to trace and troubleshoot ActiveSpaces exceptions at design time and runtime. You can specify the log level , the log filename, and the output destination for trace messages by adding the properties listed in Table 41 to the designer.tra (design time) file and the bwengine.tra (runtime) file. See TIBCO ActiveSpaces documentation for detailed information about logs. Table 41 Log Properties Property

Description

java.property.com.tibco.plugin.as.filelog.enable

Boolean value. Set the value to true to enable the logs. The default value is False. Note: If logging is enabled on a JVM, the trace messages of all active metaspaces on this JVM will be logged.

java.property.com.tibco.plugin.as.filelog.level

The amount of logging produced by the ActiveSpaces core library can be adjusted and retrieved using this property. The following values can be used: NONE: Do

not return any information.

FATAL: returns only fatal errors. ERROR: returns errors. WARN: returns warnings. INFO: returns debug

information.

FINE: returns fine debug information. FINER: returns

finer debug information.

FINEST: returns

the finest debug information.

The default value is INFO. Note: After seting a log level, for example INFO, all higer level messages are logged. java.property.com.tibco.plugin.as.filelog.filename

The filename. This is a string value. For example: java.property.com.tibco.plugin.as.log.filename=aslog.txt.

The default value is as-random_number.log. java.property.com.tibco.plugin.as.filelog.directory

The output destination of the log file. This is a string value. For example: java.property.com.tibco.plugin.as.log.directory=c:\logs The default value is ./log. If the specified directory does not exist, it will be created.


| 57 Appendix B

Trace Messages

This appendix lists the error messages used by TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces.

Topics •

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Error Messages, page 58


58

| Appendix B

Trace Messages

TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Error Messages BW-AS-100000: %1 %2 Role: errorRole Category: BW-Plugin Description: Print the TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces exception messages and status. Resolution: No action.

BW-AS-100001: %1 Role: errorRole Category: BW-Plugin Description: Print the TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces exception messages and status. Resolution: No action.

BW-AS-100002: Space Field definitions have not been initialized. Role: errorRole Category: BW-Plugin Description: Space fields are not defined. Resolution: Specify space fields in the space Configuration tab.


TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces Error Messages 59

|

BW-AS-100003: Could not connect to the Metaspace [%1] Role: errorRole Category: BW-Plugin Description: Incorrect discovery URL and listening URL parameters cause an invalid

connection to the metaspace. Resolution: Specify correct discovery URL and listening URL parameters in the

metaspace Configuration tab.

BW-AS-100004: No events selected to publish. Role: errorRole Category: BW-Plugin Description: This error occurred while executing the Even Listener activity. Resolution: Check at least one operation type checkbox in the Advanced tab of the Event

Listener activity.

BW-AS-100005: Cannot find Space Name in space resource [%1] Role: errorRole Category: BW-Plugin Description: The space name is not found in the space resource. Resolution: Specify the space name in the space Configuration tab.

BW-AS-100006: Global variable %1 not defined. Role: errorRole Category: BW-Plugin Description: This (%1) global variable is not defined. Resolution: Create the specific global variable.


60

| Appendix B

Trace Messages

BW-AS-100008: Using Metaspace name=[%1], discovery=[%2], listen=[%3] and Space name=[%4], Distribution Role=[%5] Role: errorRole Category: BW-Plugin Description: Print the metaspace and space configuration information. Resolution: No action.

BW-AS-100009: %1, Transaction id = [%2], Metaspace name=[%3], discovery=[%4], listen=[%5] Role: errorRole Category: BW-Plugin Description: Print the transaction status for the specific metaspace. Resolution: No action.

BW-AS-100010: Space %1 doesn't exist, just create... Role: errorRole Category: BW-Plugin Description: Print this information when a space is initially created. Resolution: No action.

BW-AS-100011: Space %1 creates successfully! Role: errorRole Category: BW-Plugin Description: Print this information after a space is created successfully. Resolution: No action.

BW-AS-100012: Browser doesn't exist, create it! Role: errorRole Category: BW-Plugin



|

Description: Print this information when a browser is initially created for a Snapshot

Iterator activity. Resolution: No action.

BW-AS-100013: Browser's filter has been changed, so create another new browser. Role: errorRole Category: BW-Plugin Description: The Snapshot Iterator filter has been changed and a new browser is created. Resolution: No action.

BW-AS-100014: Take transaction, transaction id = [%1] Role: errorRole Category: BW-Plugin Description: Print the transaction ID, which is running. Resolution: No action.

BW-AS-100015: Release transaction, transaction id = [%1] Role: errorRole Category: BW-Plugin Description: Print the released transaction ID. Resolution: No action.

BW-AS-100016: Cannot find MetaSpace %1 Role: errorRole Category: BW-Plugin Description: The specified metaspace is not found. Resolution: Check the Metaspace field in the Configuration tab of a specific activity.


62

| Appendix B

Trace Messages

BW-AS-100017: Cannot find Space %1 Role: errorRole Category: BW-Plugin Description: The specified space is not found. Resolution: Check the Space Connection field in the Configuration tab of a specific activity and make sure that the specified space connection belongs to an existing space.

BW-AS-100018: Cannot find Space Connection %1 Role: errorRole Category: BW-Plugin Description: The specified space connection is not found. Resolution: Check the Space Connection field in the Configuration tab of a specific

activity.

BW-AS-100019: Browser Type is not specified. Role: errorRole Category: BW-Plugin Description: The browser type is not specified when creating a browser for the Entry Browser, Snapshot, or Snapshot Iterator activity. Resolution: Specify the browser type.

BW-AS-100020: Time Scope is not specified. Role: errorRole Category: BW-Plugin Description: The time scope is not specified for the Entry Browser activity. Resolution: Specify the time scope.

BW-AS-100021: Distribution Scope is not specified. Role: errorRole



|

Category: BW-Plugin Description: The distribution scope is not specified for the Event Listener, Entry

Browser, Snapshot, or Snapshot Iterator activity. Resolution: Specify the distribution scope.

BW-AS-100023: No %1 method in AS API. Role: errorRole Category: BW-Plugin Description: The method is not found in the ActiveSpaces API. Resolution: No action.


64

| Appendix B

Trace Messages


| 65

Index

A

D

ActiveSpaces Activities 4, 4 ActiveSpaces Palette 3, 4 activity Begin Transaction 18 Commit Transaction 20 Entry Browser 24 Event Listener 27 Get 11 Put 11 Rollback Transaction 22 Snapshot 31 Snapshot Iterator 34 Take 16 ASBW_HOME xiv

Distribution scope 63 Documentation xiii

E Enterprise Archive, EAR 48 Entry Browser 24, 62, 62, 63 Browser Type 25 Distribution Scope 25 Filter 25 Time Scope 25 ENV_NAME xiv error messages xii, 57 Event Listener 27, 59, 63 Distribution Scope 28 Filter 27 Listen for Expire Events 28 Listen for Put Events 28 Listen for Seeded Events 28 Listen for Take Events 28 Listen for Unseeded Events 29 Time Scope 28

B Basic Operation Activities 4, 4 Begin Transaction 18 Browsers Activities 5, 5

C changes from the previous release of TIBCO ActiveMatrix BusinessWorks Plug-in for ActiveSpaces User’s Guide xii Commit Transaction 20 Create a Metaspace Shared Resource 42 Create a Project 40 customer support xvi

G Get 11

L Log Properties 56 Logs 56


66

| Index M Metaspace 6, 6, 6, 59, 60, 61 Adding a Spaces 7 Discovery URL 6 Listening URL 6 Metaspace Name 6 Test Connection Button 7

P Put 11

R

Space 8, 8, 8, 8, 58 Capacity 9 Distribution Policy 9 Entry Time to Live 9 Eviction Policy 9 Export... Button 10 Fields 8 Lock Time to Live 9 Lock Wait 9 Minimum Seeder Count 10 Persisted 10 Replication Count 10 Sync Replicated 10 Update Transport 9 space 59, 60, 60, 60, 62 Space Connection 11, 62 Distribution Role 11 support, contacting xvi

Rollback Transaction 22 running the sample 53

T S sample project, location 50 sample project, Process 51 sample project, Space 50 Share Resources 4 shared resource Space 8, 8 Space Connection 11 shared resources 4 Metaspace 6 Snapshot 31, 62, 63 BrowserType 32 DistributionScope 31 Snapshot activities 5, 5 Snapshot Iterator 34, 62, 63 BrowserType 35 DistributionScope 34 Filter 35

Take 16 technical support xvi TIBCO Designer, creating a project 40 TIBCO Designer, starting 39 TIBCO_HOME xiv Time scope 62 Trace Messages 57 Transaction Activities 5, 5 Tuple 8

W Working with TIBCO ActiveMatrix BusinessWorks 37


TIBCO ActiveMatrix BusinessWorks™ Plug-in for ActiveSpaces ...

TIBCO ActiveMatrix BusinessWorks™ Plug-in for ActiveSpaces ...

Suggest Documents

TIBCO ActiveMatrix BusinessWorks Administration - TIBCO Product ...

TIBCO ActiveMatrix BusinessWorks Concepts - TIBCO Product ...

TIBCO ActiveMatrix BusinessWorks Release Notes - TIBCO Product ...

TIBCO ActiveMatrix BusinessWorks Process Design

TIBCO ActiveMatrix BusinessWorks Palette Reference

TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File ...

TIBCO ActiveMatrix BusinessWorks Plug-in for Facebook

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO Managed ...

TIBCO ActiveMatrix BusinessWorks™ Plug-in for REST and JSON ...

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User's Guide

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Release Notes

TIBCO ActiveMatrix BPM SOA Administration

TIBCO BusinessWorks Quick Start Guide.pdf - Google Drive

TIBCO BusinessWorks Palette Reference.pdf - Google Drive

TIBCO BusinessWorks Process Design Guide.pdf - Google Drive

TIBCO BusinessWorks Palette Reference.pdf - Google Drive

TIBCO iProcess™ Engine Architecture Guide - TIBCO Product ...

TIBCO Adapter Concepts - TIBCO Product Documentation

TIBCO BusinessEvents Architect,Aos Guide - TIBCO Product ...

ENERGY DESIGN PLUGIN: AN ENERGYPLUS PLUGIN FOR ...

Sage BusinessWorks Accounting Software

TIBCO Rendezvous Concepts - TIBCO Product Documentation

Sage BusinessWorks Accounting

ADT Plugin for Eclipse