Designating the File Name

The file is built in the folder designated by the transmission creation root transmission property in the Distribution user interface. The name of the file is formulated using the file pattern as specified in the file pattern transmission property in the Distribution user interface or the file pattern value in the Partner Profiles transmission definition. The transmission definition value, if specified, overrides the Distribution user interface transmission property value. The file pattern defines the format of the file name. The default pattern is:

ICL.%PT%.R%PID1-4%.N%PID5-8%.D%DTyyMMdd%.T%DThhmmss%

where:

ICL: is hard-coded
%PT%: is a substitution pattern that used the test file indicator from the Partner Profiles transmission definition. It is usually T for a test file or P for a production file.
R: is hard-coded
%PID1–4%: is a substitution pattern that substitutes the first 4 digits of the partner ID
N: is hard-coded
%PID5–8%: is a substitution pattern that substitutes digits 5 through 8 of the partner ID
D: is hard-coded
%DTyyMMdd%: is a substitution pattern that substitutes the current date. Various formats are allowed for the date; refer to Table 1 for additional details.
T: is hard-coded
%DThhmmss%: is 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 Substitutable Values
Pattern	Description
%PT%	Substitutes the test file indicator as defined in the Partner Profiles transmission definition
%PID%	Substitutes the partner ID. If a subset of the partner ID is desired, PID should be followed with the range of digits from the partner ID that is desired. For example, %PID1–5% denotes the first 5 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 for examples.
%FIM%	Substitutes the File ID Modifier. To ensure multiple files generated for the same partner at the same hour and minute are distinguishable, 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.
%ORT%	Substitutes the bank routing number. If a subset of the routing number is needed, specify the range of digits to be used following the ORT substitutable value. For example, %ORT1–5% indicates that the first 5 digits of the routing number should be substituted.

Note: The user should always specify a Date/Time substitution variable (%DT%) to ensure a unique name is generated. If a Date/Time substitution variable is not supplied, it is likely that name clashes will occur when multiple transmissions are generated throughout the day, destined for the same institution.

The Date/Time substitution variable (%DT%) allows numerous formats for the date and time. The user may enter any values that are valid according to the Java SimpleDateFormatter class. Table 2 shows some of the more common values:

Table 2. Date and Time Substitution Variable - Pattern Specification
Letter/Time Values	Description	Examples
y	Year	yyyy=2008; yy=08
M	Month in year	MMMM=July; MMM=Jul; MM=07
D	Day in year	DDD=189
d	Day in month	dd=10
a	AM/PM marker	a=PM or a=AM
H	Hour in day (0–23)	HH=00
k	Hour in 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	Minute in hour	mm=30
s	Second in minute	ss=55
S	Millisecond	SSS=978
Note: The date format <yymmdd> would be specified as %DTyyMMdd%. The time format <hhmm> would be specified as %DThhmm%.

Example

Partner ID = 123456789
Test File Indicator is set to "T".
The file name of the transmission 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
```

If additional flexibility is needed, other than what the above pattern substitution allows, use the modifyFilename() method in the UserModifyRecord user exit to change the name to a more suitable value. For details on the user exit, see Record Creation and Modification User Exit.

The default file pattern for Canadian ICL is:

%PID7-9%%PID6-6%-%ORT7-9%%ORT6-6%-%REG%.ICP%PID2-2%.%CUR%%DTyyyyMMdd%.%ENVR%.%FILENUM%

where:

%PID7–9%

is a substitution pattern that substitutes digits 7 through 9 of the partner ID

%PID6–6%

is a substitution pattern that substitutes the sixth digit of the partner ID

%ORT7–9%

is a substitution pattern that substitutes digits 7 through 9 of the bank routing number

%ORT6–6%

is a substitution pattern that substitutes the sixth digit of the bank routing number

%REG%

is a substitution pattern that substitutes the region code that is set by the Canadian ICL record modification user exit

ICP

is hard-coded

%PID2–2%

is a substitution pattern that substitutes the second digit of the partner ID

%CUR%

is a substitution pattern that substitutes the currency code that is set by the Canadian ICL record modification user exit

%DTyyyyMMdd%

is a substitution pattern that substitutes the current date. Various formats are allowed for the date; refer to Table 1 for additional details.

%ENVR%

is a substitution pattern that substitutes the environment code that is set by the Canadian ICL record modification user exit. Valid values are:

T: TEST
P: PROD
G: TRNG
D: DEVE

%FILENUM%

is a substitution pattern that substitutes the file sequence number only when the file definition indicates that the file sequence number is required

The Canadian ICL file pattern substitution uses values from the modifyFilename() method in the CADUserModifyRecord user exit to change the name to a more suitable value. For more information about the user exit, see Canadian ICL Record Modification User Exit.