XFB Tracked Object attributes

This topic provides the XFB tracked object roles, sender and receivers, production identification, and transfer attributes.

Note Depending on the type of transfer some Sentinel attributes may not be reported in SENDING or RECEIVING state, but are correspondingly available for SENT or RECEIVED.

The following topics list the XFB tracked object roles, sender and receivers, production identification, and transfer attributes:

Tracked object roles

Sentinel attribute Length Description Applicable states Name in Secure
Transport

Direction

integer

1

One of the following:

  • S: The file is sent (Sender).
  • R: The file is received (Receiver).
 All

Direction

Corresponds to the DXAGENT_TRANSFER_DIRECTION SecureTransport event environment variable.

IsServer

integer

1

One of the following:

  • 1: The Sender or the Receiver acts as a Server.
  • 0: The Sender or the Receiver is a Requester.
All Action By

Tracked object sender and receivers

Sentinel attribute Length Description Applicable states Name in Secure
Transport

ReceiverId

string

80

Receiver Login Name

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

For PeSIT transfers, corresponds to PeSIT PI4.

  • In case of SecureTransport receiving a file from CFT, the PI4 value is the login name of the SecureTransport account that receives the file.
  • In case of SecureTransport uploading a file to a CFT partner, the PI4 value corresponds to the transfer site name that identifies the partner.

For non-PeSIT transfers, the value of this attribute is the ip:port of the remote partner, the hostname, or the SecureTransport login name.

For ADHOC transfers:

  • In case of an incoming ADHOC transfer, the value of this attribute is the account email.
  • In case of an outgoing ADHOC transfer, the value of this attribute is the recipient email.

SenderId

string

80

Sender Login Name

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

For PeSIT transfers, corresponds to PeSIT PI3.

  • In case of SecureTransport receiving a file from CFT, the PI3 parameter value is the name of the transfer site that identifies the partner.
  • In case of SecureTransport uploading a file to a CFT partner, the PI3 parameter value corresponds to the SecureTransport account name that’s doing the transfer.

For non-PeSIT transfers, reports the SecureTransport login name of the transfer site owner, the hostname, or the ip:port of the remote partner where SecureTransport pulled the file from.

For ADHOC transfers:

  • In case of an incoming ADHOC transfer, the value of this attribute is the email of the sender.
  • In case of an outgoing ADHOC transfer, the value of this attribute is the account email.

FinalReceiverId

string

80

The Login Name of the final Receiver in case of Store and Forward

All

For PeSIT transfers, corresponds to PeSIT PI62 or PI4.

  • If PI62 is not present, PI4 is used in both Sentinel and PeSIT.
  • In case of SecureTransport initiating a new Store and Forward transfer, the PI62 value corresponds either to the Final Destination property of the PeSIT transfer site or to the Final Destination property of the Send To Partner step. If both properties are left blank, PI62 is not populated.
  • In the PRESERVE store and forward mode, PI preserves the PI62 value.

For non-PeSIT transfers, the value of this attribute is the ReceiverId. In case the ReceiverId value is not present, the value of the FinalReceiverId is the ip:port of the Remote Partner or the hostname.

OriginalSenderId

string

80

 

The Login Name of the original Sender in case of Store and Forward

All

For PeSIT transfers, corresponds to PeSIT PI61.

  • In case of SecureTransport initiating a new Store and Forward transfer, the PI61 value corresponds either to the Originator property, specified in the PeSIT transfer site settings, or the Originator property in the Send To Partner step settings. If both properties are left blank, PI61 is not populated.
  • In the PRESERVE store and forward mode, PI preserves the PI61 value.

For non-PeSIT transfers, the value of this attribute is the login name of the SecureTransport account which received/sent the file from a Remote Partner. If login name is not present, the value is SenderID or UserID.

UserID

string

80 Transfer site owner All

For non-PeSIT transfers, reports the transfer site owner. If no transfer site is used, reports the account name of the user who initiated the transfer. When an account template is used, the login name is reported. If no values are present for the account name and the transfer site, N3 is reported.

Site

string

80 Transfer site name All

For non-PeSIT transfers, reports the transfer site name. If no value is present for the transfer site name, N2 is reported.

Tracked object product identification

Sentinel attribute Length Description Applicable states Name in Secure
Transport

MonitorVersion

string

25 Version of SecureTransport in the X.Y.Z format e.g. 5.3.0 or 5.2.1 All MonitorVersion

ProductName

string

50 The constant “SecureTransport” All ProductName

ProductIPAddr

string

