Initiating Platform Transfers Using JMS

MFT can initiate Platform transfers using JMS.

By placing an XML file in the proper queue with the proper JMS type, TIBCO MFT Command Center performs the following operations:
  • Read and parse the XML data.
  • Initiate a transfer to the Platform Server defined in the XML file.
  • Wait for a response and if defined to, write a completion message to the JMS queue.

The following example demonstrates how to send a Platform Server transfer request to a JMS queue.

Prerequisites

Ensure that you have completed the following tasks:

  • The JMS service in TIBCO MFT Command Center is configured and started.
  • A JMS queue named MFT.Transfer is created in JMS and defined in TIBCO MFT Command Center JMS service configuration along with Platform Server transfers request type Platform-Request.
To initiate Platform transfers using JMS, you have to perform the following operations:
  1. Adding a JMS Server
  2. Adding a Transfer Definition
  3. Configuring the TransferRequest.xml File
  4. Sending the TransferRequestPlatformServer.xml File to the JMS Queue

Adding a JMS Server

Click Servers > Add Server to open the Add Server page, and configure the following parameters in the Required Server Information section:
Field Description
Server Name Defines the name for the server that you add.
IP Address or fully qualified IP Name Defines the IP address or IP name for the server you add.
Note: This parameter is required for adding a server but is ignored for JMS because the JMS connectivity information is defined by TIBCO MFT Command Center.
Server Type Defines the type of the server that TIBCO MFT Command Center will be communicating with.

Select JMS.

OverrideJMSServiceConfiguration

Defines whether to override the URL defined in the Configure JMS Server parameter.

When the value is Yes, the URL defined in the IPAddress or fully qualified IP Name parameter overrides the URL defined in the Configure JMS Server parameter. When the value is No, the URL defined in the Configure JMS Server parameter is used, and the URL defined in the IP Address or fully qualified IP Name parameter is ignored.

Adding a Transfer Definition

Click Transfers > Add Transfer to open the Add Transfer page, and configure the following parameters in the Required Transfer Information section:
Field Description
Client File Name Defines the name for the client file.
Server File Name Defines the name for the queue that you want to write.

In this example, enter MFT.Transfer.

Directory Transfer Defines whether the transfer is a directory transfer.

Select No.

Description Defines a short description for the transfer that you add.
Authorized User Id Defines the ID of the authorized user.
Choose the user ID from the drop-down list that will be used to make this file transfer.
Note: You must have TransferRight assigned to your account.
Authorized Group Id Defines the TIBCO MFT Command Center group ID that is permitted to use this transfer request being defined.
Server Name Defines the name for the server.
Transfer direction Defines the direction of the transfer: Upload to Server or Download to Client transfer.

Select Upload to Server.

Client Protocols Allowed Defines whether all client protocols are supported.

Select ALL.

Department Defines the department to which this transfer is assigned.

If you have one, set it here; if not , leave it blank.

Virtual Alias Defines the alias that the client uses for transfers.

For this example, JMSPlatform is used.

Configure the following parameters in the Additional Transfer Properties section:
Field Description
Data Type Defines the data type as Text or Binary.

Select Text.

Delimiter Defines whether records are delimited by LF, CRLF, or have no delimiters.

Select No.

Configure the following parameters in the JMS Properties section:
Field Description
Input Selector Defines the selector that is used to filter JMS messages when reading data from a JMS queue .
Note: This parameter is ignored when writing data to a JMS queue.
Output JMSType Property Defines the JMSType output property that is set when writing data to a JMS queue.

This value must match the request type, which you defined in Management > Manage Services > JMS Service > Configure JMS Service > Platform Server Transfers > Transfer Request Properties. In this example Platform-Request is used.

Output Property Defines the output property that is set when writing data to a JMS queue.

This parameter can be left blank.

Max Message Size Defines a maximum message size.

Valid values for this parameter are from 1K - 999K and 1M - 10M. The default value is 1M.

When a message exceeds this size, it will be broken up into multiple messages.

Write EOF Message

Defines whether MFT will write an empty JMS message at End Of File. This message will indicate that the entire file has been written and will not contain any message data. Supported values are:

Yes - Write an empty message indicating end of file. JMS header property "LastMessage" will be "true" for the empty message and "false" for messages that contain data.

No - Do not write an empty message indicating end of file

Click Add after you finish the configurations.

Configuring the TransferRequest.xml File

Define the required parameters in TransferRequestPlatformServer.xml file which is located in the <MFTCC_Install>/server/webapps/<context>/example/JMS directory.

Sending the TransferRequestPlatformServer.xml File to the JMS Queue

Go to the transfer client from which the TransferRequestPlatformServer.xml file will be sent.

The following example assumes a JMS queue named MFT.Transfer is defined as the queue name in the Transfer Request Properties section on the Configure JMS Service page which can be accessed by clicking Management > Manage Services > JMS Service > Configure JMS Service. In this example, TIBCO MFT Platform Server for Windows is the transfer client; however, any client can be used. 

FTMSCMD /S /F /DS:10.1.1.1 /PORT:46464 /RI=JMSuser /RW=pwd c:\mftxml\
TransferPlatformServerRequest.xml JMSPlatform/MFT.Transfer