Track activities and events > Sentinel > XFBTransfer Tracked Object

XFBTransfer Tracked Object

XFBTransfer is a Sentinel Tracked Object that stores and describes events related to file or message transfers. Interchange generates XFBTransfer data for each step of the transfer process. The collected data of the entire processing cycle describe the transfer of a file or a message between two endpoints.

XFBTransfer attributes

XFBTransfer includes attributes that you can use to identify:

Attribute descriptions

Identify the steps in the transfer process

For each step of each transfer, the Interchange generates an "event" (tracking data message) that it sends to Sentinel. The State attribute of the event identifies the relevant step of the transfer process. The following table lists and describes the typical values of the State attribute for most message exchanges.

Sentinel state Details
CONSUMING Interchange is beginning to receive data from a sending partner. This may be interrupted and repeat at the transport level.
INTERRUPTED The message processing on Interchange has been interrupted.

CREATED

A sender or receiver initiated a message transfer on Interchange.
PACK Interchange enveloped a message for sending.
PRODUCING Interchange is beginning to transmit data to a receiving partner. This may be interrupted and repeat at the transport level.

SENDING

Interchange is sending data to a receiving partner.

SENT

Interchange sent all of the transfer data to a receiving partner.
UNPACK Interchange unpacked an inbound enveloped message.

RECEIVING

Interchange is in the process of receiving data from a sending partner.

RECEIVED

Interchange has received all of the data from a sending partner.
REJECTED The message processing has failed and is out of retries.
RETRY The message processing is attempting to complete with a scheduled retry.
TO_ACK Interchange expects an acknowledgement of an inbound or outbound transfer.
ACKED Interchange has received an acknowledgement of an inbound or outbound transfer.
NACKED Interchange has not received an expected acknowledgement of an inbound or outbound transfer.

Additional state attributes for embedded FTP/SFTP server events

From Interchange 5.12, the trading engine generates a message state for each of the following events in the embedded FTP/SFTP server. Working in Sentinel, you can configure Dashboards and Requests to track the status of remote partner FTP file pickups (GETs), using these attributes:

Sentinel state Details

DOWNLOADING

Interchange is in the process of downloading the message payload.

DOWNLOADED

Interchange has completed the download of the message payload.

INTERRUPTED

The download of the message payload has been interrupted on Interchange.

REMOVED

The message payload has been deleted from the embedded server.

Additional state attributes for embedded WebTrader server events

From Interchange 5.12, Interchange generates a message state for each of the following events in the embedded WebTrader server:

Sentinel state Details
ACCESSED A WebTrader document has been either viewed or downloaded by a WebTrader end user.
REMOVED A WebTrader document has been removed by a WebTrader end user.
RENAMED A WebTrader document has been renamed by a WebTrader end user.
PURGED A WebTrader document has been purged by a WebTrader end user.
SUPPLIED A WebTrader document has been uploaded by a WebTrader end user.
DELIVERED A WebTrader document has been delivered to WebTrader end user.
MOVED A WebTrader document has been moved to a different directory by a WebTrader end user.

Additional state attributes for AS4, OFTP, and PeSIT protocol message-handling events

From Interchange 5.12, Interchange generates an AVAILABLE message state for the following message-handling events:

Sentinel state Details
AVAILABLE

Interchange has set a message to one of the following statuses:

  • The message is being held for later pickup
  • The message-processing schedule in not currently active
  • The message is waiting for pull processing to begin (AS4 only)
  • A related child message is waiting for pull processing (AS4 only)
  • An inbound or outbound message is being pull processed (AS4 only)

Identify the relationship to other events

The sequence of events that describe a single complete Interchange message or file exchange are referred to as a Processing Cycle. To identify the individual processing events that belong to the same Processing Cycle, use the CycleId attribute.

Identify the roles of transfer partners

Each endpoint in a transfer has one of two roles:

  1. Sender or Receiver
  2. Requester or Server

The State attribute details table describes 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:

For each Interchange transfer event, the following attributes identify the roles of the transfer partner that generated the Tracked Instance.

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: When a transfer occurs between a Sender/Requester and a Receiver/Server, Sentinel receives the following data for the event.

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: When a transfer occurs between a Receiver/Requester and a Sender/Server, Sentinel receives the following data for the event.

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)

Identify 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.

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

Identify 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.

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

Identify transfers

To identify a transfer, use the following attributes.

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

Identify 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.

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.

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.

Identify transfer protocols

Most transfers are associated with three protocol layers:

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

Identify transfer options

To monitor transfer options, use the following attributes.

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.

Identify the size of transfers

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

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.

Identify the structure and content of transfers

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

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.

Metadata for most messages

In the following table, the value column shows an actual or sample value for an element, when applicable. Sample values are noted as such.

Element

Description

 Value

Application

File name.

Sample value:

pc1_To_pc3_1002.edi
CommunityPickup The name of the trading pickup that consumed a message. ––

CycleId

When Interchange reports its XFBTransfer Tracked Object to Sentinel, Sentinel hashes the value to produce the CycleId.

The sample value is an example of a CycleId as generated by Sentinel. Interchange does not generate the CycleId.

Sample value:

XR1QTJr3uCYG

71KWdqJN113R

SSx1sX

DeliveryExchange

The name of the trading delivery used to send the message.

––

Direction

