File Transfer Event

File transfer events include the following event types:

  • File transfer start & end events (TransferStart and TransferEnd)
  • File transfer step start & end events (TransferStepStart and TransferStepEnd)
  • File transfer status event (TransferStatus)

File transfers can be reported independently or as steps within a process. When reported as part of a process, transfers should be reported as shown in the following example:

  • ProcStart
    • TransferStepStart
    • TransferStatus (optional)
    • TransferStepEnd
  • ProcEnd

When reported independently, transfers should be reported as shown in the following example:

  • TransferStart
    • TransferStepStart
    • TransferStatus (optional)
    • TransferStepEnd
  • ​TransferEnd

In addition to the fields defined for all process events, file transfer events define the following fields:

Name Description Data type Required
bytesTransferred The number of bytes transferred (so far) for this file transfer. Number No
direction

The direction of the file transfer (relative to the server reporting the event):

  • inbound
  • outbound
 String No
fileSize The total number of bytes of the file if known (independent of the number of bytes transferred). Number No
localFileName The local file name (relative to the server reporting the event). String No
localPath The local file path (relative to the server reporting the event). String No
remoteFileName The remote file name (relative to the server that the file is being received from or transferred to). String No
remotePath The remote file path (relative to the server that the file is being received from or transferred to). String No
remoteServer The name or ID of the server that the file is being transferred to or received from. When possible, this value should be a standardized node ID. String No

Details about the file transfer can be reported all at once or in a series of transfer status events, as the information becomes available.

File Transfer Start Event

A file transfer start event indicates that a file transfer has started and can trigger Service Level Criteria (SLC) rules. Additional details about the transfer can be specified in the event before it is posted, in subsequent file transfer status events, or in the ultimate file transfer end event. You must post a subsequent file transfer end event after the transfer completes (whether it completes successfully or not). No additional fields are defined for file transfer start events.
Example:
  
    "direction":"inbound",
    "event":"TransferStart",
    "localFileName":"file-1455559672258.txt",
    "msgId":"EVTEX0008D",
    "msgText":"start",
    "nodeId":"cron/cron123",
    "occurred":"2016-02-15T18:07:52.971+0000",
    "processId":"1d8b8f73-d609-4cd1-b1be-4e7213b3401e",
    "processName":"File Transfer",
    "remoteFileName":"file-1455559672258.txt",
    "returnCode":"0",
    "sequence":0,
    "type":"event"
 }

File Transfer Status Event

A file transfer status event represent an intermediate status of a file transfer. No additional fields are defined for file transfer status events.
Example:
{  
    "bytesTransferred":0,
    "event":"TransferStatus",
    "fileSize":5120,
    "msgId":"EVTEX0009D",
    "msgText":"info",
    "nodeId":"cron/cron123",
    "occurred":"2016-02-15T18:08:24.207+0000",
    "processId":"1d8b8f73-d609-4cd1-b1be-4e7213b3401e",
    "processName":"File Transfer",
    "returnCode":"0",
    "sequence":0,
    "type":"event"
 }

File Transfer Step Start Event

A file transfer step start event represents the start of a file transfer. You must post a subsequent file transfer step end event after the transfer completes (whether it successfully or not). No additional fields are defined for file transfer step start events.
Example:
{  
    "direction":"inbound",
    "event":"TransferStepStart",
    "fileSize":null,
    "localFileName":"file-1455559672258.txt",
    "localPath":null,
    "msgId":"EVTEX0008D",
    "msgText":"start",
    "nodeId":"cron/cron123",
    "occurred":"2016-02-15T18:07:52.971+0000",
    "processId":"1d8b8f73-d609-4cd1-b1be-4e7213b3401e",
    "processName":"File Transfer",
    "remoteFileName":"file-1455559672258.txt",
    "remotePath":null,
    "returnCode":"0",
    "sequence":1,
    "stepName":null,
    "type":"event"
 }

File Transfer Step End Event

A file transfer step end event represents the end of a file transfer. No additional fields are defined for file transfer step end events.
Example:
{  
    "direction":"inbound",
    "event":"TransferStepEnd",
    "fileSize":null,
    "localFileName":"file-1455559672258.txt",
    "localPath":null,
    "msgId":"EVTEX0015D",
    "msgText":"end",
    "nodeId":"cron/cron123",
    "occurred":"2016-02-15T18:08:49.378+0000",
    "processId":"1d8b8f73-d609-4cd1-b1be-4e7213b3401e",
    "processName":"File Transfer",
    "remoteFileName":"file-1455559672258.txt",
    "remotePath":null,
    "returnCode":"0",
    "sequence":0,
    "stepName":null,
    "type":"event"
 }

File Transfer End Event

A file transfer end event represents the end of a file transfer and can trigger Service Level Criteria (SLC) rules. Start and end events should match up in terms of file name(s) and transfer direction. No additional fields are defined for file transfer end events.
Example:
{  
    "bytesTransferred":15360,
    "direction":"inbound",
    "event":"TransferEnd",
    "localFileName":"file-1455559672258.txt",
    "msgId":"EVTEX0015D",
    "msgText":"end",
    "nodeId":"cron/cron123",
    "occurred":"2016-02-15T18:08:49.378+0000",
    "processId":"1d8b8f73-d609-4cd1-b1be-4e7213b3401e",
    "processName":"File Transfer",
    "remoteFileName":"file-1455559672258.txt",
    "returnCode":"0",
    "sequence":1,
    "type":"event"
 }