Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
tutorial:adm:how_to_work_with_task_scheduler [2018/12/28 14:36] kotisovam [Processed items] |
tutorial:adm:how_to_work_with_task_scheduler [2018/12/28 14:42] (current) kotisovam [Dry-run] |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Task Scheduler - planning a task and configuration ====== | ||
+ | Task scheduler is a tool in CzechIdM which manages long running operations. One can plan for tasks to run automatically at scheduled times or start them manually. Tasks manage personnel processes such as End of contract or Enabled contract, to name but a few. Password expiration, automatic roles assigning and other tasks are also administered by the task scheduler. | ||
+ | |||
+ | We can make use of this tool by selecting **Settings** in menu, than choose **Task Scheduler**. Now it gives you the option of three tabs at the top of the window. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Currently we are on the **Running tasks** tab. This tab will show you the detailed information of all running tasks which are processed at the moment. Example of this page will be shown bellow. | ||
+ | |||
+ | ===== Scheduled Tasks ===== | ||
+ | |||
+ | Let's move to another tab named **Scheduled Tasks**. On this tab, we can add new Scheduled tasks by clicking on the **Add** button in the right corner of the window. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | This will create a new Scheduled task in the table located on this tab. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The information in this Create Task window is optional. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **Task Type:** Usually refers to what the current task does. In the picture, we have an // | ||
+ | |||
+ | **Description: | ||
+ | |||
+ | **Instance: | ||
+ | |||
+ | **Task Parameters: | ||
+ | |||
+ | **Scheduled Starts:** Here we can schedule start of this Scheduled Task by clicking on the **Add** button or we can see its scheduled time. | ||
+ | |||
+ | **Actions: | ||
+ | * **Red Bin Button** deletes this task. | ||
+ | * **Blue DryRun Button** run demo process (shows only what items it will process in the future run). | ||
+ | * **Green Run Button** run this Scheduled Task and creates a Long Running Task in All Tasks tab. | ||
+ | |||
+ | ===== The difference between a Scheduled Task and a Long Running Task ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **ScheduledTask** is created on page Scheduled tasks by clicking on the **Add** button in the right corner of the page. After that we have a ScheduledTask which has its own list of processed items empty, of course. The first run of this ScheduledTask is created when we hit the **Run** button. | ||
+ | |||
+ | The run creates a **LongRunningTask** | ||
+ | |||
+ | ===== All Tasks ===== | ||
+ | |||
+ | On this tab we can find our created **Long Running Tasks**. Let's take a closer look at columns in this table. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **State:** Shows the result of Long Running Task or created instead. | ||
+ | |||
+ | **Created: | ||
+ | |||
+ | **Task Type:** Refers to Task Type of Scheduled Task. | ||
+ | |||
+ | **Parameters: | ||
+ | |||
+ | **Description: | ||
+ | |||
+ | **Processed: | ||
+ | |||
+ | **Id:** This is identifier of Long Running Task. | ||
+ | |||
+ | As shown in the picture, if you have a Created-state Task and want to process it, then you need to hit the **Run all created tasks** button in the right corner of the table or select the respective row and then choose **Run the selected task** in the right corner of the table. | ||
+ | |||
+ | ===== Detail of a Long Running Task ===== | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | **Created: | ||
+ | |||
+ | **Instance: | ||
+ | |||
+ | **Task Type:** Refers to Task Type of a Scheduled Task. | ||
+ | |||
+ | **Parameters: | ||
+ | |||
+ | **Description: | ||
+ | |||
+ | **Processed: | ||
+ | |||
+ | **Task Duration:** How long the process takes. You can see the time if you roll over the information. | ||
+ | |||
+ | **Started: | ||
+ | |||
+ | ===== Processed items ===== | ||
+ | |||
+ | There is also a table of the processed items. The table shows what items were processed by this task. You can also create a table of all processed items using this **Scheduled Task** by clicking on the **History of processed entities** button. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== Queue ===== | ||
+ | |||
+ | On this page we can delete items. When we delete some item than in next run of our Scheduled Task this item will be processed too. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== Dry-run ===== | ||
+ | |||
+ | This feature allows you to see a preview of items which will be processed by this task without actually processing them. Basically, you initiate this task with the blue **Run** button which sets the task parameter Dryrun to True. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The final result will show the table items which were “dry-run” and but won’t be included in the history table. |