NOTICE: If you are using Fabrik and update to Joomla 3.10, you will need to update to Fabrik 3.10. And, if you are using Fabrik, do not upgrade to Joomla 4, we do not have a supported version ready for release. More information on a release date coming soon. Also, please note that Fabrik 3.10 will not install on any Joomla sites less than 3.8.Dismiss Notice
The schedule section allows you to define tasks that are run repeatedly at a given time and interval.
For the schedule section to work you MUST have installed and published the Fabrik schedule system plug-in.
The Fabrik Schedule System Plugin will run on every front end page load and launches individual crons based on their settings. This is done as one of the very last things that Joomla does, once it has output the page (so you won't notice it when loading a page as a user). It then loads the metadata (settings from #__fabrik_crons) for all your cron plugins, which includes a "last_run", as well as the frequency settings you set for each one. Then it simply runs any which are due (or overdue).
View Scheduled Tasks(top)
Each scheduled task can be selected with the check box to the left of its name. Once selected it can be altered by clicking on the buttons in the top right hand corner:
- Run - force the scheduled task to run straight away.
- New - allows you to create a new scheduled task.
- Edit - allows you to edit the scheduled task, note that you can also edit the scheduled task by clicking on its name.
- Publish - sets the state of the scheduled task to published.
- Unpublish - sets the state of the scheduled task to unpublished.
- Check In - checks in the scheduled task.
- Trash - trashes the scheduled task.
- Options - links to the general Fabrik options.
- Help - links to the related Fabrik wiki article.
Published - toggles the form's published state.
Add / Edit a Scheduled Task (top)
- ID - the scheduled tasks id number as recorded in the database.
- Label - a descriptive name for the scheduled task.
- Last run - States the last time that the plug-in was run - you can set this to a future date to disable the scheduled task until a given date, at which point it will start to run
- Status - sets whether the scheduled task is published.
- Connection - Fabrik connection containing the list whose data you wish to use in the scheduled task
- List - A Fabrik list which is pre-loaded when the scheduled task is run. Selecting a list is optional, not selecting one just means $data will be empty instead of being populated with list data. Note Fabrik will render the element data, as if it was going to be output for display. And that takes time - orders of magnitude more than simply selecting raw data from a database. Trying to render thousands of rows can take a lot of time and may well run you out of script execution time.
- Plugin - the plug-in that is run on the tables' data.
- Every - Enter an integer. This will combine with the 'unit' drop down to indicate when the scheduled task will run - e.g. 'Every 1 day', 'Every 5 hours'.
- Unit - Select a time unit that will combine with the 'Every' field to indicate when the scheduled task will run - e.g. 'Every 1 day', 'Every 5 hours'.
- Log events -If set to yes then each time the scheduled task is run the results are logged in the database table #__fabrik_logs.
- Email to - comma separated list of email addresses to send the scheduled task log to.
- Require query string - If set to yes then the plugin will only run if the page's URL contains the querystring 'fabrik_cron=1' (unless modified with the Query Secret option). Useful to stop processor intensive queries running when a browser requests a page, whilst still allowing server cron jobs to run using something like wget with &fabrik_cron=1 applied to the url from a standard UNIX cron job. If using this option, you should set your run frequency to something very low, as you will not be able to run it even with the query string addition more often than the freuency interval.
The simplest way to call this is: 'wget https://yoursite.com/index.php?fabrik_cron=1' or, for systems without wget, 'curl -s https://yoursite.com/index.php?fabrik_cron=1' or, for webcron like easycron.com with URL: 'https://yoursite.com/index.php?fabrik_cron=1' .
- Query Secret - If 'Require querystring' is enabled, you can optionally specify key word to trigger this plugin, by using 'fabrik_cron=yoursecret' on the query string instead of 'fabrik_cron=1'.
- Use Run Gating - If set to yes, Fabrik will temporarily unpublish this plugin when it is running, to prevent multiple copies being run at the same time. This is useful if you have a script which can potentially take longer to execute than the run interval. If you use this option, you should periodically check to make sure you pligin has not become stuck as unpublished, as if your script causes certain error conditions, we may not be able to re-publish it.
- Reschedule Manual - If set to Yes, will update the lastrun date and reschedule when manually running the plugin on the backend, as well as when running through via the cron system plugin. If set to No, will only reschedule when running via the system plugin.