Retrieve Audit Records

The Retrieve Audit Records activity sends an audit request to TIBCO Managed File Transfer Command Center through a JMS queue, and receives an audit response that contains detailed information about a completed file transfer.

Use this activity to search for the audit report of the platform or Internet server transfers. 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.

General

The General tab of the Retrieve Audit Records activity contains the following fields:

Field Module Property? 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.

Activity Timeout (second) No Specify how long (in seconds) the application waits before reconnecting to the JMS server when an error occurs.

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

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 Retrieve Audit Records activity.

Input

The input of the Retrieve Audit Records activity is shown in the following figure. For information about the meaning of each input element, see the TIBCO Managed File Transfer Command Center documentation.

The value of the AuditType input element is required, for example: PlatformServer.

The values of the FromDate, ToDate, and NumDays input elements are optional:
  • If you do not set any values for the three input elements, only the audits for the current day are returned.
  • If you set values for the FromDate and ToDate input elements, the value of the NumDays input element is ignored.
  • If you only set a value for the NumDays input element, audits in NumDays input element are returned, starting from the current day. For example, if you set the value of the NumDays input element to 2, audits from the current and the previous day are returned.

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

Output

The following is the output of the Retrieve Audit Records activity:

Output Item Data Type Description
Properties 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.
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 status message or an error message.
Body ResponseType String The response type.
ServerName String The platform or Internet server that executes the current transfer.
HostName String The host that the transferred files are 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 documentation for information about the definition of each property of the audit record.

Fault

The Fault tab lists exceptions that are thrown by the Retrieve Audit Records 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 request an Audit response.
MFTReceiveException The plug-in fails to receive an Audit response.
MFTValidationException A request message does not match the predefined request schema.