XFBTransfer Tracked Object

About XFBTransfer

XFBTransfer is a Tracked Object that stores and describes Tracked Instances of transfers. Each Tracked Instance describes a single step of a single transfer process. Together the Tracked Instances in each Processing Cycle describe the transfer of a file or a message between two Transfer CFT applications.

When you configure Sentinel for Transfer CFT, you can import the XFBTransfer Tracked Object.

XFBTransfer attributes

XFBTransfer includes attributes that you can use to identify:

Attributes description

Identifying the steps in the transfer process

For each step of each Transfer CFT transfer, Transfer CFT generates one Tracked Instance. In each Tracked Instance, the State attribute identifies the relevant step of the transfer process. The following table lists and describes the possible values of the State attribute for the Tracked Instances of a single Transfer CFT transfer.

ClosedState attribute details
State Details

Created

The Requester prepared a transfer request and updated the transfer catalog or, alternatively the transfer mailbox.

To_Execute

The Requester sent the transfer request to the Server.

Sending

The Sender is sending data.

Receiving

The Receiver is receiving data.

Sent

The Sender sent all of the transfer data.

Received

The Receiver received all of the transfer data.

Terminated

The Sender sent all of the transfer data, and the Receiver received all of the transfer data. Both partners successfully completed the transfer.

The set of Tracked Instances that concern a single Transfer CFT transfer are referred to as a Processing Cycle. To identify the Tracked Instances that belong to the same Processing Cycle, use the CycleId attribute.

Identifying the roles of transfer partners

Although each Transfer CFT transfer occurs between only two transfer partners, each transfer partner plays two roles:

  1. Sender or Receiver
  2. Requester or Server

The State attribute details table underscores these roles. Notice that transfer partners are referred to as Requesters, Senders, and Receivers.

For a given transfer, only the following combinations of partner roles are possible:

In each Tracked Instance, the following attributes identify the roles of the transfer partner that generated the Tracked Instance.

ClosedAttribute details
Attribute Data Type

Value

Direction

String

One of the following:

  • E: The Sender generated the Tracked Instance
  • R: The Receiver generated the Tracked Instance

IsServer

String

One of the following:

  • 1: The Sender or, alternatively the Receiver is a Server
  • 0: The Sender or, alternatively the Receiver is a Requester

Example 1

ClosedWhen a transfer occurs between a Sender/Requester and a Receiver/Server, Sentinel receives the following Tracked Instances.
State Direction IsServer

Created

E (Sender)

0 (Requester)

To_Execute

E (Sender)

0 (Requester)

Sending

E (Sender)

0 (Requester)

Receiving

R (Receiver)

1 (Server)

Sent

E (Sender)

0 (Requester)

Received

R (Receiver)

1 (Server)

Example 2

ClosedWhen a transfer occurs between a Receiver/Requester and a Sender/Server, Sentinel receives the following Tracked Instances.
State Direction IsServer

Created

R (Receiver)

0 (Requester)

To_Execute

R (Receiver)

0 (Requester)

Sending

E (Sender)

1 (Server)

Receiving

R (Receiver)

0 (Requester)

Sent

E (Sender)

1 (Server)

Received

R (Receiver)

0 (Requester)

Identifying Senders and Receivers

Together, the Direction and IsServer attributes identify the role of a transfer partner in the transfer process. However, they do not explicitly identify partners. To explicitly identify transfer partners, use the following attributes.

ClosedAttribute details
Attribute Data Type Value

Site

String

Partner alias that the local partner uses to identify the parameter settings for the remote partner. When the value of the Direction attribute is:

  • R (Receiver), the Receiver is the local partner. The Receiver used the value of this attribute to identify the parameter settings for the Sender.
  • E (Sender), the Sender is the local partner. The Sender used the value of this attribute to identify the parameter settings for the Receiver.

ReceiverId

String

Network identifier of the Receiver

SenderId

String

Network identifier of the Sender

RAppl

String

Network identifier of the Receiver application

SAppl

String

Network identifier of the Sender application

FinalReceiverId

String

If the Processing Cycle:

  • describes a stored and forwarded transfer, the value of this attribute is the Network Identifier of the final Receiver of the transfer
  • does not describe a stored and forwarded transfer, the value of this attribute is empty

OriginalSenderId

String

