TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer,
TIBCO Administrator, TIBCO. Rendezvous, TIBCO Runtime Agent, TIBCO ...
TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO® Managed File Transfer User’s Guide Software Release 1.0 May 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 Administrator, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO Hawk, and TIBCO Enterprise Message Service 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 © 2012 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer Documentation. . . . . . . . . . xii Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Overview of TIBCO Managed File Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Overview of the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2 MFT Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 MFT Shared Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Request Platform Server Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Wait for Platform Server Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Request Internet Server Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
iv
| Contents Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Wait for Internet Server Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29 29 30 30 31
Listen for Alert Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32 32 34 35 36
Retrieve Audit Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37 37 38 39 40
Chapter 3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Creating a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Adding Activities to a Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Chapter 4 Using the Sample Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Overview of the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Setting Up the FileTransferSample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Working with Internet Server Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 DownloadMsgToQueue Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 UploadFile Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Working with Platform Server Transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 InitialReceiveRequest Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 OverrideTransferFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Appendix A Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Contents v
|
Configuring SSL on TIBCO Enterprise Message Service Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Configuring SSL on a TIBCO Enterprise Message Service Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Configuring SSL on a Apache Active MQ or IBM WebSphere MQ Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Setting Log Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
vi
| Contents
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Figures vii
|
Figures
Figure 1
Communication Between the Plug-in and MFT Command Center . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Figure 2
MFT Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 3
Definition Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 4
Request Platform Server Transfer: Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Figure 5
Wait for Platform Server Completion: Input Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 6
Retrieve Audit Records Activity: Input Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Figure 7
TIBCO Designer Start Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 8
TIBCO Designer Save Project Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Figure 9
FileTransferSample Project in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 10
FileTransferSample: Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
viii
| Figures
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Tables ix
|
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Table 2
MFT Shared Connection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Table 3
Request Platform Server Transfer Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Table 4
Request Platform Server Transfer Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 5
Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Table 6
Request Platform Server Transfer Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 7
Wait for Platform Server Completion Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Table 8
Wait for Platform Server Completion Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 9
Wait for Platform Server Completion Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 10
Request Internet Server Transfer Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 11
Request Internet Server Transfer Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 12
Request Internet Server Transfer Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 13
Request Internet Server Transfer Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 14
Wait for Internet Server Completion Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 15
Wait for Internet Server Completion Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 16
Wait for Internet Server Completion Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Table 17
Listen for Alert Message Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 18
Properties in the Plug-in and Command Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Table 19
Misc Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 20
Listen for Alert Message Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 21
Listen for Alert Message Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Table 22
Retrieve Audit Records Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 23
Retrieve Audit Records Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 24
Retrieve Audit Records Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 25
Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 26
Input of Activities in the DownloadMsgToQueue Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 27
Output of Activities in the DownloadMsgToQueue Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 28
Input of Activities in the UploadFile Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
x
| Tables Table 29
Output of Activities in the UploadFile Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 30
Input of Activities in the InitialReceiveRequest Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 31
Output of Activities in the InitialReceiveRequest Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 32
Input of Activities in the OverrideTransferFiles Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Table 33
Output of Activities in the OverrideTransferFiles Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Table 34
Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
| xi
Preface
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer, integrated with TIBCO BusinessWorks, addresses the needs of the TIBCO BusinessWorks customer who wants a user-friendly way to make use of TIBCO Managed File Transfer. It is assumed that you are familiar with the basic concepts of the TIBCO environment and TIBCO Managed File Transfer.
Topics •
Related Documentation, page xii
•
Typographical Conventions, page xiii
•
Connecting with TIBCO Resources, page xv
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
xii
| Related Documentation Related Documentation This section lists documentation resources you may find useful.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer documentation set: •
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer Installation Read this manual for instructions on site preparation and installation.
•
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide Read this manual for instructions on using the product.
•
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer 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 Designer™
•
TIBCO Administrator™
•
TIBCO ActiveMatrix BusinessWorks™
•
TIBCO Rendezvous®
•
TIBCO Enterprise Message Service™
•
TIBCO Hawk®
•
TIBCO Runtime Agent™
•
TIBCO® Managed File Transfer Command Center
•
TIBCO® Managed File Transfer Internet Server
•
TIBCO® Managed File Transfer Platform Server
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Preface xiii
|
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 MFTPlugin_HOME
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 plug-in installs into a directory within a TIBCO_HOME. This directory is referenced in documentation as MFTPlugin_HOME. The default value of MFTPlugin_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\bw\plugins\mft. 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]
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
xiv
| Typographical Conventions 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 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.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Preface xv
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity TIBCOmmunity 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 Documentation You can access TIBCO documentation here: http://docs.tibco.com
How to Contact TIBCO Support For 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.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
xvi
| Connecting with TIBCO Resources
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
|1 Chapter 1
Introduction
This chapter gives an overview of TIBCO Managed File Transfer (MFT) and TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer.
Topics •
Overview of TIBCO Managed File Transfer, page 2
•
Overview of the Plug-in, page 3
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
2
| Chapter 1
Introduction
Overview of TIBCO Managed File Transfer Advanced managed file transfer is an imperative for any organization with information at its core. TIBCO Managed File Transfer provides the abilities of exchanging large files across all major platforms while ensuring the integrity and security of all transferred data. With built-in automation and integration functionalities, users can easily manage all transfers throughout the organization. The following lists show the TIBCO Managed File Transfer products: •
TIBCO Managed File Transfer Platform Server Execute cross-platform file
transfers up to 30 times faster than FTP and other legacy systems. Powerful scheduling options and event-driven capabilities also enable round the clock automation of all file transfer processes, regardless of location. •
TIBCO Managed File Transfer Internet Server Take complete control over all processes to securely exchange large files over the Internet. Supporting a variety of communication protocols, Internet Server is the ideal solution for integrating with your key trading partners.
•
TIBCO Managed File Transfer Command Center Manage all of your enterprise file
transfers with a single point of control. Serving as the digital dashboard, administrators can use a standard web browser to review and control all internal and external file transfer activity with both Platform and Internet Server. The following lists show the key features of TIBCO Managed File Transfer: •
Security Maximize security at every stage of the process with a full range of built-in
security and authentication processes. •
Speed Built-in RocketStream acceleration technology defeats network latency to deliver speeds up to 30 times faster than FTP or legacy file transfer technologies.
•
Flexibility Easily adapt file transfer needs to changing business requirements, thereby
improving service delivery and trading-partner relationships. •
Compliance Provides encrypted transfers with detailed monitoring and management
controls to comply with all current and future regulatory mandates. •
Integration All of TIBCO's products offer open architecture and API support,
making it easy to integrate file transfer with enterprise applications and support of business process automation. •
Cost Savings Simplify and automate existing processes by standardizing on a single
comprehensive solution to lower operating costs.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Overview of the Plug-in 3
|
Overview of the Plug-in TIBCO 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 TIBCO Managed File Transfer integrated with TIBCO BusinessWorks creates a user-friendly environment that allows you to access the functions provided by TIBCO Managed File Transfer: •
Transfer files cross Platforms
•
Query Audit reports
•
Receive Alert messages
•
Transfer files over the Internet
For this release, the plug-in communicates with TIBCO Managed File Transfer Command Center through JMS server to send or receive messages, as shown in Figure 1. Figure 1 Communication Between the Plug-in and MFT Command Center
Plug-in
JMS Server
TIBCO Managed File Transfer Command Center
Internet Server
Platform Server
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
4
| Chapter 1
Introduction
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
|5 Chapter 2
MFT Palette
This chapter describes the MFT palette, which includes one shared resource and six activities.
Topics •
Palette Overview, page 6
•
MFT Shared Connection, page 7
•
Request Platform Server Transfer, page 10
•
Wait for Platform Server Completion, page 18
•
Request Internet Server Transfer, page 22
•
Wait for Internet Server Completion, page 28
•
Listen for Alert Message, page 31
•
Retrieve Audit Records, page 36
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
6
| Chapter 2
MFT Palette
Palette Overview The MFT palette includes one shared resource and six activities, as shown in Figure 2. Figure 2 MFT Palette
Shared Resource •
MFT Shared Connection, page 7
Activities •
Request Platform Server Transfer, page 10
•
Wait for Platform Server Completion, page 18
•
Request Internet Server Transfer, page 22
•
Wait for Internet Server Completion, page 28
•
Listen for Alert Message, page 31
•
Retrieve Audit Records, page 36
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
MFT Shared Connection 7
|
MFT Shared Connection Shared Resource
The MFT Shared Connection shared resource describes the connections among the plug-in, JMS server, and TIBCO Managed File Transfer Command Center. It can be reused for different activities and processes.
Configuration The Configuration tab has the following fields. Table 2 MFT Shared Connection Configuration (Sheet 1 of 3) Field
Global Var?
Description
Name
No
The name for the resource. The default value is MFT Shared Connection.
Description
No
A short description of the resource. Click the
button to add the description in the Description dialog.
JMS Related Properties JMS User
Yes
The username used to access the JMS server.
JMS Password
Yes
The password used to access the JMS server.
JNDI Context Factory
No
Specify the initial context factory class for accessing JNDI (Java Naming and Directory Interface). The following factory classes can be selected from this drop-down list: •
TIBCO Enterprise Message Service: com.tibco.tibjms.naming.TibjmsInitialContextFactory
•
IBM WebSphere MQ: com.ibm.mq.jms.context.WMQInitialContextFactory
•
Apache Active MQ: org.apache.activemq.jndi.ActiveMQInitialContextFactory
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
8
| Chapter 2
MFT Palette
Table 2 MFT Shared Connection Configuration (Sheet 2 of 3) Field
Global Var?
JNDI Context URL
Yes
Description Specify the URL to the JMS service provider. The general syntax is protocol://hostname:port.
For example: •
TIBCO Enterprise Message Service tcp://192.168.0.1:7222
•
Apache Active MQ tcp://192.168.0.1:61616
•
IBM WebSphere MQ 192.168.0.1:1414/conn_channel
See your JMS provider documentation for details of the URL syntax. Note: If you use SSL for the connection, change the protocol according to your configuration on the server side. Topic Connection Factory
Yes
Specify the Topic connection factory used to create a topic connection with a JMS provider in this field. The default value is TopicConnectionFactory.
Queue Connection Factory
Yes
Specify the Queue connection factory used to create a queue connection with a JMS provider in this field. The default value is QueueConnectionFactory.
Auto-gen Client ID
No
Specify whether or not you want to automatically generate the client ID for the connection. The format of the automatically generated client ID is BW-sharedConnectionName-topicOrQueue-engineName. If this field is not checked, then the value specified in the Client ID field is used for the connection. If no value is specified in the Client ID field, then no client ID is set. If the value specified in the Client ID field is already in use, an error occurs.
Client ID
Yes
Specify the client ID for the connection. Each connection must use a unique Client ID. See your JMS provider’s documentation for more information about client IDs. Note: You cannot use the same JMS Connection resource for accessing both topics and queues. You should create separate JMS Connection resources if you want to access both topic and queue destinations.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
MFT Shared Connection 9
|
Table 2 MFT Shared Connection Configuration (Sheet 3 of 3) Field
Global Var?
Use SSL
No
Description Specify whether you want to use SSL for the connection to the JMS server. SSL is used when the Use SSL checkbox is checked. See Configuring SSL on page 70 for details.
Trusted Certs Location
No
This field only appears when the Use SSL checkbox is checked for TIBCO Enterprise Message Service. Click the button to locate the certificates used to verify the identities of servers and clients. Note: You need to import a folder containing one or more trusted certificates in your project before using them.
TIBCO Managed File Transfer Command Center Related Properties Command Center User
Yes
The name used to log in to TIBCO Managed File Transfer Command Center.
Command Center Password
Yes
The password used to log in to TIBCO Managed File Transfer Command Center.
Management Queue Name
Yes
Specify the pre-defined JMS queue that is used to store the configuration and management related messages defined in TIBCO Managed File Transfer Command Center. The default is Management. Note: The queue name specified in this field must be consistent with the one defined in TIBCO Managed File Transfer Command Center.
Management Request Timeout(Sec)
Yes
Specify how long the plug-in will wait for a management reply message. An error occurs if no management reply message is sent back from TIBCO Managed File Transfer Command Center during this time. The default value is 30. A value of 0 means that the request will never timeout. It is suggested that this value be set to no less than 10 seconds.
Test Connection Button The Test Connection button allows you to test whether the specified configuration fields result in valid connections to the JMS server and TIBCO Managed File Transfer Command Center.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
10
| Chapter 2
MFT Palette
Request Platform Server Transfer Activity
The Request Platform Server Transfer activity sends a Platform Server transfer request to a queue in a JMS server, then TIBCO Managed File Transfer Command Center retrieves the request message from the queue. Once the request is received by TIBCO Managed File Transfer Command Center, the activity immediately gets a submission response. The activity allows you to define a new transfer definition using the Ad Hoc type, and also retrieve a pre-defined transfer definition from the TIBCO Managed File Transfer Command Center using the Defined type. The following lists specify the two ways to submit a Platform Server transfer: •
Defined Type A file transfer definition has been configured in TIBCO Managed File Transfer Command Center. The plug-in retrieves this transfer definition from TIBCO Managed File Transfer Command Center by specifying the Definition ID in the Configuration tab.
•
Ad Hoc Type You need to define your own file transfer definition in this activity.
Configuration The Configuration tab has the following fields. Table 3 Request Platform Server Transfer Configuration (Sheet 1 of 3) Field
Global Var?
Name
No
Description The name for the activity in the process definition. The default value is Request Platform Server Transfer.
Description
No
A short description of the activity. Click the
MFT Connection
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Platform Server Transfer 11
|
Table 3 Request Platform Server Transfer Configuration (Sheet 2 of 3) Field Definition Type
Global Var? No
Description Specify the file transfer definition type used to submit Platform Server transfer request. The following definition types can be selected from this drop-down list:
Platform Server Name
No
•
Defined Type
•
Ad Hoc
Specify the Platform Server where the file transfer request will be initiated. Click the Get Server button to retrieve a server from the Pick Server Name dialog. Or you can type a server name or part of the server name in SQL format as the search criteria. SQL wildcards are accepted, for example, % wildcard which represents one or more characters. If you do not provide any criteria in this field, the plug-in will get all of the defined servers. Note: A maximum of 100 servers can be retrieved from TIBCO Managed File Transfer Command Center at a time. If more than 100 servers match the search criteria, an error occurs and you need to refine your search criteria to retrive the server again. The value in this field can be used as search criteria to get a transfer definition.
Definition Desc
Yes
Definition ID
No
This field only appears when using the Defined type. Specifies the description of the definition. You can use this description as search criteria when you get a transfer definition in the Definition ID field. This field only appears when using the Defined type. Click the Get Transfer Definition button to retrieve the file transfer definition in the Pick Transfer Definition dialog. Note: A maximum of 100 definitions can be retrieved from TIBCO Managed File Transfer Command Center at a time. If more than 100 definitions match the search criteria, an error occurs and you need to refine your search criteria to retrive the definition again. If you provide values in the Platform Server Name and/or Definition Desc fields, these values are used as search criteria to get a transfer definition. The value for the Definition ID field cannot be used as search criteria.
Initiator User
Yes
The user ID used to log in to the Platform Server.
Initiator Password
Yes
The password used to log in to the Platform Server.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
12
| Chapter 2
MFT Palette
Table 3 Request Platform Server Transfer Configuration (Sheet 3 of 3) Field
Global Var?
Description
Responder User
Yes
The user ID that the Initiator sends to the Responder to gain access to the Responder’s system.
Responder Password
Yes
The password that the Initiator sends to the Responder to gain access to the Responder’s system.
Check Transfer Status
No
Specify whether you want to get the transfer status from TIBCO Managed File Transfer Command Center. If checked, TIBCO Managed File Transfer Command Center will send back a detailed transfer status message. Otherwise, no status message is sent back. This checkbox is checked by default. Note: You need to use the Wait for Platform Server Completion activity to receive the transfer status message.
Request Timeout(Sec)
Yes
Specify how long the plug-in waits for a submission response from TIBCO Managed File Transfer Command Center. The default value is 30. If there is no message returned before timeout, a timeout exception occurs.
Refresh Management
No
Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
Definition This tab is only valid when you use the Defined type to submit a Platform Server transfer request. Properties of a transfer definition, which have been configured in TIBCO Managed File Transfer Command Center, are extracted from TIBCO Managed File Transfer Command Center and displayed in this tab, as shown in Figure 3. See the TIBCO Managed File Transfer Command Center Help document for more information about the meaning of each property.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Platform Server Transfer 13
|
Figure 3 Definition Tab
You can override properties of a pre-defined transfer definition by checking the checkboxes in the Override column, then provide values in the Input tab. The value of a property which is set in the Input tab takes precedence over the one set in the pre-defined transfer definition.
Input Different definition types affect the activity input: •
Defined Type
•
Ad Hoc Type
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
14
| Chapter 2
MFT Palette
Defined Type If you use the Defined type to submit a Platform Server transfer request, and do not need to override any transfer properties, the activity requires only the basic inputs: •
requiredTransferInfo — —
UserId:
The user name used to log in to TIBCO Managed File Transfer Command Center. Password:
The password used to log in to TIBCO Managed File Transfer Command
Center •
•
credentialsProperties —
InitiatorPassword:
The password used to log in to the Platform Server.
—
ResponderPassword:
The password that the Initiator sends to the Responder to gain access to the system.
transferStatusProperties —
TransferStatusCheck: specifies whether you want to get the transfer status from TIBCO Managed File Transfer Command Center.
—
TransferStatusCheckInterval:
—
TransferStatusCheckTimeout:
specifies the time in seconds that TIBCO Managed File Transfer Command Center will wait between checks to see if the Platform Server transfer has completed. specifies the time in seconds that TIBCO Managed File Transfer Command Center will wait before timing out a request.
If you want to override some of the definition properties, besides the basic inputs, you also need to provide the value for each of the checked properties in the Definition tab. Parameters set in the Input tab take precedence over those set in the Configuration tab and those set in TIBCO Managed File Transfer Command Center. Ad Hoc Type If you use the Ad Hoc type to submit a Platform Server transfer request, you need to define your own file transfer definition in the Input tab. Figure 4 shows a sample screen of the Input panel using the Ad Hoc type.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Platform Server Transfer 15
|
Figure 4 Request Platform Server Transfer: Input Tab
See the TIBCO Managed File Transfer Command Center Help document for more information about the definition of each property. See the TIBCO Managed File Transfer Command Center Help document for more information about the meaning of the activity input. See TIBCO BusinessWorks Process Design Guide for more information about mapping and transforming input data.
Output The output for the activity is as follows. Table 4 Request Platform Server Transfer Output Output Item
Data Type
Description
JMSCorrelationID
string
The message ID of the request message. This ID is used to link a response message with its related request message.
JMSType
string
The type of a message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is sent.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
16
| Chapter 2
MFT Palette
Table 4 Request Platform Server Transfer Output (Cont’d) Output Item
Data Type
Description
ResponseType
string
It specifies the type of the current response message. The value is always TransferImmediate.
ReturnCode
string
The numeric code returned by TIBCO Managed File Transfer Command Center. Typically, a value of 0 in this element signifies the command executed successfully. A non-zero value usually indicates termination of the command due to an error. See Table 5 for more details.
NumRecords
integer
The number of audit records in the message body. The value is always 1.
Message
string
A detailed transfer submission message or an error message.
SubmitStatus
string
Specifies the submission status. For example, Submit Success.
CheckTransferStatus
string
Specifies whether you want to get the transfer status from TIBCO Managed File Transfer Command Center. If the value is No, TIBCO Managed File Transfer Command Center will not send a detail transfer status message.
InitiatorTransactionID
string
The unique ID for the current Platform Server transfer if the request has been submitted successfully.
Table 5 specifies the return codes. Table 5 Return Code Return Code
Description
0
Success
1
Catch-all failure code (default value)
201
Invalid message format
202
Invalid message data
301
Authentication or authorization failure
401
Failed to submit transfer request to Platform Server
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Platform Server Transfer 17
|
Table 5 Return Code (Cont’d) Return Code
Description
501
Failed to retrieve audits from Platform Server
502
Failed to retrieve audits from Platform Server due to timeout
503
Retrieved the audit indicating the Platform Server transfer has failed
600
Failed to retrieve audits from TIBCO Managed File Transfer Command Center
700
Failed to process a management request
801
TIBCO Managed File Transfer Command Center failed to submit a transfer request to an Internet Server
802
Internet Server failed to transfer request
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 6 Request Platform Server Transfer Exceptions Exception
Cause
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTSendException
Occurs when the plug-in fails to send a file transfer request.
MFTReceiveException
Occurs when the plug-in fails to receive a submission response.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
18
| Chapter 2
MFT Palette
Wait for Platform Server Completion Activity
The Wait for Platform Server Completion activity receives a platform transfer status response with its related request message based on a JMSCorrelationID. The response indicates whether the transfer is completed successfully or not. The activity receives the status response from a JMS queue which is the same as the queue used by the Request Platform Server Transfer activity. This activity should be paired with the Request Platform Server Transfer activity. You need to check the Check Transfer Status checkbox in the Request Platform Server Transfer activity Configuration tab. Otherwise, no status message is returned, and a TimedOutException occurs.
Configuration The Configuration tab has the following fields. Table 7 Wait for Platform Server Completion Configuration Field
Global Var?
Name
No
Description The name for the activity in the process definition. The default value is Request Platform Server Transfer.
Description
No
A short description of the activity. Click the
MFT Connection
No
Refresh Management
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity. Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Wait for Platform Server Completion 19
|
Input The following lists show the inputs of the activity: •
— The activity waits for a specified amount of time to get a status response. By modifying the value of the parameter, in seconds, you can override the timeout value.
processTimeout
The default timeout value is set in the JMS Configuration page in TIBCO Managed File Transfer Command Center. •
— The JMS message ID of the original request message. The activity uses this parameter to link a response message with its related request message. JMSCorrelationID
Figure 5 shows a sample screen of the Input tab. Figure 5 Wait for Platform Server Completion: Input Tab
See TIBCO BusinessWorks Process Design Guide for more information about mapping and transforming input data.
Output The output for the activity is as follows. Table 8 Wait for Platform Server Completion Output Output Item
Data Type
Description
string
The message ID of the original request message. The value is the same as the JMSCorrelationID input.
Properties JMSCorrelationID
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
20
| Chapter 2
MFT Palette
Table 8 Wait for Platform Server Completion Output (Cont’d) Output Item
Data Type
Description
JMSType
string
The type of message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is received.
ResponseType
string
The type of the response. The value is always TransferStatus.
ReturnCode
string
The numeric code returned by TIBCO Managed File Transfer Command Center. Typically, a value of 0 in this element signifies the command executed successfully. A non-zero value usually indicates termination of the command due to an error. See Table 5 for more details.
NumRecords
integer
The number of audit records in the message body. The value is always 1.
Message
string
A detail transfer status message or an error message.
TransferStatus
string
Specify the transfer status. For example, Transfer Complete.
InitiatorTransactionID
string
The unique ID for the current Platform Server transfer if the request has been submitted successfully.
ResponseType
string
The type of the response. The value is TransferStatus.
ServerName
string
The Platform Server that executes the current transfer.
HostName
string
The host that transferred files will be uploaded to or downloaded from.
NumRecords
integer
The number of audit records in the message body. The value is always 1.
AuditRecord
None
This node contains details about the audit record. See the TIBCO Managed File Transfer Command Center Help document for more information about the definition of each property.
Body
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Wait for Platform Server Completion 21
|
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 9 Wait for Platform Server Completion Exceptions Exception
Cause
ActivityTimedOutException
Occurs when the plug-in fails to get a status response due to timeout.
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTReceiveException
Occurs when the plug-in fails to receive a status response.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
22
| Chapter 2
MFT Palette
Request Internet Server Transfer Activity
The Request Internet Server Transfer activity sends an Internet Server request to a queue in a JMS server, then TIBCO Managed File Transfer Command Center retrieves the request message from the queue. Once the request is received by TIBCO Managed File Transfer Command Center, the activity immediately gets a submission response.
Configuration The Configuration tab has the following fields. Table 10 Request Internet Server Transfer Configuration Field
Global Var?
Name
No
Description The name for the activity in the process definition. The default value is Request Internet Server Transfer.
Description
No
A short description of the activity. Click the
MFT Connection
No
Internet Server Name
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity. Specify the Internet Server where the file transfer request will be initiated. Click the Get Server button to retrieve a server from the Pick Server Name dialog. Or you can type a server name or part of the server name in SQL format as the search criteria. SQL wildcards are accepted, for example, % wildcard which represents one or more characters. If you do not provide any criteria in this field, the plug-in will get all of the defined servers. Note: A maximum of 100 servers can be retrieved from TIBCO Managed File Transfer Command Center at a time. If more than 100 servers match the search criteria, an error occurs and you need to refine your search criteria to get the server.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Internet Server Transfer 23
|
Table 10 Request Internet Server Transfer Configuration (Cont’d) Field
Global Var?
Definition Desc
Yes
Specify the description of the definition. You can use this description as search criteria when you get a transfer definition in the Definition Alias Name field.
Definition Alias Name
No
Specify a unique transfer definition.
Description
Click the Get Alias Name button to retrieve an alias from the Pick Alias Name dialog. Or you can type a server name or part of the server name in SQL format as the search criteria. SQL wildcards are accepted, for example, % wildcard which represents one or more characters. If you do not provide any criteria in this field, the plug-in will get all of the definition aliases. Note: A maximum of 100 definition aliases can be retrieved from TIBCO Managed File Transfer Command Center at a time. If more than 100 results match the search criteria, an error occurs and you need to refine your search criteria to get the definition alias. The value in the Definition Desc field can be used as the search criteria.
Check Transfer Status
No
Specify whether you want to get the transfer status from TIBCO Managed File Transfer Command Center. If checked, TIBCO Managed File Transfer Command Center will send back a detailed transfer status message. Otherwise, no status message is sent back. Note: You need to use the Wait for Internet Server Completion activity to receive the transfer status message.
Request Timeout(Sec)
Yes
Specify how long the plug-in waits for a submission response from TIBCO Managed File Transfer Command Center. The default value is 30. If there is no message returned before timeout, a timeout exception occurs.
Refresh Management
No
Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
24
| Chapter 2
MFT Palette
Input The Input tab has the following fields. Table 11 Request Internet Server Transfer Input Output Item
Data Type
Description
UserID (Optional)
string
The username used to log in to TIBCO Managed File Transfer Command Center. Note: This parameter set in the Input tab takes precedence over the one set in the MFT Shared Connection Configuration tab.
Password (Optional)
string
The password used to log in to TIBCO Managed File Transfer Command Center. Note: This parameter set in the Input tab takes precedence over the one set in the MFT Shared Connection Configuration tab.
ServerName (Optional)
string
Specify the Internet Server where the file transfer request will be initiated. Note: This parameter set in the Input tab takes precedence over the one set in the Configuration tab.
JMSOrFile (Required)
string
Specify the type of Internet Transfer request to be used, queue or file type. Enter the string Queue for queue type, and the string File for file type
JMSNameOrFilePath (Required)
string
Specify the name of the queue when the Queue type is used.
RemoteFileName (Optional)
string
Specify the name of the file to be uploaded to or downloaded from a remote server.
UploadDownload (Required)
string
Specify the transfer direction. Valid value is Upload or Download.
Specifies the fully qualified file name when the File type is used.
•
Upload
— Read a message from a queue or the content of a file, and write to a remote server.
•
Download
— Read a file from a remote server, and write message to a queue or content to a file.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Internet Server Transfer 25
|
Table 11 Request Internet Server Transfer Input (Cont’d) Output Item
Data Type
TextBinary (Optional)
string
Description JMS queue type Download only. Define the format of data written to the JMS queue. Valid value is Text or Binary:
MessageSelector (Optional)
string
•
Text
— JMS Text Data
•
Binary
— JMS Byte Stream
JMS queue type Upload only. Specify the message selector that is used to filter messages read from the JMS queue. For example: PropertyName='SelectorValue'
Property (Optional)
string
JMS queue type Download only. Specify the property in the created message. For example: PropertyName= propertyValue
MessageDelimiter (Optional)
string
JMS queue type only. Specify whether the file transfer should convert a Carriage Return (CR) and/or Line Feed (LF). There are three available values: •
CRLF
•
LF
•
None
— indicates CR and/or LF can be used.
— indicates only LF can be used. — indicates no conversion is used. This is the default value.
For the Upload transfer, add this delimiter after each message. For the Download transfer, parse stream into messages based on this delimiter. MaxMessageSize (Optional)
string
JMS queue type Download only. Specify the maximum size of any JMS message. For example: 1024K or 1M (K stands for kilobytes and M stands for megabytes.) Note: If a message is larger than this maximum size, it will be split into multiple messages.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
26
| Chapter 2
MFT Palette
Output The output for the activity is as follows. Table 12 Request Internet Server Transfer Output Output Item
Data Type
Description
JMSCorrelationID
string
The message ID of the request message. This ID is used to link a response message with its related request message.
JMSType
string
The type of message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is sent.
ResponseType
string
Specify the type of the current response message. The value is always TransferImmediate.
ReturnCode
string
The numeric code returned by TIBCO Managed File Transfer Command Center. Typically, a value of 0 in this element signifies the command executed successfully. A non-zero value usually indicates termination of the command due to an error. See Table 5 for more details.
NumRecords
integer
The number of audit records in the message body. The value is always 1.
Message
string
A detail transfer submission message or an error message.
SubmitStatus
string
Specify the submission status. For example, Submit Success.
CheckTransferStatus
string
Specify whether you want to get the transfer status from TIBCO Managed File Transfer Command Center. If the value is No, TIBCO Managed File Transfer Command Center will not send a detail transfer status message.
InitiatorTransactionID
string
The unique ID for the current Internet Server transfer if the request has been submitted successfully.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Request Internet Server Transfer 27
|
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 13 Request Internet Server Transfer Exceptions Exception
Cause
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTSendException
Occurs when the plug-in fails to send a file transfer request.
MFTReceiveException
Occurs when the plug-in fails to receive a submission response.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
28
| Chapter 2
MFT Palette
Wait for Internet Server Completion Activity
The Wait for Internet Server Completion activity receives an Internet transfer status response with its related request message based on a JMSCorrelationID. The response indicates whether the transfer is completed successfully or not. The activity receives the status response from a JMS queue which is the same as the queue used by the Request Internet Server Transfer activity. This activity should be paired with the Request Internet Server Transfer activity. You need to check the Check Transfer Status checkbox in the Request Internet Server Transfer activity Configuration tab. Otherwise, no status message is returned, and a TimedOutException occurs.
Configuration The Configuration tab has the following fields. Table 14 Wait for Internet Server Completion Configuration Field
Global Var?
Name
No
Description The name for the activity in the process definition. The default value is Request Platform Server Transfer.
Description
No
A short description of the activity. Click the
MFT Connection
No
Refresh Management
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity. Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Wait for Internet Server Completion 29
|
Input The following lists show the inputs of the activity: •
processTimeout
— The activity waits for a specified amount of time to get a status response. By modifying the value of the parameter, in seconds, you can override the timeout value. The default timeout value is 3600 seconds.
•
JMSCorrelationID
— The JMS message ID of the original request message. The activity uses this parameter to link a response message with its related request message.
See TIBCO BusinessWorks Process Design Guide for more information about mapping and transforming input data.
Output The output for the activity is as follows. Table 15 Wait for Internet Server Completion Output Output Item
Data Type
Description
JMSCorrelationID
string
The message ID of the original request message. The value is the same as the JMSCorrelationID input.
JMSType
string
The type of message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is received.
ResponseType
string
The type of the response.
ReturnCode
string
The numeric code returned by TIBCO Managed File Transfer Command Center.
Properties
Typically, a value of 0 in this element signifies the command executed successfully. A non-zero value usually indicates termination of the command due to an error. See Table 5 for more details. NumRecords
integer
The number of audit records in the message body. The value is always 1.
Message
string
A detail transfer status message or an error message.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
30
| Chapter 2
MFT Palette
Table 15 Wait for Internet Server Completion Output (Cont’d) Output Item
Data Type
Description
TransferStatus
string
Specify the transfer status. For example, Transfer Complete.
InitiatorTransactionID
string
The unique ID for the current Platform Server transfer if the request has been submitted successfully.
ResponseType
string
The type of the response.
ServerName
string
The Platform Server that executes the current transfer.
HostName
string
The host that transferred files will be uploaded to or downloaded from.
NumRecords
integer
The number of audit records in the message body. The value is always 1.
AuditRecord
None
This node contains details about the audit record. See the TIBCO Managed File Transfer Command Center Help document for more information about the definition of each property.
Body
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 16 Wait for Internet Server Completion Exceptions Exception
Cause
ActivityTimedOutException
Occurs when the plug-in fails to get a status response due to timeout.
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTReceiveException
Occurs when the plug-in fails to receive a status response.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Listen for Alert Message 31
|
Listen for Alert Message Activity
The Listen for Alert Message activity starts a process when an alert is triggered in TIBCO Managed File Transfer Command Center. You define an alert trigger criterion in TIBCO Managed File Transfer Command Center, and the JMS alert action is triggered when a transfer matches all these criteria. Then, TIBCO Managed File Transfer Command Center will send an alert message to a JMS Topic to which the Listen for Alert Message activity listens with the specified message selector. Alerts can be triggered by either Internet Server transfers or Platform Server transfers.
Configuration The configuration tab has the following fields. Table 17 Listen for Alert Message Configuration Field
Global Var?
Description
Name
No
The name for the activity in the process definition.
Description
No
A short description of the activity. Click the
MFT Connection
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
32
| Chapter 2
MFT Palette
Table 17 Listen for Alert Message Configuration (Cont’d) Field MFT Message Selector
Global Var? Yes
Description A JMS message selector used to determine which message should be received. The JMSType, AlertID, AlertDescription, Severity, TransferType, ServerName, TransferDirection, Department, ClientFileName, ServerFileName, TransferStatus, ProcessName, TransferDescription, TemplateFile, and Comment properties can be used as the selector. For example: JMSType='valueInCCAleart', TransferType='Internet Transfer',
or AlertID='L50920000001'
These plug-in properties correspond to those in TIBCO Managed File Transfer Command Center, see Table 18 for details. See JMS Specification or your JMS provider documentation for more information about the syntax of a message selector string. Refresh Management
No
Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
Table 18 shows the properties of the plug-in that correspond to those in TIBCO Managed File Transfer Command Center. Table 18 Properties in the Plug-in and Command Center Properties in the Plug-in
Properties in TIBCO Managed File Transfer Command Center
AlertID
Alert Id
AlertDescription
Alert Description
Severity
Severity
TransferType
Transfer Type
ServerName
Server Name
TransferDirection
Transfer Direction
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Listen for Alert Message 33
|
Table 18 Properties in the Plug-in and Command Center (Cont’d) Properties in the Plug-in
Properties in TIBCO Managed File Transfer Command Center
Department
Department
ClientFileName
Client File Name
ServerFileName
Server File Name
TransferStatus
Transfer Status
ProcessName
Process Name
TransferDescription
Transfer Description
TemplateFile
Template File for Additional Criteria
Misc The Misc tab contains the following fields. Table 19 Misc Fields Input Item
Data Type
Description
Sequencing Key
Yes
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.
Custom Id
Yes
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.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
34
| Chapter 2
MFT Palette
Output The output for the activity is as follows. Table 20 Listen for Alert Message Output Output Item
Data Type
Description
JMSCorrelationID
string
The message ID of the original request message. The value is the same as the input JMSCorrelationID.
JMSType
string
The type of message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is received.
Comment
string
The comment defined on the alert configuration page in TIBCO Managed File Transfer Command Center.
ResponseType
string
The type of the response.
ServerName
string
The Platform Server that executes the current transfer.
HostName
string
The host that transferred files will be uploaded to or downloaded from.
NumRecords
string
The number of audit records in the message body. The value is always 1.
AuditRecord
None
This node contains details about the audit record. See the TIBCO Managed File Transfer Command Center Help document for more information about the definition of each property.
Properties
Body
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Listen for Alert Message 35
|
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 21 Listen for Alert Message Exceptions Exception
Cause
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
36
| Chapter 2
MFT Palette
Retrieve Audit Records Activity
The Retrieve Audit Records activity allows you to search for the audit report of Platform or Internet server transfers. It sends an audit request to TIBCO Managed File Transfer Command Center through the JMS queue, and receives an audit response that contains detailed information about a completed file transfer. A maximum of 100 audit records can be retrieved from TIBCO Managed File Transfer Command Center at a time. If more than 100 audits match the search criteria, an error occurs.
Configuration The configuration tab has the following fields. Table 22 Retrieve Audit Records Configuration Field
Global Var?
Description
Name
No
The name for the activity in the process definition.
Description
No
A short description of the activity. Click the
MFT Connection
No
button to add the description in the Description dialog.
Specify a shared resource. Click the button to open the Select A Resource dialog. All usable MFT shared resources are listed in the dialog. Select one to apply to your current activity.
Request Timeout(Sec)
Yes
Specify how long the application will reconnect to the JMS server when an error occurs. The default value is 30. A value of 0 means the request will never expire.
Refresh Management
No
Specify whether you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center. If checked, the plug-in will request the management messages for the activity. Otherwise, the plug-in will use the cached management information.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Retrieve Audit Records 37
|
Input Figure 6 shows a sample screen of the Input tab. Figure 6 Retrieve Audit Records Activity: Input Tab
As shown in Figure 6, the AuditType parameter is a required input, you need to provide a value for it. For example: "PlatformServer". You can click the button in the Input tab for details about the syntax of the input. The FromDate, ToDate, NumDays parameters are optional. If you do not set any values for these parameters, the audits of the current day will be returned. If you set values for FromDate and ToDate parameters, the values for the NumDays parameter will be ignored. If you only set a value for the NumDays parameter, audits in NumDays days will be returned, starting from the current day. For example, if you set NumDays to 2, audits from the current and previous day will be returned. See the TIBCO Managed File Transfer Command Center Help document for more information about the meaning of the activity input.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
38
| Chapter 2
MFT Palette
See TIBCO BusinessWorks Process Design Guide for more information about mapping and transforming input data.
Output The output for the activity is as follows. Table 23 Retrieve Audit Records Output Output Item
Data Type
Description
JMSCorrelationID
string
The message ID of the original request message. The value is the same as the input JMSCorrelationID.
JMSType
string
The type of message used to distinguish messages stored in the same JMS queue. It is configurable in TIBCO Managed File Transfer Command Center.
JMSDestination
string
The destination where a message is sent and received.
ResponseType
string
The type of the response.
ReturnCode
string
The numeric code returned by TIBCO Managed File Transfer Command Center.
Properties
Typically, a value of 0 in this element signifies the command executed successfully. A non-zero value usually indicates termination of the command due to an error. See Table 5 for more details. NumRecords
integer
The number of audit records in the message body.
Message
string
A detail transfer submission message or an error message.
TransferStatus
string
Specify the transfer status. For example, Transfer Complete.
InitiatorTransactionID
string
The unique ID for each Platform Server if succeeded in submitting the transfer.
ResponseType
string
The type of the response.
ServerName
string
The Platform Server that executes the current transfer.
Body
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Retrieve Audit Records 39
|
Table 23 Retrieve Audit Records Output (Cont’d) Output Item
Data Type
Description
HostName
string
The host that transferred files will be uploaded to or downloaded from.
NumRecords
integer
The number of audit records in the message body. The maximum value is 100.
AuditRecord
None
This node contains details about the audit record. See the TIBCO Managed File Transfer Command Center Help document for more information about the definition of each property.
Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 24 Retrieve Audit Records Exceptions Exception
Cause
MFTConnectionException
Occurs when the plug-in fails to connect to a JMS server or TIBCO Managed File Transfer Command Center.
MFTSendException
Occurs when the plug-in fails to request an Audit response.
MFTReceiveException
Occurs when the plug-in fails to receive an Audit response.
MFTValidationException
Occurs when a request message does not match the pre-defined request schema.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
40
| Chapter 2
MFT Palette
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
| 41 Chapter 3
Getting Started
This chapter describes the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer in TIBCO Designer.
Topics •
Overview, page 42
•
Prerequisites, page 43
•
Creating a Project, page 44
•
Creating a Process, page 46
•
Adding Activities to a Process, page 47
•
Testing a Process, page 48
•
Deploying a Project, page 49
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
42
| Chapter 3
Getting Started
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 processes. For detailed information about how to configure processes, see TIBCO Designer documentation, which can be accessed from the Help > Designer Help menu option in TIBCO Designer. A typical configuration session contains the following steps: 1. Creating a Project, page 44 2. Creating a Process, page 46 3. Adding Activities to a Process, page 47 4. Testing a Process, page 48 5. Deploying a Project, page 49
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Prerequisites 43
|
Prerequisites Before starting the configuration processes, make sure that you have copied the dependency JAR files to your working environment, and completed the JMS service configuration. •
Copying JAR Files
•
Configuring the JMS Service
Copying JAR Files You must copy the following JAR files to the TIBCO_HOME\plugins\lib directory: •
Copy the jms.jar file to the directory.
•
Copy the tibjms.jar JAR file to the directory when you use TIBCO Enterprise Message Service as the JMS provider.
•
Copy the activemq-all-5.5.1.jar JAR file to the directory when you use Apache Active MQ as the JMS provider.
•
Copy the following JAR files when you use WebSphere MQ as the JMS provider: —
com.ibm.mq.commonservices.jar
—
com.ibm.mq.headers.jar, com.ibm.mq.jar
—
com.ibm.mq.jmqi.jar
—
com.ibm.mq.pcf.jar
—
com.ibm.mqjms.jar
—
connector.jar
—
dhbcore.jar
—
mqcontext.jar
Configuring the JMS Service To configure the JMS service, you can access the JMS service page in TIBCO Managed File Transfer Command Center and select Management > Management Services > JMS Service > Configure JMS Service to start the configuration. See the TIBCO Managed File Transfer Command Center Help document for more information about how to configure the JMS service.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
44
| Chapter 3
Getting Started
Creating a Project The TIBCO Designer GUI is used to configure the plug-in. When starting TIBCO Designer, you must create or select a project. A project contains the configuration files that define options used during runtime. To create a project, complete the following steps: 1. Start TIBCO Designer. Execute one of the following platform-specific commands to open the TIBCO Designer window: — On Microsoft Windows Click Start > All Programs > TIBCO > TIBCO Designer version_number > TIBCO Designer. Or From a command window, run TIBCO_HOME\designer\version_number\bin\designer.exe. — On UNIX From a command window, run TIBCO_HOME/designer/version_number/bin/designer. 2. Click the New Empty Project button in the TIBCO Designer dialog, as shown in Figure 7. The Save Project dialog appears. Figure 7 TIBCO Designer Start Screen
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Creating a Project 45
|
3. Click the button in the Multi-File Project tab. Navigate to the location where you intend to save the project and specify a name for the project. Click the OK button to continue, as shown in Figure 8. Figure 8 TIBCO Designer Save Project Screen
The TIBCO Designer GUI appears with the newly created project.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
46
| Chapter 3
Getting Started
Creating a Process After creating a new project in the TIBCO Designer window, you need to create a process to deal with certain workflows. To create a process, complete the following steps: 1. Select the root directory in the project panel. 2. Expand the Process palette in the palette panel and drag the Process Definition icon into the design panel. 3. Configure the process. For more information, see TIBCO Designer User’s Guide. 4. Click the Apply button to save the configuration.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Adding Activities to a Process 47
|
Adding Activities to a Process After you created a process, you can add the plug-in activities to it. To add an activity to the process, complete the following steps: 1. Click the process that was previously created in Creating a Process on page 46. The Start and End activities appear in the design panel. 2. Expand the MFT palette in the palette panel 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. If the MFT palette is not shown in the palette panel, select Palettes > Activities > MFT from the menu bar to make it visible. 3. Create transitions between activities in the design panel. 4. Configure each activity in the process. For configuration information, see MFT Palette on page 5.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
48
| Chapter 3
Getting Started
Testing a Process After creating and configuring a process, you can test it in TIBCO Designer. This allows you to check if the process works properly before you deploy it. See TIBCO BusinessWorks Process Design Guide for detailed information on using test mode.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Deploying a Project 49
|
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. When deploying a project, if you want to set log status, you need to add properties in the file located in the TIBCO_HOME\bw\version\lib\com\tibco\deployment directory.
bwengine.xml
See Setting Log Status on page 73 for details.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
50
| Chapter 3
Getting Started
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
| 51 Chapter 4
Using the Sample Project
This chapter describes a sample project packaged with TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer. Working through the sample project will help you understand how TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer works.
Topics •
Overview of the Sample Project, page 52
•
Setting Up the FileTransferSample Project, page 53
•
Working with Internet Server Transfers, page 56
•
Working with Platform Server Transfers, page 62
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
52
| Chapter 4
Using the Sample Project
Overview of the Sample Project The FileTransferSample project associated with the TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer installation demonstrates how the plug-in is used to access the file transfer function provided by TIBCO Managed File Transfer. It is located in the MFTPlugin_HOME\examples directory. The sample project contains two folders, the InternetTransfer folder and the PlatformTransfer folder. InternetTransfer The following two processes in the InternetTransfer folder demonstrate how to use the Request Internet Server Transfer and Wait for Internet Server Completion activities to transfer files using the Internet server. •
DownloadMsgToQueue Process, page 56
•
UploadFile Process, page 59
PlatformTransfer The following two processes in the PlatformTransfer folder demonstrate how to use the Request Platform Server Transfer and Wait for Platform Server Completion activities to transfer files cross platforms. •
InitialReceiveRequest Process, page 62
•
OverrideTransferFiles, page 64
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Setting Up the FileTransferSample Project 53
|
Setting Up the FileTransferSample Project Before running the sample project, you need to perform the following tasks to set up the FileTransferSample project in TIBCO Designer: •
Task A, Open the Project, page 53
•
Task B, Configure Global Variables, page 54
•
Task C, Configure and Test the MFT Shared Connection, page 55
•
Task D, Meet the Prerequisites of each Process, page 55
Task A Open the Project To open the FileTransferSample project, complete the following steps: 1. Start TIBCO Designer. 2. Click the Open Existing Project button. 3. Click the button in the Open Project dialog to locate the sample project, then click the OK button. The project appears, as shown in Figure 9. Figure 9 FileTransferSample Project in TIBCO Designer
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
54
| Chapter 4
Using the Sample Project
Task B Configure Global Variables To ensure that the process works properly, you need to update global variables based on your working environment. Global variables provide an easy way to set defaults for use throughout your project. See TIBCO Designer User’s Guide for details. The FileTransferSample project contains seven user-defined global variables, as shown in Figure 10. Figure 10 FileTransferSample: Global Variables
Table 25 specifies global variables in the FileTransferSample project. Table 25 Global Variables Global Variables
Description
ContextURL
Indicate the URL to the JMS service provider.
CCUserID
The name used to log in to TIBCO Managed File Transfer Command Center.
CCPassword
The password used to log in to TIBCO Managed File Transfer Command Center.
InitiatorUser
Indicate the user ID used to log in to the Platform Server.
InitiatorPwd
Indicate the password used to log in to the Platform Server.
ResponderUser
Indicate the user ID to the Responder to gain access to the system.
ResponderPwd
Indicate the password to the Responder to gain access to the system.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Setting Up the FileTransferSample Project 55
|
Task C Configure and Test the MFT Shared Connection You need to configure the MFT Shared Connection based on your working environment, then test whether the specified configuration results in a valid connection to the JMS server, and TIBCO Managed File Transfer Command Center. The following list shows the properties you need to configure in the MFT Shared Connection: •
JNDI Context Factory The example uses TIBCO Enterprise Message Service as the JMS provider. Therefore, you must select the com.tibco.tibjms.naming.TibjmsInitialContextFactory factory class.
•
JNDI Context URL, Command Center User and Password The values in these three fields are mapped from global variables. You must update these global variables based on your working environment.
•
Management Queue Name The default value is Management, which is a pre-defined JMS queue. You must create this queue before using it, and make sure it is the same one used in TIBCO Managed File Transfer Command Center.
After configuring the shared resource, you need to click the Test Connection button to make sure that all connections are set up successfully. Task D Meet the Prerequisites of each Process Before you test a process, make sure each process also meets its prerequisite, which is specified in the Prerequisite section of each process.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
56
| Chapter 4
Using the Sample Project
Working with Internet Server Transfers This section specifies how to use the plug-in to manage Internet transfers. The InternetTransfer folder contains the following two processes: •
DownloadMsgToQueue Process, page 56
•
UploadFile Process, page 59
DownloadMsgToQueue Process The following sections specify the prerequisites and description of the DownloadMsgToQueue process, as well as the input and output for each activity. Prerequisites Before you work on the process, ensure that all the following prerequisites are satisfied: •
In a EMS server, you must create a JMS queue before using it. In this sample, the queue with the name IS.MSG.Queue is used.
•
In TIBCO Managed File Transfer Command Center, you must complete the following tasks: — Create an Internet Server named TIBDemoIS. — Create an Internet transfer definition with the TIBDemoDownloadQueue virtual alias on the TIBDemoIS Internet Server. Set Directory Transfer to No, and Transfer Direction to Download To Client.
For how to create an Internet Server and Internet transfer definition, see the TIBCO Managed File Transfer Command Center Help document for details. Description The DownloadMsgToQueue process demonstrates that the TIBDemoIS Internet Server downloads a file from a remote server to the Demo.MSG.Queue JMS queue in the EMS server. The remote server and the file are defined in the transfer definition in TIBCO Managed File Transfer Command Center.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Internet Server Transfers 57
|
Input for Activity Table 26 shows the input for the Request Internet Server Transfer activity and the Wait for Internet Server Completion activity. Table 26 Input of Activities in the DownloadMsgToQueue Process Variable
Value
Request Internet Server Transfer JMSOrFile
"Queue"
JMSNameOrFilePath
"Demo.Msg.Queue"
UploadDownload
"Download"
TextBinary
"Text"
MaxMessageSize
"50K"
Wait for Internet Server Completion JMSCorrelationID
Output of the Request Internet Server Transfer.
Output for Activity Table 27 shows the output for the Request Internet Server Transfer activity and the Wait for Internet Server Completion activity. Table 27 Output of Activities in the DownloadMsgToQueue Process Variable
Value
Request Internet Server Transfer JMSCorrelationID
ID:EMS-SERVER.21684F6AD45231FE:6 Note: This ID will be changed when you rerun the process.
JMSType
Internet-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferImmediate
ReturnCode
0
NumRecords
0
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
58
| Chapter 4
Using the Sample Project
Table 27 Output of Activities in the DownloadMsgToQueue Process (Cont’d) Variable
Value
Message
Transaction I427200570 submitted successfully to Internet Server TIBDemoIS on hostname YourHostName.
SubmitStatus
Submit Success
CheckTransferStatus
Yes
InitiatorTransactionID
I427200570 Note: This ID will be changed when you rerun the process.
Wait for Internet Server Completion JMSCorrelationID
ID:EMS-SERVER.21684F6AD45231FE:6 Note: This ID is the same as the JMSCorrelationID variable in the Request Internet Server Transfer activity.
JMSType
Internet-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferStatus
ReturnCode
0
NumRecords
1
Message
Transfer Complete
TransferStatus
SUCCESS
InitiatorTransactionID
I427200570 Note: This ID will be changed when you rerun the process.
Body
The content of the message.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Internet Server Transfers 59
|
UploadFile Process The following sections specify the prerequisites and description of the UploadFile process, as well as the input and output for each activity. Prerequisites Before you work on the process, ensure that the following tasks have been completed in TIBCO Managed File Transfer Command Center: •
Create an Internet Server named TIBDemoIS.
•
Create an Internet transfer definition with the TIBDemoUploadFile virtual alias on the TIBDemoIS Internet Server. Set Directory Transfer to Yes, and Transfer Direction to Upload To Server.
For how to create an Internet Server and Internet transfer definition, see the TIBCO Managed File Transfer Command Center Help document for details. Description The UploadFile process demonstrates that the TIBDemoIS Internet Server uploads the ISLocalFile.txt file to the ISTargetFile.txt file in the remote server. The remote server is defined in the transfer definition in TIBCO Managed File Transfer Command Center. Input for Activity Table 28 shows the input for the Request Internet Server Transfer activity and the Wait for Internet Server Completion activity. Table 28 Input of Activities in the UploadFile Process Variable
Value
Request Internet Server Transfer JMSOrFile
"File"
JMSNameOrFilePath
"c:/Demo/ISLocalFile.txt"
RemoteFileName
"ISTargetFile.txt"
UploadDownload
"Upload"
TextBinary
"Text"
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
60
| Chapter 4
Using the Sample Project
Table 28 Input of Activities in the UploadFile Process (Cont’d) Variable
Value
Wait for Internet Server Completion JMSCorrelationID
Output of the Request Internet Server Transfer. See Chapter 2, MFT Palette on page 5 for details about the description for each input of the activity. Output for Activity Table 29 shows the output for the Request Internet Server Transfer activity and the Wait for Internet Server Completion activity.
Table 29 Output of Activities in the UploadFile Process Variable
Value
Request Internet Server Transfer JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523210:11 Note: This ID will be changed when you rerun the process.
JMSType
Internet-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferImmediate
ReturnCode
0
NumRecords
0
Message
Transaction I427200605 submitted successfully to Internet Server TIBDemoIS on hostname YourHostName.
SubmitStatus
Submit Success
CheckTransferStatus
Yes
InitiatorTransactionID
I427200605 Note: This ID will be changed when you rerun the process.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Internet Server Transfers 61
|
Table 29 Output of Activities in the UploadFile Process (Cont’d) Variable
Value
Wait for Internet Server Completion JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523210:11 Note: This ID is the same as the JMSCorrelationID variable in the Request Internet Server Transfer activity.
JMSType
Internet-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferStatus
ReturnCode
0
NumRecords
1
Message
Transfer Complete
TransferStatus
SUCCESS
InitiatorTransactionID
I427200605 Note: This ID will be changed when you rerun the process.
Body
The content of the message. See Chapter 2, MFT Palette on page 5 for details about the description for each output of the activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
62
| Chapter 4
Using the Sample Project
Working with Platform Server Transfers This section specifies how to use the plug-in to manage Platform transfers. The PlatformTransfer folder contains the following two processes: •
InitialReceiveRequest Process, page 62
•
OverrideTransferFiles, page 64
InitialReceiveRequest Process The following sections specify the prerequisite and description of the InitialReceiveRequest process, as well as the input and output for each activity. Prerequisite Before you work on the process, ensure that the Platform Server named TIBDemoPS has been created in TIBCO Managed File Transfer Command Center. For how to create a Platform Server, see the TIBCO Managed File Transfer Command Center Help document for details. Description The InitialReceiveRequest process demonstrates that the TIBDemoPS Platform Server receives the SourceFile.txt file from the 192.168.67.25 Responder server to the PSLocalFile.txt. This process uses the Ad Hoc type, you need to modify the definition in the Input tab of the Request Platform Server Transfer activity based on your working environment. Input for Activity Table 30 shows the input for the Request Platform Server Transfer activity and the Wait for PlatformServer Completion activity. Table 30 Input of Activities in the InitialReceiveRequest Process Variable
Value
Request Internet Server Transfer InitiatorFileName
"c:/Demo/PSLocalFile.txt"
ResponderFileName
"c:/Demo/to/SourceFile.txt"
HostName
"192.168.67.25"
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Platform Server Transfers 63
|
Table 30 Input of Activities in the InitialReceiveRequest Process (Cont’d) Variable
Value
HostType
"IPAddress"
SendRecv
"Receive"
Wait for Internet Server Completion JMSCorrelationID
It is the output of the Request Platform Server Transfer. See Chapter 2, MFT Palette on page 5 for details about the description for each input of the activity. Output for Activity Table 31 shows the output for the Request Platform Server Transfer activity and the Wait for Platforms Server Completion activity.
Table 31 Output of Activities in the InitialReceiveRequest Process Variable
Value
Request Internet Server Transfer JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523558:6 Note: This ID will be changed when you rerun the process.
JMSType
Platform-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferImmediate
ReturnCode
0
NumRecords
0
Message
Transaction I428200000 submitted successfully to Server TIBDemoPS: Transfer submitted successfully.
SubmitStatus
Submit Success
CheckTransferStatus
Yes
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
64
| Chapter 4
Using the Sample Project
Table 31 Output of Activities in the InitialReceiveRequest Process (Cont’d) Variable
Value
InitiatorTransactionID
I428200000 Note: This ID will be changed when you rerun the process.
Wait for Internet Server Completion JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523558:6 Note: This ID is the same as the JMSCorrelationID variable in the Request Platform Server Transfer activity.
JMSType
Platform-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferStatus
ReturnCode
0
NumRecords
1
Message
Transfer Complete
TransferStatus
SUCCESS
InitiatorTransactionID
I428200000 Note: This ID will be changed when you rerun the process.
Body
The content of the message. See Chapter 2, MFT Palette on page 5 for details about the description for each output of the activity.
OverrideTransferFiles The following sections specify the prerequisites and description of the OverrideTransferFiles process, as well as the input and output for each activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Platform Server Transfers 65
|
Prerequisites Before you work on the process, ensure that the following tasks have been completed in TIBCO Managed File Transfer Command Center: •
Create a Platform Server named TIBDemoPS.
•
Create a Platform transfer definition on the created TIBDemoPS Platform Server.
For how to create a Platform Server and Platform transfer definiton, see the TIBCO Managed File Transfer Command Center Help document for details. Description The OverrideTransferFiles process demonstrates how to override properties of the pre-defined transfer definition in the plug-in. In this example, the InitiatorFileName and ResponderFileName properties are overriden in the input of the Request Platform Server Transfer activity. You need to update the input based on your working environment. Input for Activity Table 32 shows the input for the Request Platform Server Transfer activity and the Wait for PlatformServer Completion activity. Table 32 Input of Activities in the OverrideTransferFiles Process Variable
Value
Request Internet Server Transfer InitiatorFileName
"c:/tests/Change.txt"
ResponderFileName
"c:/tests/to/Demo-Tib.txt"
Wait for Internet Server Completion JMSCorrelationID
It is the output of the Request Platform Server Transfer. See Chapter 2, MFT Palette on page 5 for details about the description for each input of the activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
66
| Chapter 4
Using the Sample Project
Output for Activity Table 33 shows the output for the Request Platform Server Transfer activity and the Wait for Platforms Server Completion activity. Table 33 Output of Activities in the OverrideTransferFiles Process Variable
Value
Request Internet Server Transfer JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523561:11 Note: This ID will be changed when you rerun the process.
JMSType
Platform-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferImmediate
ReturnCode
0
NumRecords
0
Message
Transaction I428200002 submitted successfully to Server TIBDemoPS: Transfer submitted successfully.
SubmitStatus
Submit Success
CheckTransferStatus
Yes
InitiatorTransactionID
I428200002 Note: This ID will be changed when you rerun the process.
Wait for Internet Server Completion JMSCorrelationID
ID:EMS-SERVER.21684F6AD4523561:11 Note: This ID is the same as the JMSCorrelationID variable in the Request Platform Server Transfer activity.
JMSType
Platform-Response
JMSDestination
Queue[TransferQueueName]
ResponseType
TransferStatus
ReturnCode
0
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Working with Platform Server Transfers 67
|
Table 33 Output of Activities in the OverrideTransferFiles Process (Cont’d) Variable
Value
NumRecords
1
Message
Transfer Complete
TransferStatus
SUCCESS
InitiatorTransactionID
I428200002 Note: This ID will be changed when you rerun the process.
Body
The content of the message. See Chapter 2, MFT Palette on page 5 for details about the description for each output of the activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
68
| Chapter 4
Using the Sample Project
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
| 69 Appendix A
Miscellaneous
This appendix describes miscellaneous topics, such as the Secure Sockets Layer (SSL) protocol and the log status settings, inTIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer.
Topics •
Configuring SSL, page 70
•
Setting Log Status, page 73
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
70
| Appendix A
Miscellaneous
Configuring SSL This section specifies how to enable SSL when you use TIBCO Enterprise Message Service, Apache Active MQ, or IBM WebSphere MQ as the JMS provider.
Configuring SSL on TIBCO Enterprise Message Service Server If you want to use SSL, you must configure the tibemsd.conf file on the TIBCO Enterprise Service server. An example of the tibemsd.conf file is located in the EMS_DATA_HOME/cfmgmt/ems/data directory. To configure the tibemsd.conf file, complete the following steps: •
Set the listen parameter to specify which port accepts SSL connections. For example: listen = ssl://7343 This port number must be consistent with the SSL Connection Factory URL set in the factories.conf configuration file.
•
Set the ssl_server_identity, ssl_server_key, and ssl_password parameters to specify the digital certificate of the server, private key and the password for the private key. For example: ssl_server_identity = D:\tibco\ems\6.0\samples\certs\server.cert.pem ssl_server_key = D:\tibco\ems\6.0\samples\certs\server.key.pem ssl_password = password
Leave other parameters as defaults, then restart the EMS service after you configure the previous parameters.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Configuring SSL 71
|
See TIBCO Enterprise Message Service User’s Guide for details about how to configure SSL in a TIBCO Enterprise Message Service server. If the SSL listerner port is modified in the tibemsd.conf file, you must configure the factories.conf file to keep them consistent. For example: [SSLQueueConnectionFactory] type = queue url = ssl://7343 ssl_verify_host = disabled [SSLTopicConnectionFactory] type = topic url = ssl://7343 ssl_verify_host = disabled
Configuring SSL on a TIBCO Enterprise Message Service Client To use an SSL connection, after configuring a TIBCO Enterprise Message Service server, you must complete the following steps to configure a TIBCO Enterprise Message Service client: 1. Start TIBCO Designer. 2. Open a project you have created. See Chapter 3, Getting Started on page 41 for details about how to create a new project.
3. Add the certificates to a folder, and import this folder to the TIBCO BusinessWorks project. For example: the server_root.cert and server.cert certificates which are configured in the in the Configuring SSL on TIBCO Enterprise Message Service Server section.
tibemsd.conf file
4. Select a MFT Shared Connection shared resource you have created. 5. Check the Use SSL checkbox in the Configuration tab to enable SSL. 6. Specify the location of the certificates created in step 3 in the Trusted Certs Location field. 7. Enter the SSL listen port in the JNDI Context URL field. For example: ssl://192.168.67.26:7343.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
72
| Appendix A
Miscellaneous
8. Enter the Queue connection factory set in the factories.conf file in the Queue Connection Factory field. For example: SSLQueueConnectionFactory 9. Enter the Queue connection factory set in the factories.conf file in the Topic Connection Factory field. For example: SSLTopicConnectionFactory 10. Save the project, then click the Test Connection button to test the connection.
Configuring SSL on a Apache Active MQ or IBM WebSphere MQ Server When configuring a project in TIBCO Designer, you need to add the property to the designer.tra file in the TIBCO_HOME\designer\version\bin directory to use SSL.
java.property.TIBCO_SECURITY_VENDOR=j2se
When deploying a project in TIBCO Administrator, you need to add the property to the bwengine.xml file located in the TIBCO_HOME\bw\version\lib\com\tibco\deployment directory to use SSL. Or, you can add this property to the .tra file for a deployed application. java.property.TIBCO_SECURITY_VENDOR=j2se
See the JMS provider’s documentation for details about SSL configuration.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
Setting Log Status 73
|
Setting Log Status This section specifies how to set the log status when configuring a project in TIBCO Designer, or deploying a project in TIBCO Administrator. Configuring in TIBCO Designer When you configure a project in TIBCO designer, write the following lines of code in your configuration file (.cfg file) to set the log status. You may change the value in the file. Trace.Info.*=true Trace.Error.*=true Trace.Warn.*=true com.tibco.plugin.mft.debug=false
Deploying in TIBCO Administrator Trace.Info.*, Trace.Error.*,
and Trace.Warn.* are three general properties in TIBCO BusinessWorks. They are not added in the default bwengine.xml configuration file located in the TIBCO_HOME\bw\version\lib\com\tibco\deployment directory. If you want to set the log status when deploying a project in TIBCO Administrator, add these properties manually in the bwengine.xml file. See the TIBCO BusinessWorks Administration documentation for details. Table 34 shows the description for each log parameter. Table 34 Log Parameters Property
Component
Description
Trace.Info.*
TIBCO BusinessWorks
Whether the general information is shown (true) or not (false) while running the application. The default is true.
Trace.Error.*
TIBCO BusinessWorks
Whether the error message is shown (true) or not (false) while running the application. The default is true.
Trace.Warn.*
TIBCO BusinessWorks
Whether the warning message is shown (true) or not (false) while running the application. The default is true.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
74
| Appendix A
Miscellaneous
Table 34 Log Parameters (Cont’d) Property
Component
Description
com.tibco.plugin.mft.debug
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer
Whether the debug information is shown (true) or not (false) during running the application. The default is false.
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
| 75
Index
A
M
Ad Hoc type 11
Management Queue 9 MFT palette 5
C P Command Center 2 customer support xv
Platform Server 2
D
Q
Defined type 11 definition type Ad Hoc type 12 Defined type 12
Queue Connection Factory 8
R return codes 17
I Internet Server 2
S J JNDI Context Factory 7 JNDI Context URL 8
Secure Sockets Layer 70 shared resource 7 SSL 70 support, contacting xv
T L log status settings 73
technical support xv TIBCO ActiveMatrix BusinessWorks 42 TIBCO Designer 42 TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide
76
| Index TIBCO Managed File Transfer 2 TIBCO Managed File Transfer Command Center 2 TIBCO Managed File Transfer Internet Server 2 TIBCO Managed File Transfer Platform Server 2 TIBCO_HOME xiii Topic Connection Factory 8
TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Managed File Transfer User’s Guide