File name patterns

A file name pattern is used to define the format of a file name.

The default pattern is ICL.%PT%.R%PID1-4%.N%PID5-8%.D%DTyyMMdd%.T%DThhmmss%. The parts of the pattern are described in the following list.

ICL: This part of the pattern is hardcoded.
%PT%: This substitution pattern is used to indicate whether the file is a test file or a production file. For test files, this pattern is replaced with a T. For production files, it is replaced with a P. The value comes from the test file indicator in the transmission definition.
R: This part of the pattern is hardcoded.
%PID1-4%: This substitution pattern substitutes the first 4 digits of the participant ID.
N: This part of the pattern is hardcoded.
%PID5-8%: This substitution pattern substitutes digits 5-8 of the participant ID.
D: This part of the pattern is hardcoded.
%DTyyMMdd%: This substitution pattern substitutes the current date. Various formats are allowed for the date. For more information, see Date and time pattern specifications.
T: This part of the pattern is hardcoded.
%DThhmmss%: This substitution pattern substitutes the current time. Various formats are allowed for the time. For more information, see Date and time pattern specifications.

For example, the default file name pattern can be used to create a file name for a generated file that has the following characteristics.

The participant ID is 123456789.
The test file indicator is T.
The time that the file was generated is 1:17:34:234 PM.
The date that the file was generated is 24 October 2008.

The file name that is used for this file is ICL.T.R1234.N5678.D081024.T011734.

Substitution variables for file name patterns

The following table shows the substitution variables that you can use to define file name patterns.

Table 1. Substitution variables for the file name pattern
Pattern	Description
`%PT%`	Substitutes the test file indicator that is defined in the transmission definition.
`%PID%`	Substitutes a range of digits in the participant ID. For example, `%PID1-5%` denotes that the first five digits of the participant ID are substituted for the pattern.
`%PNAME%`	Substitutes a range of characters in the participant name. For example, `%PNAME1-5%` denotes that the first five characters of the participant name are substituted for the pattern.
`%DT%`	Substitutes the date and time. The `DT` needs to be followed by the date and time substitution pattern to use. For accepted values and examples, see Date and time pattern specifications.
`%BD%`	Substitutes the business date. The `BD` needs to be followed by the date and time substitution pattern to use for the business date. For accepted values and examples, see Date and time pattern specifications.
`%C%`	Substitutes the business cycle.
`%FIM%`	Substitutes the file ID modifier. When multiple files are generated for the same participant at the same hour and minute, the file ID modifier field in the Type 01 record is given a unique value. You can use this variable to include the file ID modifier value as part of the generated file name.
`%ORIGINFN%`	Original file name. This name is used by the inbound and outbound archive tasks.
`%CLID%`	Substitutes the cash letter ID of the first batch (ICL) in the file.
`%CD%`	Substitutes the custom descriptor field of the transmission definition. If you want a subset of the custom descriptor, the `CD` needs to be followed by the range of digits that defines the subset that you want. For example, `%CD1-5%` denotes that the first 5 characters of the custom descriptor are substituted for the pattern.

Note: Always use the date and time substitution variable (%DT%) to make sure that a unique name is generated. If a date and time substitution variable is not supplied, a generated file for a specific bank has the same file name as a file for the same bank that is generated on the same day.

Date and time pattern specifications

The date and time substitution variable (%DT%) allows numerous formats for the date and time. Valid patterns include all patterns that the Java™ SimpleDateFormat class supports. Some of the more common values are shown in the following table.

Table 2. Date and time substitution variable - pattern specification
Pattern value	Description	Examples
`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`

Notes:

The file name pattern for date format yymmdd is specified as %DTyyMMdd%.
The file name pattern for time format hhmm is specified as %DThhmm%.