If the Processing Cycle:

  • describes a stored and forwarded transfer, the value of this attribute is the Network Identifier of the initial Sender of the transfer
  • does not describe a stored and forwarded transfer, the value of this attribute is empty

Identifying transfer monitors

Each Sender and Receiver is a logical entity that operates from a physical machine. Each machine is referred to as a transfer monitor. To identify details about transfer monitors, use the attributes that are listed in the following table. If the value of the direction attribute is:

ClosedDirection attribute details
Attribute Data Type Data Type

Location

String

Unique and logical identifier of a transfer monitor

Machine

String

Name of the Axway Managed File Transfer application and platform that runs on a transfer monitor

Monitor

String

One of the following application names:

  • CFT: Transfer CFT transfer monitor
  • PEL: Inter.Pel transfer monitor
  • Gateway: Gateway transfer monitor

MonitorVersion

String

Version of the File Transfer application that runs on a transfer monitor

Identifying transfer users

Although Senders and Receivers perform all actions in the transfer process, they do not initiate these actions. Transfer users initiate transfer actions. Transfer users include both people and software applications. To monitor details about transfer users, use the following attributes.

ClosedUser attribute details
Attribute Data Type Value

UserId

String

Local identifier of the user who owns the transferred file or message

GroupId

String

Local identifier of the group to which the transfer owner belongs

RequestUserId

String

Local identifier of the user who requested the transfer. If the user is:

  • also the transfer owner, the values of UserId and RequestUserId match
  • not the transfer owner, the values of UserId and RequestUserId do not match

RequestGroupId

String

Local identifier of the group to which the requesting user belongs

Trustee

String

If User Access Control is:

  • activated for the transfer, the value of this attribute is the local identifier of the transfer owner (UserId)
  • not activated for the transfer, the value of this attribute is the network identifier of the user who requested the transfer (RequestUserId)

RUser

String

Local identifier of the user who received the transfer

SUser

String

Local identifier of the user who sent the transfer

Identifying transfers

To identify a transfer, use the following attributes.

ClosedAttributes
Attribute Data Type Value

IdAppl

String

If the value of the IsServer attribute is:

  • 0, the value of this attribute is the local identifier of the Requester
  • 1, the value of this attribute is empty

Application

String

Local data identifier. If the value of the Monitor attribute is:

  • CFT, the value of this attribute is an IDF (Model File Identifier)
  • PEL or Gateway, the value of this attribute is an object name

FileName

String

If the value of the CommandType attribute is:

  • Message, this attribute is empty
  • File and the value of the Direction attribute is E (Sender), this attribute identifies the file from which the Sender retrieved the transfer data
  • File and the value of the Direction attribute is R (Receiver), this attribute identifies the file in which the Receiver recorded the transfer data

LocalId

String

If the value of the Direction attribute is:

  • E (Sender), the value of this attribute is the local transfer identifier for the Sender
  • R (Receiver), the value of this attribute is the local transfer identifier for the Receiver

Senders and Receivers use local transfer identifiers to manage transfers (cancel, delete, and so on).

ProtocolFileName

String

Network transfer identifier. The Sender sent this identifier to the Receiver.

ProtocolFileLabel

String

Network transfer name. The Sender sent this name to the Receiver. The Receiver can use this name to locally name the transfer.

ProtocolId

String

Network transfer identifier. The Sender generated this identifier. The Receiver acknowledged this identifier.

ProtocolMessage

(Gateway only)

String

If the value of the CommandType attribute is:

  • Message, the value of this attribute is the content of the transferred message
  • File, this attribute is empty

PositionNumber

Integer

Catalog transfer identifier. If the value of the Direction attribute is:

  • E (Sender), the value of this attribute identifies the transfer in the Sender's transfer catalog or transfer mailbox
  • R (Receiver), the value of this attribute identifies the transfer in the Receiver's transfer catalog or transfer mailbox

ProtocolParameter

String

Network transfer description. The Sender sent this description to the Receiver.

UserParameter

String

Local transfer description. When the Requester recorded the transfer in the transfer catalog or transfer mailbox, the Requester generated this description.

The value of this attribute includes two parts:

  • the first part contains the first forty characters of the description
  • the second part contains the remaining characters of the description

Identifying transfer validity periods

Senders and Receivers can perform specific transfers only during the specified validity periods. To monitor the validity periods for transfers, use the following attributes.

