File Name Tokens List
The following table lists the File Name Tokens, their respective definitions, and their generated values.
| Token | Definition | Generated Value (Examples) |
|---|---|---|
| SYYYY | Year | 0000 - 9999 |
| SYYY | Year | 000 - 999 (last 3 digits of year) |
| SYY | Year | 00 - 99 (last 2 digits of year) |
| SY | Year | 0 - 9 (last 1 digit of year) |
| SMON | Month of Year | JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC |
| SMon | Month of Year | Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec |
| Smon | Month of Year | jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec |
| SMONTH | Month of Year | JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER |
| SMonth | Month of Year | January, February, March, April, May, June, July, August, September, October, November, December |
| Smonth | Month of Year | january, february, march, april, may, june, july, august, september, october, november, december |
| SMM | Month of Year | 01 - 12 |
| SM | Month of Year | 1 - C |
| Sm | Month of Year | 1 - c |
| SDD | Day of Month | 01 - 31 |
| SD | Day of Month | 1 - 9, A - V |
| Sd | Day of Month | 1 - 9, a - v |
| SJ | Julian Day of Year | 001 - 366 |
| SHH24 | 24 Hour | 00 - 23 |
| SH24 | 24 Hour | 0 - 9, A - N |
| Sh24 | 24 Hour | 0 - 9, a - n |
| SHH12 | 24 Hour | 01 - 12 |
| SH12 | 24 Hour | 1 - C |
| Sh12 | 24 Hour | 1 - c |
| SMI | Minute of Hour | 00 - 59 |
| SSS | Second of Minute | 00 - 59 |
| SMS | Milliseconds of Second | 000 - 999 |
| SAP | AM/PM | AM, PM |
| SAp | AM/PM | Am, Pm |
| Sap | AM/PM | am, pm |
| SWWW | Weekday | SUN, MON, TUE, WED, THU, FRI, SAT |
| SWww | Weekday | Sun, Mon, Tue, Wed, Thu, Fri, Sat |
| Swww | Weekday | sun, mon, tue, wed, thu, fri, sat |
| SWEEKDAY | Weekday | SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY |
| SWeekday | Weekday | Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday |
| SW1 | Weekday 1 based | 1 - 7 |
| SW0 | Weekday 0 based | 0 - 6 |
| AllocationPrimary | The primary allocation size used in a file transfer. | Local file: c:\source\testfile1.txt
Remote file: CFUSR.F$(AllocationPrimary).TEST Token resolves to: CFUSR.F800.TEST |
| AllocationSecondary | The secondary allocation size used in a file transfer. | Local file:
c:\source\testfile1.txt
Remote file: CFUSR.F$(AllocationSecondary).TEST Token resolves to: CFUSR.F500.TEST |
| AllocationType | The allocation type used in a file transfer. | Resolves to: Tracks, Blocks, Cylinders, Megabytes, Kilobytes |
| BlockSize | The block size used in a file transfer. | Local file:
c:\source\testfile1.txt
Remote file: CFUSR.F$(BlockSize).TEST Token resolves to: CFUSR.F6,160.TEST |
| CheckPointInterval | The check point used in a file transfer. | Local file:
c:\source\testfile1.txt
Remote file: d:\target\test$(CheckPointInterval).txt Token resolves to: d:\target\test5 minutes.txt |
| Compression | The compression used in a file transfer. | LZ, RLE, or NO |
| ComputerName | The initiator computer name. | Local file:
c:\source\testfile1.txt
Remote file: d:\target\$(ComputerName).txt Token resolves to: d:\target\SYSTEM3032.txt |
| CrLf | Whether a carriage return line feed (CRLF) is used in a file transfer. | TRUE, FALSE |
| DataClass | The data class used in a file transfer to z/OS. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(DataClass).FILE1 Token resolves to: PRJOE.DTCLS3.FILE1 |
| DataType | The data type used in a file transfer. | BINARY, EBCDIC |
| Date1 | The days date formatted as YYYYMMDD. | Local file:
c:\source\test.txt
Remote file: d:\target\$(Date1)\test.txt Token resolves to: d:\target\20110809\test.txt |
| Date2 | The days date formatted as MMDDYYYY. | Local file:
c:\source\test.txt
Remote file: d:\target\$(Date2)\test.txt Token resolves to: d:\target\08092011\test.txt |
| Date3 | The days date formatted as DDMMYYYY. | Local file:
c:\source\test.txt
Remote file: d:\target\$(Date3)\test.txt Token resolves to: d:\target\09082011\test.txt |
| Destination | The IP address or host name of the final destination for a file being transferred. | Local file:
c:\source\testfile1.txt
Remote file: d:\target\file1.$(Destination).txt Token resolves to: d:\target\file1.192.168.10.1.txt |
| FileAvailability | The file availability used in a file transfer. | IMMEDIATE, DEFERRED |
| LocalDomain | The local domain. | A remote file name contains the local domain name. |
| LocalFile | The complete local file path. | Local file:
c:\source\testfile1.txt
Remote file: $(LocalFile) Token resolves to: c:\source\testfile1.txt |
| LocalFileBase | The local file name only. | Local file:
c:\source\directory\testfile1.txt
Remote file: $(LocalFileBase) Token resolves to: testfile1 (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| LocalFileExt | Only the extension of the local file is used. | Local file:
c:\source\directory\testfile1.txt
Remote file: $(LocalFileExt) Token resolves to: txt (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| LocalFileName | The local file name including the extension is used. | Local file:
c:\source\directory\testfile1.txt
Remote file: $(LocalFileName) Token resolves to: testfile1.txt (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| LocalFilePath | The local file path without the file name is used. | Local file:
c:\source\directory\testfile1.txt
Remote file: $(LocalFilePath) Token resolves to: c:\source\directory |
| LocalPathWODrive | The local file path without the drive letter or file is used. | Local file:
c:\source\directory\testfile1.txt
Remote file: $(LocalPathWODrive) Token resolves to: source\directory (File transferred to the MFT Platform Server Windows Directory unless a drive letter is configured.) |
| LocalUserId | The local user ID used in a file transfer. | Local User Id:
TESTLAB\cfuser1
Local file: c:\source\directory\testfile1.log Remote file: d:\target\file1$(LocalUserId).txt Token resolves to: d:\target\file1cfuser1.txt |
| MgmtClass | The management class used when a file is transferred to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(MgmtClass).FILE1 Token resolves to: PRJOE.MGCLS12.FILE1 |
| NoLocalFileBase | The base name of a local file is not used in the file name on a send. | Local file:
c:\source\directory\a.b.c.txt
Remote file: c:\target\$(NoLocalFileBase) Token resolves to: b.c.txt |
| NoLocalFileExt | The extension name of a local file is not used in the file name on a send. | Local file:
c:\source\directory\a.b.c.txt
Remote file: c:\target\$(NoLocalFileExt) Token resolves to: a.b.c |
| NoRemoteFileBase | The base name of a remote file is not used in the file name on a receive. | Local file:
c:\target\$(NoRemoteFileBase)
Remote file: c:\source\directory\a.b.c.txt Token resolves to: b.c.txt |
| NoRemoteFileExt | The extension name of a remote file is not used in the file name on a receive. | Local file:
c:\target\$(NoRemoteFileExt)
Remote file: c:\source\directory\a.b.c Token resolves to: b.c.txt |
| NotifyUser | The remote user name configured to be notified in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(NotifyUser).txt Token resolves to: d:\target\file1JohnD.txt |
| NotifyUserType | The type of notification used for the remote user notification in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(NotifyUserType).txt Token resolves to: d:\target\file1Windows.txt (Windows, None, TSO, ROSCOE, Email) |
| PortNumber | The port number used in the file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(PortNumber).txt Token resolves to: d:\target\file146,464.txt |
| PrinterName | The printer name used in a file to print. | <text> |
| Priority | The priority set in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(Priority).txt Token resolves to: d:\target\file1Normal.txt |
| ProcessName | The process name configured in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(ProcessName).txt Token resolves to: d:\target\file1CyberFus.txt |
| RecordFormat | The record format used in a file transfer. | FIXED, BLOCKED, FIXED BLOCKED, VARIABLE, VARIABLE BLOCKED, UNDEFINED |
| RecordLength | The record length used in a file transfer. | Local file:
c:\source\testfile1.txt
Remote file: CFUSR.F$(RecordLength).TEST Token resolves to: CFUSR.F80.TEST |
| RemoteDomain | The remote domain used in a file transfer. | A remote file name contains the remote domain name. |
| RemoteFile (token used during a receive) | The complete remote file path. | Local file:
$(RemoteFile)
Remote file: c:\source\testfile1.txt Token resolves to: c:\source\testfile1.txt |
| RemoteFileBase (token used during a receive) | The remote file name only. | Local file:
$(RemoteFileBase)
Remote file: c:\source\directory\testfile1.txt Token resolves to: testfile1 (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| RemoteFileExt (token used during a receive) | Only the extension of a remote file is used. | Local file:
$(RemoteFileExt)
Remote file: c:\source\directory\testfile1.txt Token resolves to: txt (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| Remote filename (token used during a receive) | The remote file name including the extension is used. | Local file:
$(RemoteFileName)
Remote file: c:\source\directory\testfile1.txt Token resolves to: testfile1.txt (File transferred to the MFT Platform Server Windows Directory unless a path is configured.) |
| RemoteFilePath (token used during a receive) | The remote file path without the file name is used. | Local file:
$(RemoteFilePath)
Remote file: c:\source\directory\testfile1.txt Token resolves to: c:\source\directory |
| RemotePathWODrive (Token used during a receive) | The remote file path without the drive letter or file name used. | Local file:
$(RemotePathWODrive)
Remote file: c:\source\directory\testfile1.txt Token resolves to: source\directory (File transferred to the MFT Platform Server Windows Directory unless a drive letter is configured.) |
| RemoteTransactionNumber | The remote transaction number used in a file transfer. | Local file:
d:\fn\$(RemoteTransactionNumber).txt
Remote file: c:\source\directory\testfile1.txt Token resolves to: d:\fn\ |
| RemoteUserId | The remote user ID used in a file transfer. | Remote user ID:
TEST\cfuser1
Local file: c:\fn\file1.$(RemoteUserId).txt Remote file: c:\source\directory\testfile.txt Token resolves to: c:\fn\file1.cfuser1.txt |
| StorageClass | The storage class used during a file transfer to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(StorageClass).FILE1 Token resolves to: PRJOE.STANDARD.FILE1 |
| SysoutClass | The SYSOUT class used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(SysoutClass).FILE1 Token resolves to: PRJOE.A.FILE1 |
| SysoutCopies | The amount of SYSOUT copies used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.TS$(SysoutCopies).FILE1 Token resolves to: PRJOE.TS2.FILE1 |
| SysoutDestination | The SYSOUT destination used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: HST.$(SysoutDestination).FILE1 Token resolves to: HST.NYPRINTER.FILE1 |
| SysoutFcb | The SYSOUT FCB used during a file to print to a z/OS system | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(SysoutFcb).FILE1 Token resolves to: PRJOE.STD2.FILE1 |
| SysoutForms | The SYSOUT forms used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(SysoutForms).FILE1 Token resolves to: PRJOE.INVC.FILE1 |
| SysoutUserId | The SYSOUT user name used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(SysoutUserId).FILE1 Token resolves to: PRJOE.MVSUSER1.FILE1 |
| SysoutWriter | The SYSOUT writer used during a file to print to a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(SysoutWriter).FILE1 Token resolves to: PRJOE.WRITER1.FILE1 |
| TransactionNumber | The local transaction number used in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\f$(TransactionNumber).txt Token resolves to: d:\target\fI331600053.txt |
| TransferFunction | The transfer function used in a file transfer. | SEND, RECEIVE |
| TransferId | The transfer ID assigned to a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1.$(TransferId).txt Token resolves to: d:\target\file1.d1544fd2-5fb7-4ce6-a717-ac8907697e4f.txt |
| TransferWork | The type of a transfer being done. For example, file to file, file to job, and so on. | F-FILE, J-JOB, P-PRINT |
| TryCount | The try count used in transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(TryCount).txt Token resolves to: d:\target\file13 Times.txt |
| Unit | The unit used for a transfer to and from a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(Unit).FILE1 Token resolves to: PRJOE.SYSDA.FILE1 |
| UserData | The user data name used in a file transfer. | Local file:
c:\source\directory\testfile1.txt
Remote file: d:\target\file1$(UserData).txt Token resolves to: d:\target\file1MyUserData.txt |
| VolSer | The volume used for a transfer to and from a z/OS system. | Local file:
c:\source\directory\testfile1.txt
Remote file: PRJOE.$(VolSer).FILE1 Token resolves to: PRJOE.CFP101.FILE1 |
| WriteMode | The write mode used in a file transfer. | C, R, A, CR, CA, CN |