255 IP address assigned to the server hosting the SecureTransport application All java.net.InetAddress.
getLocalHost()

ProductOS

string

20 Operating system name as returned by os.name Java system property All os.name Java system property.

EnvironmentID

integer

  Environment ID as defined in Server Config All EnvironmentID

Tracked object transfer users

Sentinel attribute Length Description Applicable states Name in Secure
Transport

GroupId

string

80 The name of the SecureTransport account All Account name

Tracked object transfer identification

Sentinel attribute Length Description Applicable states Name in Secure
Transport

Application

string

80 Application name. All SecureTransport application name.

CoreId

string

100 File identifier. Preserved during all types of processing. All Corresponds to DXAGENT_CORE_ID environment variable

EventTimeStamp

string

100 Event time stamp. All  

FileName

string

512

If the value of the CommandType attribute is:

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

Fullpath of the filename.

Corresponds to the DXAGENT_FULLTARGET SecureTransport event environment variable.

FlowName

string

100 Parameter to define a flow name in Central Governance for monitoring purposes. All FlowName

LocalId

string

36 Stores the file tracking transfer ID.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Transfer ID. Corresponds to the TRANSFER_STATUS_ID SecureTransport event environment variable.

ProtocolFile
Name

string

512

Corresponds to the PeSIT PI12

Reports the new name of a file that has been renamed using the "Send File As" functionality of an internal or pluggable transfer site.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

File.

Corresponds to the DXAGENT_TARGET SecureTransport event environment variable.

ProtocolFile
Label

string

80

Corresponds to the PeSIT PI37 – file label.

Reports the remote file path and the new name of a file that has been renamed using the "Send File As" functionality.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 When SecureTransport is a sender, this is configured in the Transfer Profile. When SecureTransport is a receiver, this value is configured and supplied by the sender.

ProtocolId

string

80 Corresponds to the PeSIT PI13 – Transfer ID.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Transfer ID

Protocol
Message

string

4000

If the value of the CommandType attribute is:

  • A: the value of this attribute is the content of the message sent as part of the acknowledgment.
  • F: this attribute is empty.

ACKED

ENDED_TO_ACK

 Corresponds to the DXAGENT_TRANSFER_ACK_MESSAGE SecureTransport event environment variable.

Protocol
Parameter

string

512

Corresponds to PI99. (ServiceParam or User message);

For FTP server-initiated transfers, reports the upload command used in the FTP transfer site.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

User message

Upload command in FTP transfer sites

User
Parameter1

string

255

Contains information whether the transfer is with an Internal partner, External partner or Unknown.

  • For transfer with an Internal partner I is reported.
  • For transfer with an External partner E is reported.
  • If the Administrator has not specified Internal or External – N is reported.
All

TransferType in account or site name.

 

 

User
Parameter2

string

255

Reports the account type:

  • User (meaning that account has been specified in SecureTransport’s database).
  • Template (meaning that this is a template).
  • Service (Service account).
 All Account Type

ParentCycleID

integer

  ID of the parent processing cycle. TO_EXECUTE, SENDING, SENT ParentCycleID

Tracked object transfer dates and times

Sentinel attribute Length Description Applicable states Name in Secure
Transport

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.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

StartTime

time

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.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

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.

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

EndTime

time

 

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.

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

Transmission
Duration

integer

  Transfer duration (expressed in seconds).

SENT

RECEIVED

INTERRUPTED

SUSPENDED

ACKED

ENDED_TO_ACK

ROUTED

 Duration

Tracked object transfer protocols

Sentinel attribute Length Description Applicable states Name in Secure
Transport

Protocol

string

25

The following:

  • PSIT_HS_E
All

Protocol.

Corresponds to the DXAGENT_PROTOCOL SecureTransport event environment variable.

IsSSL

string

1

One of the following:

  • 1: SSL/TLS used for the transfer.
  • 0: SSL/TLS not used for the transfer.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Use TLS/SSL in transfer site.

SSLAuth

string

1

One of the following:

  • S: The Server sent X.509 certificates to the Requester. For SSH sessions, the value of SSLAuth will be always S if the Requester does not present a key.
  • 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.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 DXAGENT_SSLAUTH

SSLCypher

integer

 

One of the following:

  • the RFC code of the cipher suite that the Server and the Requester used during the SSL/TLS session. The cipher suite identifies the authentication method, the encryption algorithm, and the hash algorithm for MAC calculation.
  • 0 for all SSH sessions.
 All DXAGENT_SESSION_SSL_CYPHER

Tracked object transfer options