ClosedAttributes
Attribute Data Type Value

EarliestDate

Date

Date on which the validity period begins

EarliestTime

String

Time at which the validity period begins

LatestDate

Date

Date on which the validity period ends

LatestTime

String

Time at which the validity period ends

Identifying transfer dates and times

During the transfer process, Senders and Receivers record the time and date of certain actions that they perform. To monitor these details, use the following attributes.

ClosedAttributes
Attribute Date Type Value

CreationDate

Date

By default, the system date on which the Sender sent the transfer. The Sender can set this date. The Receiver can filter transfers based on this date.

CreationTime

String

By default, the system time at which the Sender sent the transfer. The Sender can set this time. The Receiver can filter transfers based on this time.

SendDate

Date

If the value of the Direction attribute is:

  • E (Sender), the value of this attribute is the date on which the Sender recorded the transfer in the transfer catalog or transfer mailbox.
  • R (Receiver), the value of this attribute is the date on which the Receiver recorded the transfer in the transfer catalog or transfer mailbox

The Sender and the Receiver record each transfer only once.

SendTime

String

If the value of the Direction attribute is:

  • E (Sender), the value of this attribute is the local time at which the Sender recorded the transfer in the transfer catalog or transfer mailbox.
  • R (Receiver), the value of this attribute is the local time at which the Receiver recorded the transfer in the transfer catalog or transfer mailbox.

The Sender and the Receiver record each transfer only once.

AckDate

Date

Date on which the Receiver acknowledged the transfer. If the Receiver did not acknowledge the transfer, this attribute is empty.

AckTime

String

Time at which the Receiver acknowledged the transfer. If the Receiver did not acknowledge the transfer, this attribute is empty.

StartDate

Date

If the value of the State attribute is:

  • SENT, the value of this attribute is the date on which the Sender began sending the transfer
  • RECEIVED, the value of this attribute is the date on which the Receiver began receiving the transfer

These dates are expressed in dd.mm.yyyy format.

StartTime

String

If the value of the State attribute is:

  • SENT, the value of this attribute is the local time at which the Sender began sending the transfer
  • RECEIVED, the value of this attribute is the local time at which the Receiver began receiving the transfer

These times are expressed in hh:mn:ss format.

EndDate

Date

If the value of the State attribute is:

  • SENT, the value of this attribute is the date on which the Sender stopped sending the transfer
  • RECEIVED, the value of this attribute is the date on which the Receiver stopped receiving the transfer

These dates are expressed in dd.mm.yyyy format.

EndTime

String

If the value of the State attribute is:

  • SENT, the value of this attribute is the local time at which the Sender stopped sending the transfer
  • RECEIVED, the value of this attribute is the local time at which the Receiver stopped receiving the transfer

These times are expressed in hh:mn:ss format.

TransmissionDuration

String

If the value of the State attribute is:

  • SENT, the value of this attribute is the time that was required to send the transfer
  • RECEIVED, the value of this attribute is the time that was required to receive the transfer

These times are expressed in seconds.

Identifying transfer protocols

Most transfers are associated with three protocol layers:

ClosedProtocol and SSL / TLS Layer attribute details
Attribute Data Type Value

Protocol

String

Name of the protocol that operates at the Protocol Layer of the transfer. The possible values of this attribute are:

  • ETB3(ETEBAC 3)
  • FTP_HTTP
  • ETB5V1(ETEBAC 5 version 1)
  • HTTP
  • ETB5V2(ETEBAC 5 version 2)
  • PEL
  • PSIT_HS_E(PESIT, version E)
  • POP3
  • PSIT_HS_D(PESIT, version D)
  • SMTP
  • OFDT(ODETTE File Transfer Protocol)
  • SFTP
  • FTP

 

IsSSL

String

One of the following:

  • 1: SSL/TLS protected the transfer.
  • 0: SSL/TLS did not protect the transfer.

SSLAuth

String

One of the following:

  • S: The Server sent X.509 certificates to the Requester.
  • B: Both the Server and the Requester sent X.509 certificates to each other.
  • N: Neither the Server nor the Requester sent X.509 certificates.

SSLCypher

String

The cipher suite that the Server and the Requester used during the SSL/TLS session. The cipher suite identifies the following:

  • authentication method
  • encryption algorithm
  • hash algorithm for MAC calculation