The direction of the message related to the event.

Sender (S) is a message picked up from integration for sending to a trading partner.

Receiver (R) is a message received from a partner and sent to integration.

S = Sender

R= Receiver
DocumentType The type of document (within a document format and version category) that is being exchanged.

Sample value:

810
EndDate End date of transaction (when known).

Sample value:

2014-11-14
EndTime End time of transaction (when known). Sample value: 14:26:51:268

EventDate

The date that Interchange generated the event, in yyyy-mm-dd format.

Sample value:

2014-11-14

EventId

The event identification number generated by Interchange.

Sample value:

1163521349929

EventTime

The time Interchange generated the event, in hh:mm:ss format.

 Sample value: 14:26:51

FileName

The original name of the file Interchange received from integration or from a partner.

Sample value:

pc3_To_pc1_1001.edi

FileSize

The size of the file in bytes.

Sample value:

1636

GmtDiff

The number of minutes between local time and GMT.

Sample value:

-420

IntegrationDelivery

The name of the exchange that a message is sent to for integration.

––

IntegrationPickup

The name of the exchange that consumed a message from integration.

––

IsAlert

Indicates whether the transaction is in an alert state.

0 = not alert

1 = alert, not resolved

2 = alert, resolved

IsEnd

Indicates whether the transaction is completed.

0 = transaction not end

1 = transaction completed

IsException

Indicates whether the transaction is in an exception state.

0 = not exception

1 = exception

IsServer

Indicates whether Interchange is acting as a server.

0 = not server

1 = server

IsSsl

Indicates when an SSL connection is in use.

0 = not SSL

1 = SSL

Location

Name of the location of Interchange node sending the event.

Sample value:

hostname_te

Machine

Name of the computer running Interchange.

Sample value:

hostname-t41

Monitor

Indicates Interchange is the transaction monitor.

Sample value:

INTR = Interchange

MonitorVersion

The version and build number of Interchange.

Sample value:

5.10.1.0.11.6825

ProductName

Product name of Interchange.

 Interchange

ProductOs

Name of the operating system on the computer running Interchange.

Sample value:

Windows XP

Protocol

The transport protocol for the traded messages.

Sample value:

HTTP

ProtocolId

Name of the EDIINT message protocol.

Sample value:

AS2

Rappl

URL Interchange uses to send a message to a partner.

Sample value:

http://hostname-t41:4085/exchange/partner

ReceiverId

Routing ID of the message receiver.

Sample value:

partner

RequestType

The type of message processing request the transaction represents.

S = single transfer

G = split documents

RetryMaxNumber

Maximum number of times Interchange tries to send a message.

Sample value:

3

RetryNumber

Number of times Interchange tried to send a message.

Sample value:

1

ReturnCode

Message type.

0 = unknown

1 = request

2 = receipt

3 = request and receipt

ReturnMessage

Description for a rejected transaction.

The reject reasons reported to Sentinel are the same as the reasons used by Interchange and reported in Message Tracker.

 ––

Sappl

URL a partner uses to send a message to Interchange.

Sample value:

http://hostname-t41:4085/exchange/community
SendDate Populated by Interchange when the production date is assigned.

Sample value:

2014-11-14

SenderId

Routing ID of the sending community in Interchange.

Sample value:

community
SendTime Populated by Interchange when production time is assigned.

Sample value:

10:05:17:977

SentinelCycleId

The raw unhashed CycleId generated by Interchange.

This is the key element for linking together the various pieces of a transaction.

Sample value:

SUIV1163523917554.1909@tsuliga-t41_te … E
SequenceID Together with SequenceCount, identifies the sequence position of messages consumed by pickups when sequential messaging is activated for the pickup. ––
SequenceCount Together with SequenceID, identifies the sequence position of messages consumed by pickups when sequential messaging is activated for the pickup. ––

Site

Sending (outbound) or receiving (inbound) party name, based on direction.

Community name

StartDate

Date that Interchange originated a message, in yyyy-mm-dd format.

Sample value:

2014-11-14

StartTime

Time that Interchange originated a message, in hh:mm:ss:sss format

Sample value:

10:05:17:977

State

Event state reported to Sentinel by Interchange.

For a list of states, see XFBTransfer Tracked Object.

Sample value:

To_Ack

TradeDestination

For an outbound message, the routing ID of the receiving partner.

For an inbound message, the routing ID of the receiving community.

 ––

TradeDestinationAlias

For an outbound message, the name of the receiving partner.

For an inbound message, the name of the receiving community.

 ––

TradeFormat

The message protocol used to send the message.

Sample value:

AS2

TradeMessageId

The ID Interchange assigned to the message.

Sample value:

<1179782810657.1423@a_te>

TradeOriginator

For an outbound message, the routing ID of the sending community.

For an inbound message, the routing ID of the sending partner.

 ––

TradeOriginatorAlias

For an outbound message, the name of the sending community.

For an inbound message, the name of the sending partner.

 ––

TradeSigningAlgo

The algorithm used to sign the message.

Sample value:

SHA1

TradeState

The state of the original message.

Sample value:

Delivered
TransmissionDuration Elapsed time of transmission in seconds.

Sample value:

7

UserObjectId

Cycle ID with message state added as suffix.

Sample value:

SUIV1163523917554.1909@hostname_te … E.To_Ack