starter content for scheduled tasks

Author: kaitlinnewson

admin-guide/en/SUMMARY.md

@@ -8,6 +8,7 @@
 * [Deployment](./deploy)
   * [Configuration](./deploy#configuration)
   * [Email](./deploy-email)
+  * [Scheduled Tasks](./deploy-scheduled-tasks)
   * [Jobs](./deploy-jobs)
   * [Users](./deploy-users)
   * [Multi-tenant](./deploy-multi-tenant)

admin-guide/en/deploy-email.md

@@ -108,4 +108,4 @@ If you run your own email server, you can ask for help in our [community forum](
 
 ---
 
-Next, learn about how to improve performance with the [job runner](./deploy-jobs).
+Next, learn how to manage your [scheduled tasks](./deploy-scheduled-tasks).

admin-guide/en/deploy-jobs.md

@@ -58,24 +58,24 @@ stdout_logfile=<log-file>
 
 Replace the following variables in the configuration above with the correct paths in your system:
 
-| Variable | Description |
-| --- | --- |
-| `<path-to-php>` | Absolute path on the server to the CLI PHP executable. This can be found on most Linux servers by running `which php`. |
-| `<root>` | Absolute path to the root directory of the application (OJS, OMP, OPS). |
-| `<log-file>` | Absolute path to a log file. If hosting in a cloud environment, you may want to [direct logs to stdout](https://stackoverflow.com/a/26897648/1723499). |
+| Variable        | Description                                                                                                                                            |
+|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `<path-to-php>` | Absolute path on the server to the CLI PHP executable. This can be found on most Linux servers by running `which php`.                                 |
+| `<root>`        | Absolute path to the root directory of the application (OJS, OMP, OPS).                                                                                |
+| `<log-file>`    | Absolute path to a log file. If hosting in a cloud environment, you may want to [direct logs to stdout](https://stackoverflow.com/a/26897648/1723499). |
 
 > Take note that workers are long-running processes that load the application in memory. As a result, any changes when workers are running will not reflect instantly without restarting the worker.
 {:.notice}
 
-Restart Worker.
+To restart the worker:
 
 ```
 php lib/pkp/tools/jobs.php restart
 ```
 
 The above command will quit the workers gracefully what is workers will get to complete the current job execution and then quit. Then the Supervisor will restart the workers.
 
-Restart Supervisor.
+To restart Supervisor:
 
 ```
 sudo service supervisor restart
@@ -87,10 +87,10 @@ You may need to run the following command to apply the configuration changes.
 supervisorctl reread
 ```
 
-> **Warning:** We strongly recommend restarting the Worker rather than Supervisor to reflect and consider the new changes pushed to production. Restarting Supervisor suddenly will cause the workers to quit abruptly and if the workers are in the middle of processing a job, it will not get the chance to complete the job which may cause undesired.
+> **Warning:** We strongly recommend restarting the Worker rather than Supervisor to reflect and consider the new changes pushed to production. Restarting Supervisor suddenly will cause the workers to quit abruptly, and if the workers are in the middle of processing a job, they will not complete the job which may cause undesired effects.
 {:.warning}
 
-To configure Supervisor on other systems, or to learn more about monitoring processes, read the [Supervisor documentation](http://supervisord.org/index.html).
+To configure Supervisor on other systems or to learn more about monitoring processes, read the [Supervisor documentation](http://supervisord.org/index.html).
 
 Once you have set up the worker, turn the default job runner off in `config.inc.php`:
 
@@ -110,7 +110,7 @@ php lib/pkp/tools/jobs.php run
 
 A cron job configured to run the following command will process only one job.
 
-```php
+```
 php lib/pkp/tools/jobs.php run --once
 ```
 

admin-guide/en/deploy-sandbox.md

@@ -19,7 +19,7 @@ Beginning with OJS, OMP, and OPS 3.4.0-4, there is a sandbox mode that can be en
 To enable the sandbox mode for an installation, edit `config.inc.php` and find the `sandbox` setting in the `[general]` section. Setting it to `On` will have following impacts:
 
  - The email `default` driver will be set to `log`. As a result, all emails will be routed to the server's error log and no emails will be delivered.
- - Scheduled tasks that run at regular intervals to send out reminder emails, deposit data with third-party services, and perform other tasks will be disabled. This will also disable schedule task execution via `Acron` plugin.
+ - Scheduled tasks that run at regular intervals to send out reminder emails, deposit data with third-party services, and perform other tasks will be disabled.
  - Job execution will be disabled. However, jobs will continue to be dispatched to the queue as usual.
  - `Crossref` and `Datacite` deposits will be disabled.
  - The application will not have any interaction with the ORCID service.
@@ -46,22 +46,21 @@ default = log
 
 Scheduled tasks are run at regular intervals to send out reminder emails, deposit data with third-party services, and perform other tasks. They may be triggered in a couple different ways, depending how you configured them.
 
-If you have a **cron job** set up to run the following command, delete that cron job.
+To disable the built-in task runner, find and edit the following setting in the `[schedule]` section of `config.inc.php`.
 
 ```
-php tools/runScheduledTasks.php
+task_runner = Off
 ```
 
-If you have the **acron plugin** installed, remove it by running the following command in the root directory of the application.
+If you have a **cron job** set up to run the following command, delete that cron job.
 
 ```
-rm -rf plugins/generic/acron
-rm -rf lib/pkp/plugins/generic/acron
+php tools/runScheduledTasks.php
 ```
 
 ### Disable jobs
 
-Stop the job runner in order to prevent pending jobs like data deposits from being run. Turn the built-in job runner off in `config.inc.php`.
+Stop the job runner to prevent pending jobs like data deposits from being run. Turn the built-in job runner off in `config.inc.php`.
 
 ```
 job_runner = Off

admin-guide/en/deploy-scheduled-tasks.md

@@ -0,0 +1,74 @@
+---
+title: Scheduled Tasks - Advanced Configuration - Admin Guide - PKP Developer Docs
+description: Options to configure scheduled tasks with Open Journal Systems (OJS), Open Monograph Press (OPS) or Open Preprint Systems (OPS).
+book: admin-guide
+version: 3.5
+---
+
+# Scheduled Tasks
+
+Scheduled tasks are used to perform periodic tasks or [jobs](./deploy-jobs) on a schedule, such as [processing statistics](./statistics), removing expired data, sending emails, or exporting data to third-party services (e.g. registering DOIs or exporting articles to DOAJ).
+
+To see available options, run:
+
+```
+php lib/pkp/tools/scheduler.php usage
+```
+
+To see all registered scheduled tasks, run:
+
+```
+php lib/pkp/tools/scheduler.php list
+```
+
+To run all pending scheduled tasks, run:
+
+```
+php lib/pkp/tools/scheduler.php run
+```
+
+To run a single specific scheduled task, which is particularly useful for development purposes, run:
+
+```
+php lib/pkp/tools/scheduler.php test
+```
+
+## Log Files
+
+Scheduled task logs are located in files directory under `<files_dir>/scheduledTaskLogs`.
+
+## Configuration
+
+### Scheduled Task Runner
+
+In 3.5 and later, the Acron plugin has been removed and a built-in task runner has been introduced.
+
+To enable the built-in task runner, set the following in the `[schedule]` section in `config.inc.php`:
+
+```
+task_runner = On
+```
+
+To adjust the interval at which the built-in task runner runs, adjust the following setting in `config.inc.php`. A smaller value may negatively impact application performance.
+
+```
+task_runner_interval = 60
+```
+
+The built-in task runner may not be suitable for high-volume sites; in this case, we recommend using your operating system's task scheduler instead. The following is a sample crontab entry for *nix operating systems:
+
+```
+* * * * * php lib/pkp/tools/scheduler.php run >> /dev/null 2>&1
+```
+
+### Notifications
+
+To receive an email notification only when a scheduled task fails, set the following in `config.inc.php`. Otherwise, all tasks will generate a notification.
+
+```
+scheduled_tasks_report_error_only = On
+```
+
+---
+
+Next, learn about how to improve performance with the [job runner](./deploy-jobs).

admin-guide/en/deploy.md

@@ -138,10 +138,10 @@ force_ssl = On
 The software must run some tasks every day, such as compiling usage statistics. You should set up a cron job to run the following command once a day.
 
 ```
-php tools/runScheduledTasks.php
+php lib/pkp/tools/scheduler.php run
 ```
 
-If you are unable to configure this cron job, you must enable the Acron plugin after you have installed the software.
+Learn more about [scheduled tasks](./deploy-scheduled-tasks).
 
 ## Job Runner