Identifying transfer options

To monitor transfer options, use the following attributes.

ClosedTransfer attribute details
Attribute Data Type Value

Compression

String

One of the following compression options:

  • 0: Undefined
  • 1: Horizontal
  • 2: Vertical
  • 3: Both horizontal and vertical
  • 4: Not compressed

EOTProcedure

String

When the value of the State attribute is:

  • SENT, the value of this attribute is the name of the EOT (End of Transfer Procedure) that the Sender executed
  • RECEIVED, the value of this attribute is the name of the EOT (End of Transfer Procedure) that the Receiver executed

Priority

Integer

Transfer priority. Receivers process transfers in the order of their priority. The range of possible values for this attribute is zero to 255. The lowest priority is zero. The highest priority is 255.

RetryMaxNumber

Integer

Maximum number of times that the Sender can attempt to send transfers

RetryNumber

Integer

Number of times that the Sender attempted to send the transfer. Each time the Sender established a connection with the Receiver, the Sender counted one attempt.

RequestType

String

One of the following:

  • S: The Sender sent a single transfer to a single Receiver.
  • G: The Sender sent a group of transfers to a single Receiver. For each transfer in the group, Axway Managed File Transfer generated one Processing Cycle.
  • D: The Sender sent a single transfer to a group of Receivers (diffusion). For each Receiver in the group, Axway Managed File Transfer generated one Processing Cycle.

TransferType

String

One of the following:

  • G: The transfer belongs to a group of transfers that the Sender sent to a single Receiver. For each transfer in the group, Axway Managed File Transfer generated one Processing Cycle.
  • D: The Receiver belongs to a group of Receivers to whom the Sender sent the transfer (diffusion). For each Receiver in the group, Axway Managed File Transfer generated one Processing Cycle.

Identifying the size of transfers

To monitor the size of transferred files and messages, use the following attributes.

ClosedSize attribute details
Attribute Data Type Value

FileSize

Integer

Size of the transferred file or message on the Sender's monitor, before compression. This size is expressed in bytes.

TransmittedBytes

Integer

Size of the transferred file or message on the Receiver's monitor, after decompression. This size is expressed in bytes.

Identifying the structure and content of transfers

To monitor the structure and content of transfers, use the following attributes.

ClosedStructure attribute details
Attribute Data Type Value

CommandType

String

One of the following:

  • Message: The transferred data is a message.
  • File: The transferred data is a file.

BlockSize

Integer

If the value of the CommandType attribute is:

  • Message, this attribute is empty
  • File and the Receiver's monitor is a main frame, the value of this attribute identifies where the Receiver stores the transferred data
  • File and the Receiver's monitor is not a main frame, this attribute is empty

FileOrganization

String

If the value of the CommandType attribute is:

  • Message, the value of this attribute is org_undefined
  • File, the value of this attribute is one of the following:
    • org_sequential: The transferred data is not indexed.
    • indexed: The transferred data is indexed.
    • direct: The transferred data is assigned relative access.

FileType

String

If the value of the CommandType attribute is:

  • Message, this attribute is empty
  • File, the value of this attribute is one of the following:
    • fixed: The transferred data contains fixed-length records.
    • variable: The transferred data contains variable-length records.
    • undefined: The structure of the transferred data is unknown.

RecordNumber

Integer

If the value of the CommandType attribute is:

  • Message, this attribute is empty
  • File, the value of this attribute is the number of records in the transferred file

RecordSize

Integer

If the value of the CommandType attribute is:

  • Message, this attribute is empty
  • File and the value of the FileType attribute is fixed, the value of this attribute is the size of all records in the transferred file, expressed in bytes
  • File and the value of the FileType attribute is variable or undefined, the value of this attribute is the size of the largest record in the transferred file, expressed in bytes

Transcoding

String

Character code of the transferred data. The possible values of this attribute are:

  • A: ASCII
  • B: Binary
  • E: EBCDIC
  • T: A transcoding table modified the character code of the transfer.
  • U: Undefined

TranslationTableId

String

Translation table identifier. When a transfer partner uses a translation table that is delivered with the Axway Managed File Transfer software, the value of this parameter is INTERNAL.

Related topics

Correspondence tables (Sentinel to Transfer CFT attributes)

XFBLog Tracked Object

XFBStat Tracked Object