You can use a predefined set of macros to dynamically create the files in which the File send handler writes messages. Before creating a file on the file system, the File send handler replaces all the macros in the file name with their individual values. You can use several different macros in one file name.
You can use the file name macros while configuring the File send handler in BizTalk Explorer, or by using the BizTalk Explorer object model.
The File send handler does not replace the macros with a value if any of the following are true:
-
The corresponding system property is not set.
-
The macro is misspelled.
-
The value for the macro contains symbols that are not valid in the file name.
If any of these conditions occur, the File send handler leaves the macros in the file name untouched, for example Myfile_%MessageID%.xml.
The following table lists the supported macros and describes how the File send handler replaces them.
|
Macro name
|
Substitute value
|
|---|
|
%datetime%
|
Coordinated Universal Time (UTC) date time in the format YYYY-MM-DDThhmmss (for example, 1997-07-12T103508).
|
|
%datetime_bts2000%
|
UTC date time in the format YYYYMMDDhhmmsss, where sss means seconds and milliseconds (for example, 199707121035234 means 1997/07/12, 10:35:23 and 400 milliseconds).
|
|
%datetime.tz%
|
Local date time plus time zone from GMT in the format YYYY-MM-DDThhmmssTZD, (for example, 1997-07-12T103508+800).
|
|
%DestinationParty%
|
Name of the destination party. The value comes from the message context property BTS.DestinationParty.
|
|
%DestinationPartyQualifier%
|
Qualifier of the destination party. The value comes from the message context property BTS.DestinationPartyQualifier.
|
|
%MessageID%
|
Globally unique identifier (GUID) of the message in BizTalk Server. The value comes directly from the message context property BTS.MessageID.
|
|
%SourceFileName%
|
Name of the file from which the File adapter read the message. The file name includes the extension and excludes the file path, for example, Sample.xml. When substituting this property, the File adapter extracts the file name from the absolute file path stored in the FILE.ReceivedFileName context property. If the context property does not have a value—for example, if a message was received on an adapter other than the File adapter—the macro will not be substituted and will remain in the file name as is (for example, C:\Drop\%SourceFileName%).
Note
Correct implementation of this macro requires that the output message is the same message as the received message.
|
|
%SourceParty%
|
Name of the source party from which the File adapter received the message.
Note
Correct implementation of this macro requires that the output message is the same message as the received message.
|
|
%SourcePartyQualifier%
|
Qualifier of the source party from which the File adapter received the message.
Note
Correct implementation of this macro requires that the output message is the same message as the received message.
|
|
%time%
|
UTC time in the format hhmmss.
|
|
%time.tz%
|
Local time plus time zone from GMT in the format hhmmssTZD (for example, 124525+530).
|
Other Resources
Restrictions When Configuring the File Adapter