GrandBackup

Using variables in folder and file names

You can enter variables as parts of folder names in Source, Destination, Versions Archive, Deleted Archive folders, or archive file name. GrandBackup expands these variables to the corresponding values when it runs the backup Task. There are three types of variables: Built-in variables, Windows Special Folders and Environment variables. Variable names must be enclosed in % signs (for example: %var%).

Tip

Note:
All variables are case-insensitive. You can type them all in uppercase "%SOURCE%", combined uppercase and lowercase "%Source%", or all in lowercase characters "%source%". The result will be the same.


Built-in Variables

The following variables expand to their corresponding values when the Task is run.

Variable Name:

Description:

Source

The Source folder full path *, ***

SourceTop

Only the rightmost folder name of the Source folder full path *, ***

SourceExcludeRoot

The Source folder full path without the root *, ***

SourceRoot

The drive portion of the path specified in Source (drive letter or UNC server root). **, ***

Destination

The Destination folder full path *

DestinationTop

Only the rightmost folder name of the Destination folder full path *

DestinationExcludeRoot

The Destination folder full path without the root *

DestinationRoot

The drive portion of the path specified in Destination (drive letter or UNC server root). **

VersionsArchive

The File Versions Archive folder full path *

DeletedArchive

The Deleted Files Archive folder full path *

ComputerName

Name of the computer GrandBackup is running on

UserName

Name of the logged-in user

TaskName

Task Name *

TaskId

Task ID (a 21-character code, unique for each Task) *


      * Values as in Task Properties.
      ** For local folders with drive letters, the result is in the form ô<drive>ö. For folders with a UNC path the result is in the form ô\\<servername>\<sharename>ö. If the given source path contains neither style of path prefix, the result is an empty string.
      *** If you have multiple Source folders in your Backup task - you can access specific folder by adding a number representing this folder order in list. For example: %Source1%, %SourceTop2%, %SourceRoot2%, etc.

      Examples:
       If Source is "c:\Documents and Settings\Mike\" then in Destination you can type something like "g:\Backup\%SourceExcludeRoot%", which expands to "g:\Backup\Documents and Settings\Mike\").
       If Source is "c:\Documents and Settings\Mike\" then in Destination you can type something like "g:\Backup\%SourceTop%", which expands to "g:\Backup\Mike\").


DateTime

Date and time as YYYYMMDDHHMMSS

Date

Date as YYYYMMDD

Year

Year as a 4-digit number

Month

Month as a 2-digit number

Day

Day as a 2-digit number

Time

Time as HHMM

Hour

Hour as a 2-digit number

Min

Minutes as a 2-digit number

Sec

Seconds as a 2-digit number

MonthOfYearStr

Month as a short name (Jan, Feb, Mar, etc.)

MonthOfYearString

Month as a full name (January, February, March, etc.)

WeekOfYear

Week of the year number *

WeekOfMonth

Week of the month number *

WeekDayStr

Day of the week as a short name (Mon, Tue, Wed, etc.)

WeekDayString

Day of the week as a full name (Monday, Tuesday, Wednesday, etc.)

WeekDayNum

Day of the week number *

DayOfYear

Number of days from December 31st of the previous year

DayOfWeek

Day of the week number *

HourOfYear

Number of hours from 12:00 AM of the first day of the year

HourOfWeek

Number of hours from 12:00 AM of the first day of the week *

HourOfMonth

Number of hours from 12:00 AM of the first day of the month

MinuteOfYear

Number of minutes from 12:00 AM of the first day of the year

MinuteOfMonth

Number of minutes from 12:00 AM of the first day of the month

MinuteOfWeek

Number of minutes from 12:00 AM of the first day of the week *

MinuteOfDay

Number of minutes from 12:00 AM of the same day

SecondOfYear

Number of seconds from 12:00:00 AM on the first day of the year

SecondOfMonth

Number of seconds from 12:00:00 AM on the first day of the month

SecondOfWeek

Number of seconds from 12:00:00 AM of the first day of the week *

SecondOfDay

Number of seconds from 12:00:00 AM of the same day

      * GrandBackup defines the week according to the ISO 8601 standard, i.e. the week starts on Monday and ends on Sunday.

      Example:
       On December 31st 2002, the folder name "C:\Backup\%Date%" will expand to "C:\Backup\20021231".


Windows Special Folders
The following variables expand to their corresponding values when the Task is run.

Variable Name:

Description:

WindowsDesktop

Desktop Folder *

WindowsInternet

Internet Folder

WindowsPrograms

Path to "Start -> Programs" menu *

WindowsControls

WindowsControls

WindowsPrinters

WindowsPrinters

WindowsPersonal

Path to "My Documents" folder *

WindowsFavorites

Path to "Favorites" folder *

WindowsStartup

Path to "Start -> Programs -> Startup" menu *

WindowsRecent

Path to "Recent" folder *

WindowsSendto

Path to "Send To" folder *

WindowsBitbucket

WindowsBitbucket

WindowsStartMenu

Path to "Start" menu *

WindowsDesktopDirectory

Path to "Desktop" folder *

WindowsDrives

WindowsDrives

WindowsNetwork

WindowsNetwork

WindowsNethood

WindowsNetwork

WindowsFonts

Path to Window's "Fonts" folder (usually "C:\WINDOWS\Fonts")

WindowsTemplates

WindowsTemplates

WindowsCommonStartMenu

WindowsCommonStartMenu

WindowsCommonPrograms

WindowsCommonPrograms

WindowsCommonStartup

WindowsCommonStartup

WindowsCommonDesktopDirectory

WindowsCommonDesktopDirectory

WindowsAppData

WindowsAppData

WindowsPrinthood

WindowsPrinthood

WindowsAltStartup

WindowsAltStartup

WindowsCommonAltStartup

WindowsCommonAltStartup

WindowsCommonFavorites

WindowsCommonFavorites

WindowsInternetCache

WindowsInternetCache

WindowsCookies

WindowsCookies

WindowsHistory

WindowsHistory

* A different value for each Windows user


Environment Variables

These variables expand to their corresponding Windows environment values.

%VAR% Value of the environment variable VAR.

Example:
       On a Windows NT/2000/XP system on a network, the folder name %USERPROFILE% may expand to C:\Documents and Settings\Administrator.

Tip

Tip:
You can add your own variables or list current environment variables using Windows "SET" command. See Windows Help for details.


See also:
      Command-Line Options


GrandBackup is a product of Regall LLC dba ObjectRescue.com.
Copyright ⌐ 1996-2007 Regall LLC dba ObjectRescue.com. All rights reserved.