TIBCO MFT BusinessWorks MFT Palette

Transcription

1 TIBCO MFT BusinessWorks MFT Palette This is a TIBCO document from Proginet Sales & Presales Group. Consulting Services This document provides a general overview of using the MFT palette. It assumes that readers have basic knowledge of MFT Command Center, Internet Server, Platform Server, and BusinessWorks. This document can be used to establish company specific standards, or simply used as a reference. Document Version: 01 Document Date: 02, Global Headquarters 3303 Hillview Avenue Palo Alto, CA Tel: Toll Free: Fax: Copyright 2008, TIBCO Software Inc. All rights reserved. TIBCO, the TIBCO logo, The Power of Now, and TIBCO Software are trademarks or registered trademarks of TIBCO Software Inc. in the United States and/or 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. 0204

2 Copyright Notice COPYRIGHT 2013 TIBCO Software Inc. This document is unpublished and the foregoing notice is affixed to protect TIBCO Software Inc. in the event of inadvertent publication. All rights reserved. No part of this document may be reproduced in any form, including photocopying or transmission electronically to any computer, without prior written consent of TIBCO Software Inc. The information contained in this document is confidential and proprietary to TIBCO Software Inc. and may not be used or disclosed except as expressly authorized in writing by TIBCO Software Inc. Copyright protection includes material generated from our software programs displayed on the screen, such as icons, screen displays, and the like. Trademarks All brand and product names are trademarks or registered trademarks of their respective holders and are hereby acknowledged. Technologies described herein are either covered by existing patents or patent applications are in progress. Confidentiality The information in this document is subject to change without notice. This document contains information that is confidential and proprietary to TIBCO Software Inc. and its affiliates and may not be copied, published, or disclosed to others, or used for any purposes other than review, without written authorization of an officer of TIBCO Software Inc. Submission of this document does not represent a commitment to implement any portion of this specification in the products of the submitters. Content Warranty The information in this document is subject to change without notice. THIS DOCUMENT IS PROVIDED "AS IS" AND TIBCO MAKES NO WARRANTY, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO ALL WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. TIBCO Software Inc. shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance or use of this material. Export This document and related technical data, are subject to U.S. export control laws, including without limitation the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations of other countries. You agree not to export or re-export this document in any form in violation of the applicable export or import laws of the United States or any foreign jurisdiction. For more information, please contact: TIBCO Software Inc Hillview Avenue Palo Alto, CA USA 2

3 Table of Contents 1 Introduction Overview Version Applicability Using the BusinessWorks MFT Palette Get Connected with the MFT Connection Starting a MFT Transfer in BusinessWorks Using Request Internet Server Transfer Example Using Request Platform Server Transfer Using Wait for Internet Server Completion and Wait for Platform Server Completion 13 3

4 1 Introduction 1.1 Overview The TIBCO MFT BusinessWorks MFT palette document provides an overview of using the palette objects. document is intended as a supplement to existing documentation. The 1.2 Version Applicability Unless otherwise noted in this document, its content is compatible with and updated for the following TIBCO products: TIBCO MFT Command Center release 7.2 or later TIBCO MFT Internet Server release 7.2 or later TIBCO MFT Platform Server release 7.0 or later 4

5 2 Using the BusinessWorks MFT Palette The MFT Palette contains the following objects: Resource used to connect to MFT queues and topics. The Listen for Alert Message activity starts a process when an alert is triggered in TIBCO Managed File Transfer Command Center. 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. 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. 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 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. 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. 5

6 2.1 Get Connected with the MFT Connection The MFT palette objects require use of the MFT Connection object to connect to the queues and topics used by MFT. In general, only one MFT Connection will be defined; however, there may be situations to define multiple connections for purposes of connecting to different environments (DEV, QA, UAT, PROD) or to use a different MFT user ID to perform the transfer (e.g. users in different departments). 2.2 Starting a MFT Transfer in BusinessWorks There are many starter processes in BW which can be used to invoke an MFT process. The Listen for Alert Message starter process is a specialized starter process that only responds to JMS messages that are placed in the alert topic as defined in the MFT Command Center s JMS configuration. The creation of JMS messages to the alert topic is managed through the MFT Command Center. Alert JMS messages are created when a file transfer event occurs and defined criteria are met (Figure 1). 6

