Merge pull request #690 from i-doit/659-use-the-windows-task-schedule…

…r-for-i-doit

task scheduler english

config/en/mkdocs.yml

@@ -373,6 +373,7 @@ nav:
           - ((OTRS)) Community Edition Help Desk: automation-and-integration/service-desk/otrscommunity-help-desk.md
           - Zammad: automation-and-integration/service-desk/zammad.md
       - SNMP: automation-and-integration/snmp.md
+      - Task scheduling & Cronjobs: automation-and-integration/task-scheduling-and-cronjobs.md
   - System Administration:
       - system-administration/index.md
       - Administration:

docs/en/automation-and-integration/index.md

@@ -9,3 +9,4 @@ The described interfaces are already included in _i-doit pro_:
 *   [Service Desk](./service-desk/index.md)
 *   [Email (SMTP)](./e-mail.md)
 *   [SNMP](./snmp.md)
+*   [Task scheduling & Cronjobs](./task-scheduling-and-cronjobs.md)

docs/en/automation-and-integration/task-scheduling-and-cronjobs.md

@@ -0,0 +1,80 @@
+---
+title: Task Scheduling & Cronjobs
+description: Task Scheduling & Cronjobs
+#icon: material/
+status:
+lang: en
+---
+
+## Windows Task Scheduler
+
+In this section, we will show you how to automate a i-doit windows installation using the windows task scheduler.
+
+### Preliminary information
+
+In our example of task scheduling for i-doit under Windows, we use an i-doit instance that was set up using the [i-doit Windows Installer](../installation/manual-installation/microsoft-windows-server/index.md).
+
+!!! warning "If you have installed i-doit via XAMPP, you must adjust the paths in the batch file for console.php and php.exe."
+
+### Creating a batch file
+
+To create a batch file, you must open an editor program and create a new file. Then save this file as **"i-doit-jobs.bat"**.
+
+[![batch-create](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/1-auc.png)](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/1-auc.png)
+
+Once the file has been created, we can fill the file with commands from the [CLI](./cli/console/options-and-parameters-cli.md).
+
+The batch file can be filled with the following content:
+
+```batch
+@echo off
+
+set IDOIT_USERNAME="admin"
+set IDOIT_PASSWORD="admin"
+set TENANT_ID="1"
+
+:: Commands
+:: Logbook-Archive: Archives the logbook entries with a predefined age, according to the settings on the i-doit interface.
+C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php logbook-archive --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
+
+:: Search-Index: Renews the search index by deleting and rewriting it.
+C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php search-index --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
+
+:: Notifications-Send: Sends the notifications configured on the i-doit interface
+C:\ProgramData\i-doit\php\php.exe C:\ProgramData\i-doit\apache-2.4\htdocs\console.php notifications-send --user %IDOIT_USERNAME% --password %IDOIT_PASSWORD% --tenantId %TENANT_ID%
+```
+
+!!! info "The user name, password and TenantID may need to be adjusted"
+
+### Automate JDisc import and LDAP sync
+
+If you also want to automate the JDisc import or the LDAP sync, you can use the commands for the [JDisc import](../automation-and-integration/cli/console/options-and-parameters-cli.md#import-jdisc) or the [LDAP sync](../automation-and-integration/cli/console/options-and-parameters-cli.md#ldap-sync) in the same way as the other commands from the example above, simply add them to the batch file.
+
+### Setting up a task
+
+In order for the batch file to be executed automatically, a **task** must be created.
+This function can be found via the Windows search under **Task Scheduler**.
+
+The first step is to create a new task. A "Basic task" can be created under the "Actions" tab:
+
+[![Create simple task](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/2-auc.png)](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/2-auc.png)
+
+Once a name and a description have been assigned, the trigger can now be created.
+The trigger specifies when and how the task should be executed.
+For this example, we set the trigger to **Daily at 4:00 am**.
+
+[![Set trigger](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/3-auc.png)](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/3-auc.png)
+
+Next, the action that should be executed must be selected. As the batch file is to be executed, "Start a program" must be selected for this option.
+You can then select the batch file and continue with the configuration.
+
+[![Execute program](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/4-auc.png)](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/4-auc.png)
+
+All details can then be checked once again and the configuration can be completed.
+
+To ensure that the task is executed correctly, we open the properties of the task we have just created and select the option "Run whether user is logged on or not" on the "General" page.
+
+[![Edit properties](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/5-auc.png)](../assets/images/en/automation-and-integration/task-scheduling-and-cronjobs/5-auc.png)
+
+This completes the task planning.
+The created task will execute the selected batch file every day at 4:00 a.m. and the commands written in the batch file will be executed.