File Name Patterns

A file name pattern defines the format of the file name. The default pattern is ICL.%PT%.R%PID1-4%.N%PID5-8%.D%DTyyMMdd%.T%DThhmmss%. The pattern is as follows:
  • ICL: hard coded
  • %PT%: a substitution pattern to designate the file with a T for a test file or a P for a production file (this comes from the test file indicator in Partner Profiles)
  • R: hard coded
  • %PID1-4%: a substitution pattern that substitutes the first four digits of the Partner ID
  • N: hard coded
  • %PID5-8%: a substitution pattern that substitutes digits five through eight of the Partner ID
  • D: hard coded
  • %DTyyMMdd%: a substitution pattern that substitutes the current date. Various formats are allowed for the date; refer to Table 1 for additional details.
  • T: hard coded
  • %DThhmmss%: a substitution pattern that substitutes the current time. Various formats are allowed for the time; refer to Table 1 for additional details.
Table 1. File Pattern Substitution Values
Pattern Description
%PT% Substitutes the test file indicator defined in the Partner Profiles transmission definition.
%PID% Substitutes a range of digits in the Partner ID. For example, %PID1-5% denotes that the first five digits of the Partner ID should be substituted.
%DT% Substitutes the Date/Time. The DT should be followed by the date/time substitution pattern. Valid patterns include all those supported by the SimpleDateFormatter Java™ class. Refer to Table 2 for accepted values and examples.
%FIM% Substitutes the file ID modifier. When multiple files are generated for the same partner at the same hour and minute, the file ID modifier field in the Type 01 record is given a unique value. This variable allows the user to include the file ID modifier value as part of the generated file name.
%ORIGINFN% Original file name. This is used by the inbound and outbound Archive Extract tasks.
Note: The user should always specify a Date/Time substitution variable (%DT%) to ensure a unique name is generated. If a date and time substitution variable is not supplied, a generated file for a specific bank will have the same file name as a file for the same bank generated on the same day.
The Date/Time substitution variable (%DT%) allows numerous formats for the date and time. The values entered for the date and time are validated using the Java SimpleDateFormat class. Table 2 shows some of the more common values.
Table 2. Date and Time Substitution Variable - Pattern Specification
Letter/Time Values Description Example
y Year yyyy=2020; yy=20
M Month of the year MMMM=July; MMM=Jul; MM=07
D Day of the year DDD=189
d Day of the month dd=10
a AM/PM marker a=PM or a=AM
H Hour of the day (0-23) HH=00
k Hour of the day (1-24) kk=24
K Hour in AM/PM (0-11) K=0; KK=00
h Hour in AM/PM (1-12) hh=12
m Minutes (0-59) mm=30
s Seconds (0-59) ss=55
S Milliseconds SSS=978
Note:
  • The date format <yymmdd> would be specified as %DTyyMMdd%.
  • The time format <hhmm> would be specified as %DThhmm%.
Example using the default naming pattern:
  • Partner ID is 123456789
  • Test file indicator is set to T.
The file name of the file generated at 1:17:34:234 PM on October 24, 2008, using the default pattern of:
ICL.%PT%.R%PID1-4%.N%PID5-8%.D%DTyyMMdd%.T%DThhmmss%

would be:
ICL.T.R1234.N5678.D081024.T131734.