7 Figure 1. Alert Trigger Criteria configuration in MFT Command Center. The Alert action allows further definable parameters such as the JMS Type (Figure 2). This field can be used as a message selector in the Listen for Alert Message object (Figure 3). 7

8 Figure 2. JMS Alert Action configuration in MFT Command Center. Figure 3. Configuration menu of Listen for Alert Message palette object in BusinessWorks designer. The Alert message from Command Center carries a payload that contains data about the file transfer event including details in the audit record (Figure 4). Figure 4. Sample output details from MFT Command Center JMS alert. 8

9 2.3 Using Request Internet Server Transfer The Request Internet Server Transfer object supports multiple modes of file transfer: JMS Queue to JMS Queue JMS Queue to File File to JMS Queue File to File The file transfer event will be initiated from the Internet Server that is defined in the Internet Server Name field as shown in Figure 5. An important detail to remember is that one side of the file transfer will use either *LOCAL of the Internet Server or the MFT Connection for JMS queues. The other half of the transfer will involve interaction with a remote server defined by the Definition Alias Name. Figure 5. Configuration menu Request Internet Server Transfer palette object in BusinessWorks designer. If the virtual alias is a Directory type, then the RemoteFileName is a required parameter (Figure 6). Note, the virtual alias does not need to be re-entered since it is assumed from the Configuration tab. Figure 6. Input tab of Request Internet Server Transfer palette object in BusinessWorks designer. 9

10 2.3.1 Example In this example, a message from a JMS queue (via MFT Shared Connection) is sent to another JMS server and queue. The steps show the initial configuration of server pieces and transfer definition on the Command Center. 1. Define Internet Server in Command Center to perform action Servers >> Add Server 2. Define remote JMS Server in Command Center Servers >> Add Server 3. Define Transfer Definition in Command Center to remote JMS Server Transfers >> Add Transfer Note: The authorized user ID is the same user ID specified in the MFT Shared Connection. 10

11 4. Configure Request Internet Server Transfer Process 2.4 Using Request Platform Server Transfer The Request Platform Server Transfer object is used to submit a transfer request to a Platform Server. The object is nearly identical in operation to submitting a Platform Server request through the Command Center interface with a few exceptions. A Platform Transfer definition may be retrieved from the Command Center when using the Defined Type, or Platform Transfers may be manually defined using an Ad Hoc definition type. The palette interface Get buttons, Get Server and Get Transfer Definition, will filter results to display only valid options (Figure 7). 11

12 Figure 7. Configuration tab of Request Platform Server Transfer palette object in BusinessWorks designer. Defined Type Platform Transfers should be used when all transfer configuration and coordination is managed through the MFT Command Center. Defined Type is most applicable in situations that a static named file is moved on a recurring basis. When Defined Type is selected, the Definition tab is enabled and editable (Figure 8). Figure 8. Definition tab of Request Platform Server Transfer palette object in BusinessWorks designer. Ad Hoc Platform Transfers allow the designer to define all the transfer properties. Ad Hoc is most applicable in situations in which file transfer details are not know in advance, but logic has been designed around the process to pass in the parameters to complete the transfer definition. 12

13 2.5 Using Wait for Internet Server Completion and Wait for Platform Server Completion The complementary palette objects to Request Internet Server Transfer and Request Platform Server Transfer are respectively Wait for Internet Server Completion and Wait for Platform Server Completion. These objects are used because the request objects submit the job to the Command Center but do not provide the file transfer result. To use the wait objects, the JMSCorrelationID output of the request is tied to the JMSCorrelationID input of the wait object (Figure 9). Figure 9. Input tab of Wait for Internet Server Completion palette object in BusinessWorks designer. 13