Sentinel attribute Length Description Applicable states Name in Secure
Transport

Compression

string

1

One of the following:

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

Corresponds to PI21.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Compression in transfer site.

RetryMax
Number

integer

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

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 EventQueue.
maxRetry
Count on Server Configuration page.

Retry
Number

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.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Corresponds to the DXAGENT_PERSISTED_EVENT_RETRY_COUNT SecureTransport event environment variable.

Request
Type

string

1

One of the following:

  • S: The Sender sent a single transfer to a single Receiver. This corresponds to a normal file transfer.
  • F: The Sender sent a group of transfers to a single Receiver. For each transfer in the group, the product generated one Processing Cycle. This corresponds to multiselect PeSIT option.
  • D: The Sender sent a single transfer to a group of Receivers (diffusion). For each Receiver in the group, the product generated one Processing Cycle. This corresponds to send to multiple transfer sites SecureTransport configuration.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 SecureTransport always reports as value for RequestType.

Transfer
Type

string

1

One of the following:

  • S: The Sender sent a single transfer to a single Receiver. This corresponds to a normal file transfer.
  • F: The transfer belongs to a group of transfers that the Sender sent to a single Receiver. For each transfer in the group, the product generated one Processing Cycle. This corresponds to multiselect PeSIT option.
  • D: The Receiver belongs to a group of Receivers to whom the Sender sent the transfer (diffusion). For each Receiver in the group, the product generated one Processing Cycle. This corresponds to send to multiple transfer sites SecureTransport configuration.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 SecureTransport always reports as value for RequestType

Tracked object transfer size

Sentinel attribute Length Description Applicable states Name in Secure
Transport

FileSize

integer

 

An estimation of the file size given at the beginning of the transfer and updated upon completion of the transfer with the real value checked by ST using the file system.

Corresponds to PI42.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

TransmittedBytes

integer

 

Number of bytes transferred, after decompression, to transfer the file. This size is expressed in bytes.

Corresponds to PI27.

Note: For PeSIT, this value sent is crosschecked by both the sender and receiver.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Corresponds to the DXAGENT_TRANSFERRED_BYTES SecureTransport event environment variable.

Tracked object transfer structure and content

Sentinel attribute Length Description Applicable states Name in Secure
Transport

CommandType

string

1

One of the following:

  • F: File transfer
  • A: Acknowledgment

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

FileType

string

60

One of the following:

  • B: the transferred file is a Binary file.
  • T: the transferred file is a Text file.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Transfer Mode in Transfer Profile or Data Encoding in Send To Partner step.

RecordNumber

integer

Number of record in the file. This size is expressed in bytes.

Note: For PeSIT, this value sent is crosschecked by both the sender and receiver.

Corresponds to PeSIT PI28.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

RecordFormat

string

64

One of the following:

  • F: fixed: The transferred data contains fixed-length records.
  • V: variable: The transferred data contains variable-length records.

Corresponds to PeSIT PI31.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Record Format in Transfer Profile or in Send To Partner step.

RecordSize

integer

 

One of the following:

  • If the value of RecordFormat attribute is fixed, the value of this attribute is the size of all records in the transferred file, expressed in bytes.
  • If the value of RecordFormat is variable or undefined, the value of this attribute is the size of the largest record in the transferred file, expressed in bytes.

Corresponds to PeSIT PI32.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Record Length in Transfer Profile or in Send To Partner step.

Transcoding

integer

 

Character code of the transferred data:

  • A: ASCII
  • B: Binary
  • E: EBCDIC

From PI16.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

 Transfer Mode in Transfer Profile or Data Encoding in Send To Partner step.

Tracked object other attributes

Sentinel attribute Length Description Applicable states Name in Secure
Transport

VirtualDirName

string

255 The current folder relative to the home folder. All

DXAGENT_TARGET_PATH

GroupName

string

80 Business Unit name All

DXAGENT_BUSINESS_UNIT_NAME

SessionTag

string

50 Represents SecureTransport session ID. The Session ID could be used to query the server log for a particular session. All

Session ID

TransferTag

string

50

Represents SecureTransport transfer status operationIndex.

Transfer ID could be used to query the file tracking log for a particular transfer

All  

RemoteAddr

string

255 Partner remote address (IPv4 and IPv6).

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

ROUTED

  

RemoteSAP

integer

  Partner remote port number.

SENDING

RECEIVING

SENT

RECEIVED

ACKED

ENDED_TO_ACK

INTERRUPTED

SUSPENDED

 Not reported by SecureTransport.

Related topics:

Related Links