Set System Variable

 Content Previous Next

Topic Content

Windows Environmental Variable

Additional File Filter

Miscellaneous

 

 

This option defines action properties for setting up a Windows Environmental Variable which can be permanently set and placed in Windows list of Environmental Variables.

 

 

Windows Environmental Variable

General

Environment variables are a set of strings that can affect the way Windows applications and system processes behave on a computer. The strings may contain information about drive, path, filename, etc. For example:

 

DATE expands to the current date. The date is displayed according to the current user's date format preferences.

 

TIME points to the current time. The time is displayed according to the current user's time format preferences.

 

AppData Contains the full path to the Application Data folder.

 

ProgramFiles points to Program Files directory. The default value is 'C:Program Files'.

 

CommonProgramFiles points to Common Files directory. The default is 'C:Program FilesCommon Files'.

 

SystemDrive the drive upon which the system folder is located.

 

USERNAME displays the active users login.

 

WinDir points to the Windows directory.

 

When you set the same environmental variable twice, the most recent value will be used replacing any previous value.

 

More information about environment variables find in the Windows help documentation.

Format

The format of environmental variable in AnyFileBackup should be [Variable name]=[Variable value]. You can set any variable name. No space symbols are allowed.

 

You may use ${ENVGET} macros to recall environmental variables that you have created. Read more about Macro strings.

 

Examples:

 

TASKNAME=Replication-over-LAN

 

ANYFILEBACKUPHOME=www.any-file-backup.com

 

 

Additional File Filter

This option is visible and applies if, and only if, the action is a PART of the Backup step of the Task Scenario.

 

Additional File Filter distinguishes files by mask determining to which file(s) this particular action will or will not apply. In all other respects it is no different from the Additional File Filter that exists in every Target.

Included files

A list of file masks that describe files to which this particular action will apply.

 

Please note, that these masks should somehow overlap with masks specified in SOURCE > Additional File Filter > Included Files (if in use) and should not be completely excluded by masks specified in SOURCE > Additional File Filter > Included Files (if in use). Otherwise, this action will not apply to any files.

Excluded files

A list of file masks that describe files to which this particular action will not apply.

 

 

Miscellaneous

Condition

This option is visible and applies if, and only if, the action is located BELOW the Backup, Two-Way Synchronization, Monitoring, or Clean-up step of the Task Scenario.

 

This is a description of an event upon occurrence of which this action will be performed. The event relates either to Source or to task generally. The following events are covered:

 

'Always': action is event-neutral and will always start when AnyFileBckup reaches it at the Task Scenario.

 

'Success': the term 'success' refers to successful completion of either:

-- Backup stage (all files have been transferred from Source to Target(s) and other actions within Backup have been performed), or

-- Two-Way Synchronization stage (Source 1 and Source 2 have been synchronized), or

-- Monitoring stage (Source parameters that are being monitored are exceeded their threshold limits or relevant changes have occurred).

 

When any of these stages is completed properly (depending on the task type), action with this condition will perform.

 

'Error': action will start when task has not performed properly and produced an error. This error may occur at any previous stage of task scenario. Please note that this action will only work if task 'on error' behaviour is set to 'continue task execution' (see Task error handling for details), otherwise this action will not start. It is also recommended put action with this condition at the end of the task scenario, so it can catch any errors that have occurred in a course of task performance.

 

'No changes': this condition is the opposite to the 'Success'--when nothing happens at any of the stages described above: no files have been transferred between Source and Target(s), Source parameters that are being monitored are within their threshold limits or no relevant changes have occurred.
Enabled

If enabled, this action is active and will be used in Scenario. If disabled, it will remain in the Task Scenario but will be completely ignored by task. To distinguish it from enabled actions, disabled actions are strokeout and coloured in gray.

Title

This is a custom name that will be displayed in the Task Scenario instead of the default title. Press the 'Apply' button for changes to take effect.

 Content Previous Next