Request Internet Server Transfer

The Request Internet Server Transfer activity sends an Internet server request to a queue, and then TIBCO Managed File Transfer Command Center retrieves the request message from the queue.

Once TIBCO Managed File Transfer Command Center receives the request, the activity immediately gets a response.

General

The General tab of the Request Internet Server Transfer activity contains the following fields:

Field Module Properties? Description
Name No The name to be displayed as the label for the activity in a process.
MFT Connection Yes The MFT Shared Connection shared resource used to build connection between the plug-in and the JMS server.

Click to select an MFT Shared Connection shared resource. If no matching MFT Shared Connection shared resources are available, click Create Shared Resource to create one.

For details about how to create an MFT Shared Connection shared resource, see Creating MFT Shared Connection.

Internet Server Name No The Internet server where a file transfer request is initiated.

Click Get Server to select a server in the Pick Server Name dialog. Or type a server name or part of the server name in SQL format as the search criteria. SQL wildcards are accepted, for example, % wildcard represents one or more characters.

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 must refine your search criteria to retrieve the server again. The value in this field can be used as the search criteria to retrieve the transfer definition.

If you do not provide any criteria in this field, the plug-in retrieves all of the defined servers.

Definition Desc Yes The description of the definition.

You can use this description as search criteria to retrieve the transfer definition in the Definition Alias Name field. SQL wildcards are accepted, for example, % wildcard represents one or more characters.

Definition Alias Name No A unique transfer definition.

Click Get Alias Name to select an alias from the Pick Alias Name dialog. Or enter 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.

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 must refine your search criteria to get the definition alias. The value in the Definition Desc field can be used as the search criteria to retrieve the definition.

If you do not provide any criteria in this field, the plug-in retrieves all of the definition aliases.

Check Transfer Status Yes Select or clear the check box to specify whether or not you want to retrieve the transfer status from TIBCO Managed File Transfer Command Center.
If you select this check box, TIBCO Managed File Transfer Command Center sends back a detailed transfer status message. Otherwise, no status message is sent back. This check box is selected by default.
Note: Use the Wait for Internet Server Completion activity to receive the transfer status message.
Activity Timeout (second) No Specify how long (in seconds) the plug-in waits for a submission response from TIBCO Managed File Transfer Command Center.

The valid range is 1 to 3600. The default value is 30.

If no message is returned before timing out, a timeout exception occurs.

Refresh Management Yes Select or clear the check box to specify whether or not you want to refresh the configuration and management related information defined in TIBCO Managed File Transfer Command Center.

If you select this check box, the plug-in requests the management messages for the activity. Otherwise, the plug-in uses the cached management information.

Description

A short description for the Request Internet Server Transfer activity.

Input

The following is the input of the Request Internet Server Transfer activity:

Input Item Data Type Description
UserID String Optional.
The user name used to log on to TIBCO Managed File Transfer Command Center.
Note: This value overwrites the one set in the MFT Shared Connection Configuration panel of the MFT Shared Connection editor.
Password String Optional.

The password used to log on to TIBCO Managed File Transfer Command Center.

Note: This value overwrites the one set in the MFT Shared Connection Configuration panel of the MFT Shared Connection editor.
ServerName String Optional.
The Internet server where a file transfer request is initiated.
Note: This value overwrites the one set in the General tab.
JMSOrFile String Required.

The Internet transfer request type to be used, queue or file.

Enter Queue for the queue type, and File for the file type.

JMSNameOrFilePath String Required.

The name of a queue when the queue type is used, or a fully qualified file name when the file type is used.

MessageSelector String Optional.

If you enter queue for the transfer request type and upload for the transfer direction, specify the message selector used to filter messages read from the JMS queue.

For example: PropertyName='SelectorValue'

RemoteFileName String Optional.

The name of the file to be uploaded to or downloaded from a remote server.

UploadDownload String Required.
The transfer direction. Valid value is Upload or Download:
  • Upload: Read a message from a queue or a file, and write it to a remote server.
  • Download: Read a file from a remote server, and write a message to a queue or a file.
Property String Optional.

If you enter queue for the transfer request type and download for the transfer direction, specify the property in the created message.

For example: PropertyName='propertyValue'

TextBinary String Optional.
If you enter queue for the transfer request type and upload for the transfer direction, define the format of data written to the JMS queue. Valid value is Text or Binary:
  • Text: JMS Text Data.
  • Binary: JMS Binary Stream.
MessageDelimiter String Optional.

If you enter queue for the transfer request type, specify whether the file transfer converts Carriage Return (CR), Line Feed (LF), or both. There are three available values:

  • CRLF: Indicates that CR, LF, or both can be used.
  • LF: Indicates that only LF can be used.
  • None: Indicates that 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 String Optional.
If you enter queue for the transfer request type, 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 the maximum size, it splits into multiple messages.

For information about mapping and transforming input data, see TIBCO ActiveMatrix BusinessWorks Application Development.

Output

The following is the output of the Request Internet Server Transfer activity:

Output Item Data Type Description
JMSCorrelationID String The message ID of an original request message.

This ID is used to link a response message with its related request message.

JMSType String The message type used to distinguish between the messages stored in the same JMS queue.
JMSDestination String The destination where a message is sent.
ResponseType String The response type. The value is always TransferImmediate.
ReturnCode String The numeric code returned by TIBCO Managed File Transfer Command Center.

A value of 0 indicates that the command was executed successfully. A non-zero value usually indicates termination of the command due to an error. See Return Codes for more details.

NumRecords Integer The number of audit records in the body of message. The value is always 1.
Message String A detailed transfer submission message or an error message.
SubmitStatus String The transfer status, for example, Submit Success.
CheckTransferStatus String A value of No indicates that the transfer status is not retrieved.
InitiatorTransactionID String The unique ID indicating that a request was submitted successfully.

Fault

The Fault tab lists exceptions that are thrown by the Request Internet Server Transfer activity:

Exception Thrown when...
MFTConnectionException The plug-in fails to connect to the JMS server or TIBCO Managed File Transfer Command Center.
MFTSendException The plug-in fails to send a file transfer request.
MFTReceiveException The plug-in fails to receive a submission response.
MFTValidationException A request message does not match the predefined request schema.