Request Platform Server Transfer
The Request Platform Server Transfer activity sends a platform server transfer request to a queue in the JMS server, and then TIBCO Managed File Transfer Command Center retrieves the request message from the queue.
General
The General tab of the Request Platform 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
For details about how to create an MFT Shared Connection shared resource, see Creating MFT Shared Connection. |
Definition Type | Yes | The type of file transfer definition used to submit a platform server transfer request.
Select a type of file transfer definition from the list: |
Platform Server Name | No | The platform server where a file transfer request is initiated.
Click Get Server to select a server in the Pick Server 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 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 the search criteria to retrieve the transfer definition. SQL wildcards are accepted, for example, % wildcard represents one or more characters. |
Definition ID | No |
The ID of the file transfer definition. Click Get Transfer Definition to select the file transfer definition in the Pick Transfer Definition dialog.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 retrieve the definition again. If you provide values in the Platform Server Name field, Definition Desc field, or both, these values are used as the search criteria to retrieve the transfer definition. The value in the Definition ID field cannot be used as the search criteria to retrieve the transfer definition. |
Initiator User | Yes | The user ID used to log on to a platform server. |
Initiator Password | Yes | The password used to log on to a platform server. |
Responder User | Yes | The user ID that an initiator sends to a responder to access the responder system. |
Responder Password | Yes | The password that an initiator sends to a responder to access the responder system. |
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.
|
CC Check Interval (second) | No | Specify how long (in seconds) TIBCO Managed File Transfer Command Center waits between checks to see if the platform server transfer is completed.
The valid range is 1 to 60. The default value is 5 seconds. |
CC Check Timeout (second) | No | Specify how long (in seconds) TIBCO Managed File Transfer Command Center waits before timing out a request.
The valid range is 1 to 86400. The default value is 3600. |
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. |
Definition
The Definition tab of the Request Platform Server Transfer activity displays the properties of a predefined transfer definition (Defined Type) retrieved from TIBCO Managed File Transfer Command Center. You can select the transfer definition type from the Definition Type list in the General tab.
To override the values of the properties, select the check boxes in the Override column, click Apply, and then provide new values in the Input tab. To reset your configurations, click Reset.

For information about the meaning of each property, see the TIBCO Managed File Transfer Command Center documentation.
Input
The input of the Request Platform Server Transfer activity is different depending on the definition type you select to submit a platform server transfer request. You can select the transfer definition type from the Definition Type list in the General tab.
-
Ad Hoc
If you select this option, define your own file transfer definition in the Input tab.
For information about the meaning of each input element, see the TIBCO Managed File Transfer Command Center documentation.
- Defined Type
If you select this option and you do not override any transfer properties in the Definition tab , the activity requires only the basic input:
Input Item Data Type Description required TransferInfo
UserID String The user name used to log on to TIBCO Managed File Transfer Command Center. Password String The password used to log on to TIBCO Managed File Transfer Command Center. credentials Properties
Initiator Password
String The password used to log on to a platform server. Responder Password
String The password that an initiator sends to a responder to access the system. If you override any value of the definition properties, besides the basic input, you must provide a new value for each of the properties selected in the Definition tab.
For information about mapping and transforming input data, see TIBCO ActiveMatrix BusinessWorks Application Development.
Output
The following is the output of the Request Platform Server Transfer activity:
Output Item | Data Type | Description |
---|---|---|
JMSCorrelationID | String | The message ID of an original request message.
The value is the same as the value of the JMSCorrelationID input element. |
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 received. |
ResponseType | String | The response type. The value is always TransferStatus. |
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 Platform 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. |