When, Group Only

<< Click to Display Table of Contents >>

Navigation:  Using SyncBackPro > Expert Mode >

When, Group Only

 

A profile that is in a group can be set so that it can only be run as part of that group or group queue. This stops the profile from being run on its own by accident, for example by its own schedule or a hot-key. These settings were introduced in V12.1.26.0.

 

This is useful when a profile depends on another profile in the same group being run first. For example, the first profile in a group may create a database dump and the second profile backs it up. If the second profile was run on its own then it would back up an old (or missing) database dump. It is also useful if you use a group to back up the same files to several destinations, with one profile per destination.

 

These settings are only available for profiles, not for groups. This page is shown in Expert Mode, and in Easy Mode only if one of the options is ticked. The settings are a safeguard against mistakes, not a security feature: anyone who can modify the profile can untick them.

 

•Only allow the profile to be run as part of a group: If this option is ticked then the profile is only run when a group it is in is run. This includes when that group is inside another group that is run.

 

•Only allow the profile to be run as part of a group queue: If this option is ticked then the profile is only run when a group queue it is in is run. If both this option and the option above are ticked then the profile can be run as part of either a group or a group queue. If only one of them is ticked then the other kind is not allowed. For example, a profile that can only be run as part of a group queue is not run if it is in a standard group and that group is run.

 

•Allow the profile to be run as part of a visual group (via the main interface): In the main window, a profile that is in a group is shown under that group, and you can select it there and run it on its own. Only that profile is run, not the group, but it uses the settings (e.g. variables) of the group it is shown under. This is called a visual group, and the -vgn command line parameter does the same thing. If this option is not ticked then a profile started this way is not run. If it is ticked then the profile can be run this way, but only from under the right kind of group: under a group if the first option is ticked, and under a group queue if the second option is ticked. This option is not ticked by default, and it can only be ticked if one of the options above is ticked.

 

When the profile is not run

 

If one of the options is ticked then the profile is not run if it is started in any other way, for example:

 

•By its own schedule

•When a hot-key is pressed

•On login or logout of Windows, or on shutdown

•When a device is inserted, periodically, or when changes are detected

•When the display powers off or a screen saver starts

•When SyncBack Touch starts, or from SyncBack Monitor

•From the tray icon menu

•From the command line without the -vgn parameter

 

This applies to every kind of run: a normal run, a simulated run, a restore and an integrity check.

 

When the profile is not run because of these settings:

 

•The last result of the profile is Not Run (Group Only). This counts as a failed run, so if the profile is configured to send an email, Pushover notification or webhook when it fails then it does so. This is different from a disabled profile, which does not send an email.

•If someone is using SyncBack then a message is shown explaining why, e.g. The profile can only be run as part of a group. If the profile was run from under a group in the main window (or with -vgn) then the message also says that it cannot be run on its own from under a group, and that you should run the whole group instead.

•If the profile was run from the command line then the exit code is -116. In scripts, the result is ELR_GroupOnly (see Script Constants).

 

If a profile in a group is not run because of these settings (for example, a profile that can only be run as part of a group queue is in a standard group) then it is treated the same as any other profile in the group that fails.

 

Warnings

 

When you tick one of the options, SyncBack may warn you about the following. You can still save the profile.

 

•The profile is not in any group or group queue, so it cannot be run until it is added to one.

•The profile is also set to be run on its own, e.g. by a hot-key or when a device is inserted. Those runs will now not be allowed.

•The profile has its own schedule. Those scheduled runs will now not be allowed, because they are not part of a group. You are asked if you want to delete the schedule.

 

When you click OK or Apply in the settings of a group or group queue, SyncBack warns you if it contains profiles that would not be run. When saving a group, it lists the profiles that can only be run as part of a group queue. When saving a group queue, it lists the profiles that can only be run as part of a group. A profile that has both options ticked is never listed. The group or group queue is still saved.

 

 

All Content: 2BrightSparks Pte Ltd © 2003-2026