FTP and FILE Outbound File Name Masks

Use outbound file name masks to control how TIBCO BusinessConnect Container Edition names outbound files sent using FTP and FILE transport. The mask option is available in the Transports tab for each trading partner.

See "FTP Outbound and FILE Outbound" in TIBCO BusinessConnect Container Edition Trading Partner Administration Guide.

If you leave the file mask field blank, TIBCO BusinessConnect constructs the file name according to the following rules:

Files sent outbound from an Initiator are named tpName-DocumentID.request.
When acknowledgment files are sent outbound from a Responder, the files are named tpName-GUID.ack.(1 or 2).response or tpName-GUID-TimeStamp.ack.response. The suffix number depends on the number of acknowledgments.
For a single transaction X12 document, because TA1 and 997 are generated, the number is always 1 or 2.
For UN, it is always 1.
You can also specify file names by using file masks for generated acknowledgment data.

File Name Mask Examples

If the trading partner’s name is receiver, and the host’s name is sender, to generate an outbound file called receiver.sender.12202002-TIBCO.edi on December 20, 2002, enter the following mask in the Output File Mask field:

#(TpName).#(HostName).#(MMDDYYYY)-TIBCO.edi

If the trading partner’s name is receiver, to generate an outbound file named receiver-12202004-12000003.edi on December 20, 2004 at 12:00:00.03, specify the mask #(TpName)-(#MMDDYYYY)-#(HHMISSNNN).edi.

File Name Mask Syntax

You can use an asterisk (*) in an outbound FILE mask. If a wild card (*) is used in a File or in a FTP-Put outbound file mask, the outbound document will be sent as hostname-GUID.

Masking applies only to file names. It does not apply to any directory name in the FTP or FILE URL. For example, if the FTP or FILE URL is /local/tibco/bc/#(TPNAME)/REQUEST/, and /local/tibco/bc/SELLER-AXNT15/REQUEST/ exists, FILE naming would fail.

Outbound Transport File Name Mask Syntax
Mask Case Sensitivity Description
TxName Case-insensitive Name of the transaction This mask is not valid for use with batched transactions.
TPName Case-insensitive Receiving participant name
HostName Case-insensitive Sending participant name
DDD Case-insensitive Day in a year
YY Case-insensitive Last two digits of a year
YYYY Case-insensitive Year
MMM Case-insensitive Month abbreviated to three characters
MM Case-insensitive Month using two digits (1-base)
DD Case-insensitive Day of the month using two digits (1-base)
HH Case-insensitive Hour of the day (0-24)
MI Case-insensitive Minutes of the hour
SS Case-insensitive Seconds of the minute
NN Case-insensitive Milliseconds of the second using three digits
TransactionID Case-insensitive ID number of the transaction
FileName Case-insensitive Name of the file
GUID Case-insensitive Globally unique identifier
DocumentID Case-insensitive ID of the sent document
OperationID Case-insensitive ID of the operation