Difference between revisions of "Setup:Installation Manual/Optimization/Cronjobs"
← Setup:Installation Manual/Optimization/Cronjobs
[unchecked revision] | [quality revision] |
(Created page with "{{DISPLAYTITLE:Cronjobs}} __TOC__ This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version). ==Tip...") |
(Tag: Visual edit) |
Contents
- 1Tip Tips for this Document
- 2 runJobs.php
- 3runNotificationsprocessBsEmailBatch.php (only BlueSpice pro)
This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version).
Tip Tips for this Document[edit | edit source]
- Please, read this manual completely and work through the single installtion installation steps one after another.
- For editing For editing the configuration files with a text editor, the files must be saved in saved in UTF-8 coding without BOM BOM (Byte Order Mark).
-
The placeholder placeholder
<installpath-bluespice>
stands stands for the path to your BlueSpice installation, e.g gC:\inetpub\wwwroot\bluespice
(Windows ) or regarding the documentation "Folder structure under Windows") or/var/www/bluespice
(Linux). -
The placeholder
<tomcat-webapps
stands for the path to the webapps directory of your Tomcat server, e.gC:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps
(Windows) or/var/lib/tomcat8/webapps
(Linux).
runJobs.php[edit | edit source]
Time-consuming processes will be moved to a processing queue in the background of BlueSpice. With every page impression, a part of these will be processed. For the case that there are lots of processes in the queue and there are relatively litte page impressions, the tasks will not be processed promptly.
Zeitaufwändige zu erledigende Prozesse werden von BlueSpice im Hintergrund in eine Warteschlange zum Abarbeiten gelegt. Bei jedem Seitenaufruf wird ein Teil dieser Prozesse abgearbeitet. Hängen zu viele Prozesse in der Warteschlange und es gibt verhältnismäßig wenige Seitenaufrufe so werden diese Prozesse nicht zeitnah abgearbeitet.
For this reason, the queue should be processed regularly by cronjob. At the same time, the calling of the queue by page impressions can be deactivated, which increases the performance of BlueSpice. For this, create the file <installpath-bluespice>
/settings.d/001-JobQueue.php with the following content:
Save and close the file.
Now create a cronjob (Windows: "Scheduled task") depending on your operating system. The command to execute is:
php<installpath-bluespice>
/maintenance/runJobs.php (Linux) php.exe<installpath-bluespice>
\maintenance\runJobs.php (Windows)
It is recommended to specify the complete path to php.exe under Windows. For more information, see the environment variables |
document. |
Execute the cronjob every 15 10 minutes.
runNotificationsprocessBsEmailBatch.php (only BlueSpice pro)[edit | edit source]
The BlueSpiceReminder notifies the users by email about upcoming tasks in BlueSpice. For this, a cronjob needs to be executed once a day. This is the command: For reports via email sent from MediaWiki, please create a cronjob and run it daily. The command for this is:
php<installpath-bluespice>
/extensions/BlueSpiceReminderBlueSpiceEchoConnector/Reminder/maintenance/runNotificationsprocessBsEmailBatch.php (Linux) php.exe<installpath-bluespice>
\extensions\BlueSpiceReminderBlueSpiceEchoConnector\Reminder\maintenance\runNotificationsprocessBsEmailBatch.php (Windows)
It is recommended to specify the complete path to php.exe under Windows. For more information, see the environment variables |
document. |
{{DISPLAYTITLE:Cronjobs}} __TOC__ This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version). ==TipTips for this Document== * Please, read this manual completely and work through the single installtion steps one after another. * For editing the configuration files with a text editor, the files must be saved in UTF-8 coding without BOM (Byte Order Mark). * The placeholder <code><installpath-bluespice></code> stands for the path to your BlueSpice installation, e.g <code>C:\inetpub\wwwroot\bluespice</code> (Windows) or <code>/var/www/bluespice</code> (Linux). {{Setup-document-note}} ==runJobs.php== Time-consuming processes will be moved to a processing queue in the background of BlueSpice. With every page impression, a part of these will be processed. For the case that there are lots of processes in the queue and there are relatively litte page impressions, the tasks will not be processed promptly. Zeitaufwändige zu erledigende Prozesse werden von BlueSpice im Hintergrund in eine Warteschlange zum Abarbeiten gelegt. Bei jedem Seitenaufruf wird ein Teil dieser Prozesse abgearbeitet. Hängen zu viele Prozesse in der Warteschlange und es gibt verhältnismäßig wenige Seitenaufrufe so werden diese Prozesse nicht zeitnah abgearbeitet. For this reason, the queue should be processed regularly by cronjob. At the same time, the calling of the queue by page impressions can be deactivated, which increases the performance of BlueSpice. For this, create the file <code><installpath-bluespice></code>/settings.d/001-JobQueue.php with the following content: Save and close the file. Now create a cronjob (Windows: "Scheduled task") depending on your operating system. The command to execute is: php <code><installpath-bluespice></code>/maintenance/runJobs.php ''(Linux)'' php.exe <code><installpath-bluespice></code>\maintenance\runJobs.php ''(Windows)'' [[File:{{Hint.jpg|left]] ''' |text=It is recommended to specify the complete path to php.exe under Windows. For more information, see the [[Setup:Installation Manual/System Configuration/Environment Variables|environment variables]] document.''' _Guide/Services_and_system_configuration/Environment_Variables|environment variables]] document. }} Execute the cronjob every '''1510 minutes'''. ==runNotificationsprocessBsEmailBatch.php (only BlueSpice pro)== The BlueSpiceReminder notifies the users by email about upcoming tasks in BlueSpice. For this, a cronjob needs to be executed once a day. This is the command: == For reports via email sent from MediaWiki, please create a cronjob and run it daily. The command for this is: php <code><installpath-bluespice></code>/extensions/BlueSpiceReminder/Reminder/BlueSpiceEchoConnector/maintenance/runNotificationsprocessBsEmailBatch.php ''(Linux)'' php.exe <code><installpath-bluespice></code>\extensions\BlueSpiceReminder\Reminder\BlueSpiceEchoConnector\maintenance\runNotificationsprocessBsEmailBatch.php ''(Windows)'' [[File:{{Hint.jpg|left]] ''' |text=It is recommended to specify the complete path to php.exe under Windows. For more information, see the [[Setup:Installation Manual/System Configuration/Environment Variables|environment variables]] document.'''_Guide/Services_and_system_configuration/Environment_Variables|environment variables]] document. }} [[en:{{FULLPAGENAME}}]] [[de:Setup:Installationsanleitung/Optimierungen/Cronjobs]]
(11 intermediate revisions by 6 users not shown) | |||
Line 5: | Line 5: | ||
This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version). | This document describes cronjobs an related configurations, which should be set for your BlueSpice (depending on the used version). | ||
− | == | + | ==Tips for this Document== |
− | + | {{Setup-document-note}} | |
− | |||
− | |||
==runJobs.php== | ==runJobs.php== | ||
Time-consuming processes will be moved to a processing queue in the background of BlueSpice. With every page impression, a part of these will be processed. For the case that there are lots of processes in the queue and there are relatively litte page impressions, the tasks will not be processed promptly. | Time-consuming processes will be moved to a processing queue in the background of BlueSpice. With every page impression, a part of these will be processed. For the case that there are lots of processes in the queue and there are relatively litte page impressions, the tasks will not be processed promptly. | ||
− | + | For this reason, the queue should be processed regularly by cronjob. | |
− | |||
− | For this reason, the queue should be processed regularly by cronjob. | ||
− | |||
− | |||
Now create a cronjob (Windows: "Scheduled task") depending on your operating system. The command to execute is: | Now create a cronjob (Windows: "Scheduled task") depending on your operating system. The command to execute is: | ||
php <code><installpath-bluespice></code>/maintenance/runJobs.php ''(Linux)'' | php <code><installpath-bluespice></code>/maintenance/runJobs.php ''(Linux)'' | ||
− | <code><installpath-bluespice></code>\maintenance\runJobs.php ''(Windows) | + | php.exe <code><installpath-bluespice></code>\maintenance\runJobs.php ''(Windows)'' |
− | |||
− | |||
+ | {{Hint | ||
+ | |text=It is recommended to specify the complete path to php.exe under Windows. For more information, see the [[Setup:Installation_Guide/Services_and_system_configuration/Environment_Variables|environment variables]] document. | ||
+ | }} | ||
+ | Execute the cronjob every '''10 minutes'''. | ||
− | + | ==processBsEmailBatch.php== | |
+ | For reports via email sent from MediaWiki, please create a cronjob and run it daily. The command for this is: | ||
− | + | php <code><installpath-bluespice></code>/extensions/BlueSpiceEchoConnector/maintenance/processBsEmailBatch.php ''(Linux)'' | |
− | + | php.exe <code><installpath-bluespice></code>\extensions\BlueSpiceEchoConnector\maintenance\processBsEmailBatch.php ''(Windows)'' | |
− | + | {{Hint | |
− | + | |text=It is recommended to specify the complete path to php.exe under Windows. For more information, see the [[Setup:Installation_Guide/Services_and_system_configuration/Environment_Variables|environment variables]] document. | |
+ | }} | ||
− | [[ | + | [[en:{{FULLPAGENAME}}]] |
+ | [[de:Setup:Installationsanleitung/Optimierungen/Cronjobs]] |