| Attribute Data Type: | number |
| Attribute Default Value: | 1 |
| Atrribute Group: | Agent |
| Atrribute Purpose: | Agent configuration |
| Attribute Inherited from Preferences? | No |
| Attribute Read-Only? | No |
AgentPriority, allows creation of agents that run less frequently than normal. A new pop-up menu in the Create/Rename Agent dialog lets you the agent priority be changed.
Regardless of the setting, every agent is always updated before export and when updating manually.
The default value of AgentPriority is 1, which will cause the agent to be checked at roughly ten second intervals. Higher values of AgentPriority cause the agent to be checked less frequently.
Setting AgentPriority to 0 asks Tinderbox to check the agent as frequently as possible.
Setting AgentPriority to -1 asks Tinderbox to check the agent only on manual updates.
The mapping of number values to the text names used in the Priority pop-up menu on the Create Agent and Rename Agent dialogs is as follows:
- Highest = 0
- Normal = 1 (default)
- Lower = 4
- Low = 10
- Off = -1
The AgentPriority can only be set as a number - don't use text values or you get an error. Any other number value than those listed above causes the dialog pop-up to show 'highest'. Whether this is the true result, i.e. that setting '9' results in the same as setting '0' is not clear.
WARNING! If AgentPriority is set to -1/off then any existing aliases are only retained until the file is next closed. On reopening, the agent will be empty of aliases. It must be allowed to execute again at least once to re-create the previous aliases (assuming on other agent query-related criteria have changed). You don't need to change the priority you can just use the menu File -> Update now (Ctrl+Cmd+=) to force a manual update.
If AgentPriority is set to -1/off, the agent retains the results of its last search and is excluded from Export and manual update agent updates. Thus the current results can be 'frozen' and persist between sessions. However, if an agent is being turned off just to drop it out of regular cycles it will need to manually be set to another value before it can be used/updated - and manually reset to 'off' after use if it desired to 'freeze' it again.
Prior to v5.8.0, adornment's AgentPriority defaulted to 0 (highest) instead of 1 (normal).
