Pruning Agent
The Pruning Agent is a scheduled housekeeping job that archives products out of your ONIX 2.1 and ONIX 3 catalogues automatically. You define, per ONIX version, a saved search that selects which products qualify, then set how often the agent runs, on which day and at what time, and how many days a matching product is kept before it is removed.
Where to find it
- Settings menu: Pruning Agent. Route:
/preferences/pruning-agent. - Visible to accounts with access to Preferences.
Screen overview
- Cancel and Save — always enabled; nothing is stored until you click Save.
- Enable Pruning Agent, then the two searches: Archive products from ONIX 2.1 catalogues using this search and Archive products from ONIX 3 catalogues using this search, each with a pencil button (Define search).
- Frequency (Daily, Weekly, Yearly), Day of the week, Day of the month (1–31), Time of day (24-hour, with seconds) and Remove product after (1–365 days).
How to schedule the agent
- Tick Enable Pruning Agent.
- Choose the Frequency: Daily with a Time of day; Weekly with a Day of the week and a time; Yearly with a Day of the month and a time.
- Set Remove product after — the number of days a matching product is kept before it is removed.
- Click Save. The page confirms with Changes have been successfully saved.
How to define which products are archived
- Click the pencil next to the ONIX 2.1 or ONIX 3 line. The Advanced Search dialog opens.
- Click Add to create a criterion. Click the … button in the Field cell to choose a field in the Select a search field tree (type in the box to filter; only fields, not categories, can be selected), then OK.
- Pick an Operator and enter a Value. The value box adapts to the field: text, number, date, or a checkbox for yes/no fields. For date fields combined with a "within … days" operator, enter a number of days.
- Add more criteria; from the second row on, choose and / or in the Logical column. The Query Plan — for example
((1 and 2) or 3)— is rebuilt automatically and can be edited by hand, but any later add, remove or and/or change rewrites it. - Click Save in the dialog to bring the criteria back to the page, then Save on the page to store them. Clear search empties every criterion.
Each ONIX version has its own search.
Tips
- Cancel always asks All modifications will be lost. Do you want to proceed? and reloads the stored settings, whether or not you changed anything.
- Cancelling the Advanced Search dialog leaves the stored search untouched.
Frequently asked questions
What does the pruning agent do with a product?
It archives products that match your saved search and removes them from the catalogue after the number of days set in Remove product after.
What if I don't define a search?
The saved search is what selects the products to archive. Without criteria, the agent has nothing to select.
Why do I see both Day of the week and Day of the month?
Both fields are always shown. The agent uses the one that matches the chosen frequency — the day of the week for a weekly run, the day of the month otherwise.
Does Save in the Advanced Search dialog write to the server?
No. It returns the criteria to the page; click Save on the page to store them.
Can the agent run more than once a day?
No. A single time of day is scheduled.