Output produced by the LogTransfer function

Transfer log events capture the details of transfer progress from the time transfer is submitted until it is completed. Information about transfer going into resynchronization is also captured to help you understand the progress of a transfer.

Transfer event format

Transfer events are in JSON format and written to the transferlogN.json file, which is created in the log directory of the agent, where N is a number with 0 being the default. Every event includes the following common attributes:
  • Date and time (in UTC)
  • Unique ID

There are additional attributes included in the event information written, depending on the type of the event and the level of transfer log. While the transfer log level info writes minimal information, the verbose level includes a more detailed information. The following Sample events section describes a few examples of transfer events logged by an agent.

Unique ID

The unique id is included to help you easily identify the different phases as a transfer progresses, for example, BFGTL0001. The unique ID is part of the eventDescription attribute and is made up of two parts:
BFGTL
The prefix used for all identifiers, where BFG is the standard suffix used in Managed File Transfer and TL indicates this is a transfer log.
Number
A unique number starting from 1. For example:
{
  "eventDescription": "BFGTL0001: New transfer request submitted"
}

Sample events

The following table describes some of the events as examples of the information logged by the additional function. The second column of the table Log Level indicates the level at which the event is logged.

Important: The following attributes are included in the event information if the logTransfer level is set to verbose or moderate:
  • sourceAgent
  • destinationAgent
  • threadId
Event Log level Description
List of items to transfer verbose 
{
  "dateTime": "<Data time in UTC>",
  "eventDescription": "BFGTL0002I: Generated detailed transfer item list.",
  "destinationAgent": "<Name of destination agent>",
  "sourceAgent": "<Name of source agent>",
  "threadId": "0000001d",
  "totalItemsInTransfer": <Number of items in the transfer>,
  "transferId": "<Transfer Identifier>",
  "transferItemsList": [{"source":"source item name",
                         "destination": "destination item name"}]
}

Example:
{
  "dateTime": "2022-01-14T12:56:54.219Z UTC",
  "eventDescription": "BFGTL0002I: Generated detailed transfer item list.",
  "destinationAgent": "QMBAGQ",
  "sourceAgent": "QMBAG1",
  "threadId": "0000001d",
  "totalItems": 1,
  "transferId": "414d5120514d4120202020202020202063bd17610a390040",
  "transferItems": [{
      "destination": "/results/rts/target/destFile.txt",
      "source": "DESTINATIONQ@QMB"
  }]
}
Audit information of transfer logged by source agent info, moderate, verbose 
{
  "dateTime": "<Date and time in UTC>",
  "transferId": "<Transfer Id>",
  "eventDescription": "BFGTL0008: Transfer progress information ",
  "progressInformation": [{
     "destination": "<Destination item name>",
     "resultCode": "<Result of transfer>",
     "supplement": "<Any supplemental information.>"
     "source": "<Source item name>"
  }],
  "sourceAgent": "<Source agent name>",
  "destinationAgent": "<Destination agent name>",
  "threadId": "Thread Id",
}

Example:
{
  "dateTime": "2022-01-14T14:17:20.075Z UTC",
  "transferId": "414D5120514D412020202020202020202FD01761013B0040",
  "eventDescription": "BFGTL0008: Transfer progress information",
  "progressInformation": [{
     "source": "MONITORQ@QMA"
     "destination": "/results/rts/target/destinationFile.txt",
     "resultCode": "Successful",
     "supplement": ""
  }],
  "sourceAgent": "QMAAG1",
  "destinationAgent": "QMBAG1",
  "threadId": "00000023",
}
Following is an example of the information logged if the level is info:
{
  "dateTime":"2022-01-16T03:28:26.234Z UTC",
"transferId":"414D51204D4654514D20202020202020EB89416101760040",
"eventDescription":"BFGTL0008I: Transfer progress information",
  "progressInformation": {
    "warnings":0,
    "failed":1,
    "successful":0,
    "unknown":0}
}
Following is an example of the information logged if the level is moderate:
{ 
"dateTime":"2022-01-16T03:30:46.766Z UTC",
"transferId":"414D51204D4654514D20202020202020EB89416101850040",
"eventDescription":"BFGTL0008I: Transfer progress information",
"progressInformation": [{
"source":"FileZilla:/home/mft/*",
"destination":"C:/MFT/FileZilla:/home/mft/*",
"itemSize":0,
"resultCode":"Failed",
"supplement":"BFGIO0110E: File \"/home/mft/*\" does not exist."}],
"sourceAgent":"IMQFT01"
"destinationAgent":"SRC",
}
Error occurred when opening an item info 
{
  "dateTime": "<Date and time in UTC>",
  "transferId": "<Transfer Id>",
  "eventDescription": "BFGTL0054E: Failed to open an item to transfer data.",
  "itemName": "Name of file or queue",
  "error":"<Error description>"
  "sourceAgent": "<Source agent name>",
  "destinationAgent": "<Destination agent name>",
  "threadId": "<Thread Id>",
}

Example:
{
  "dateTime": "2022-01-14T14:42:24.902Z UTC",
  "transferId": "414D512043514D485830312020202020B0D4176101370040",
  "eventDescription": " BFGTL0054E: Failed to open an item to transfer data.",
  "itemName":"/inbound/resource.xml",
  "error": "File not found"
  "sourceAgent": "CQMHX01AG1",
  "destinationAgent": "HX01AG1",
  "threadId": "0000001c"
List of transfers to be recovered at the start of the agent verbose 
{
  "dateTime": "<Date and time in UTC>",
  "eventDescription": "The list of transfers being recovered as part of agent recovery process.",
  "agentName": "<Agent name>",
  "transfers": [{"transferId":"<transfer state>"}]
  "threadId": "<Thread Id>",
}

Example:
{
  "dateTime": "2022-01-14T14:42:24.902Z UTC",
  "eventDescription": "The list of transfers being recovered as part of agent recovery process.",
  "agentName": "CQMHX01AG1",
  "transfers": [ {"414D512043514D485830312020202020B0D4176101370040":"completeReceived"},
{"414D512043514D485830312020202020B0D4176101370050":"resynchronizing"}]
  "threadId": "0000001c",
}