Supported File Name Tokens

The system supports the following tokens:

${organizationId} - a unique identifier for the enterprise.
${organizationName} - the name of the enterprise. If any of the following reserved characters are used in location names, they are replaced with a dash (-) character: / ,\ ,| ,? ,* , < , > , : ," (double quote).
${orgShortName} - the three-character enterprise short name.
${orgLvlName} - the name of the organizational level the export is scheduled for.
${locationGroupName} - the name of the location group the export is scheduled for.
${locationId} - a unique identifier of the location included in the export. This token is not supported for combined locations exports.
${locationRef} - an identifier of the location included in the export. This token is not supported for combined locations exports.
${siteID} - an identifier of the location included in the export. This token is not supported for combined locations exports.
${locationName} - the name of the location included in the export. This token is not supported for combined locations exports. If any of the following reserved characters are used in location names, they are replaced with a dash (-) character: / ,\ ,| ,? ,* , < , > , : ," (double quote)
${timeZone} - the location’s timezone. This token is not supported for combined locations exports.
${country} - the country defined for the location included in the export. This token is not supported for combined locations exports.
${region} - the region defined for the location included in the export. This token is not supported for combined locations exports.
${businessDate} - the business date of the data included in the export.
${month} - the month of the business date of the data included in the export.
${week} - the week number of the business date of the data included in the export.
${startDate} & ${endDate} - start date and end date of the export run.
${startTime} & ${endTime} - start and end time of the export run.
${fileCreationDateTime} - the date and time the export file was created.
${fixedPeriod} - the quarter hour number of the data included in the export. This is applicable for real-time exports. The numbers are between 1 and 96, and start with 1 at 12:00 a.m. This token is not supported for combined locations exports.
${financialWeekNum} - the number of the financial week included in the export. This requires recurrence to be set to financial week or financial period. This token is not supported for combined locations exports.
${financialPeriodNum} - the number of the financial period included in the export. This requires recurrence to be set to financial week or financial period. This token is not supported for combined locations exports.
${counter-10000} - a counter that increases with every run of the schedule. Use for real-time exports or combined locations export to prevent overriding a previous export file on the destination server. Resets at 10000.
${dateCounter} - a counter that increments for the same day and resets at change of business date.
${dayCounter} - a counter that increments each day and resets when reaches 1000.
${numLocationsExported} - the number of locations included in this export file. This token is intended to be used for combined locations exports.
$(ttlNumOfScheduledLocations} - the total number of locations this export is scheduled for. This token is intended to be used for combined locations exports to indicate how many locations should be included in the file.

The ${businessDate}, ${startDate}, ${endDate}, ${startTime}, and ${endTime}, and ${fileCreationDateTime} tokens support the following date and time sub-tokens to customize date and time in the file name:

YYYY: four-digit year
YY: two-digit year
MM: two-digit month (examples: 01 for January, 02 for February)
MMM: three-character description of the month (examples: JAN, FEB, MAR)
DD: two-digit day of month (01 through 31)
hh: two digits of hour (00 through 23; do not use am and pm values)
mm: two digits of minute (00 through 59)
ss: two digits of second (00 through 59)

The following examples show valid token and sub-token combinations:

${businessDate(YYYY-MMM-DD)}
${startDate(MMM-DD)}
${startTime(hh:mm:ss)}
${endTime(YYYY-MMM-DDThh:mm:ss)}