Skip to main content

Conditions - Main Settings​

The Main settings tab is the first tab of the Add/Update condition set window. Use it to name a Condition Set and to choose whether the Server logs each evaluation of the set in detail. The detailed log helps when a Job or Task that uses the set runs, skips or stops in a way you do not expect.

To open the window, go to Server -> Global objects -> Conditions. In the Manage Conditions window, do one of the following:

  • Click Add on the Condition set toolbar to create a Condition Set
  • Select a Condition Set and click Edit, or double-click the Condition Set row
  • Select a Condition Set and click Clone to create a copy of it

The same commands are on the shortcut menu that opens when you right-click a Condition Set row. The Conditions tab of the Job window and of the Task window shows the same Condition Set list with the same commands.

The window has three tabs:

  • Main settings: the name of the set and its logging option, described on this page
  • Conditions: the checks that make up the set, see Conditions - Conditions
  • Actions: what happens for each result, see Conditions - Actions

Click OK to save the Condition Set, or Cancel to close the window without saving.

When you edit an existing Condition Set, the window shows a Copy Condition set Id link at the bottom. Click it to copy the Id of the set to the clipboard, for example to refer to the set in a support case. Right-click it to give the set a new Id:

  1. Enter the new Id, which must be a GUID. The Client shows how many objects refer to the set. If another Condition Set already uses that Id, the Client says so and asks for a different value.
  2. Click Yes to change the Id, No to see the list of those objects first (the Client then asks again), or Cancel to keep the current Id.

When you click Yes, the Server saves the new Id right away and updates the Jobs, Tasks and notifications that refer to the set. Clicking Cancel in the Add/Update condition set window does not undo the change. References outside this Server, for example scripts or API calls that use the old Id, are not updated.

Server -> Global objects -> Conditions -> Add -> Main settings tab

Add/Update condition set window with the Main settings tab open, showing an empty Description box and a cleared Extended debug logging checkbox

Description​

The name of the Condition Set. It is shown in the Condition Set list of the Manage Conditions window, and in the Condition Set list on the Conditions tab of the Job and Task windows, where you assign the set. The Client accepts an empty Description, but give every set a unique name that says what it checks. A cloned set starts with the same Description as the original, so change it to tell the two apart.

Extended debug logging​

Unchecked by default. When you check it, the Server writes Debug entries to the Server log each time it evaluates this Condition Set for a Job or Task:

  • The Condition Set being run, with the name of the Job or Task
  • The result of each condition it checks, shown as "Match", "NoMatch" or "MatchError". Some entries show "No Match" instead of "NoMatch", so search for both
  • The overall result of the set, shown as "MatchAll", "MatchAny", "MatchNone" or "MatchError" (the On Match All, On Match Any, On Match None and On Match Error results on the Actions tab), and the action that follows
  • The Job or Task that a Run Job or Run Task action starts

Where the entries appear:

  • On the Realtime - general tab of the Log window (Server -> Information -> Log). If the Debug filter in that window's Filter menu is active, Debug entries are hidden; click Debug in the Filter menu to show them
  • In the Server log file, when Server events is checked under Log to file in the log settings
  • In the Windows Event Log, when Log to event log is checked in the log settings

They are not written to the log database.

This option applies to this Condition Set only. It is separate from the Server-wide Extended debug logging option in the log settings, which most conditions do not need. The exception is a Variable condition: it writes its result to the log only when the Server-wide option is checked, whatever this option is set to. See Condition - Variable.

When a Job is run without its conditions, for example with With Conditions cleared in Run Job with options, the Server still evaluates the Job's Condition Set and logs it, but does not apply its action. The log then shows "Skipping Condition check because the Job was run manually."

tip

A set with a Retry action is evaluated, and logged, on every retry, so a short wait can fill the log quickly. Uncheck Extended debug logging when you have finished troubleshooting.

warning

The Run Task action is set on the Actions tab, see Conditions - Actions. If the Condition Set of a Task uses Run Task with a Task that is not part of the current Job, neither the Task that owns the Condition Set nor the selected Task runs, and the Job does not continue with its remaining Tasks. The log records why only when Extended debug logging is checked on that Condition Set. If a Job ends early after a condition and the log shows no reason, check Extended debug logging and run the Job again.