Платформа 3V/Планировщик/Описание задач: различия между версиями
< Платформа 3V | Планировщик
Перейти к навигации
Перейти к поиску
| Строка 12: | Строка 12: | ||
*'''taskIds''' - коллекция идентификаторов задач цепочки, которые будут выполнятся последовательно (только для ChainScheduledTaskDto). | *'''taskIds''' - коллекция идентификаторов задач цепочки, которые будут выполнятся последовательно (только для ChainScheduledTaskDto). | ||
*'''discriminator''' - [[Платформа 3V/Планировщик/Описание задач#.D0.A2.D0.B8.D0.BF.D1.8B_.D0.B7.D0.B0.D0.B4.D0.B0.D1.87|тип задачи]].<br> | *'''discriminator''' - [[Платформа 3V/Планировщик/Описание задач#.D0.A2.D0.B8.D0.BF.D1.8B_.D0.B7.D0.B0.D0.B4.D0.B0.D1.87|тип задачи]].<br> | ||
| + | Пример структуры описания задачи: <br> | ||
| + | |||
[[Файл:Задача планировщика.png]] | [[Файл:Задача планировщика.png]] | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:700px; overflow:auto;"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:700px; overflow:auto;"> | ||
| Строка 58: | Строка 60: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</div></div><br> | </div></div><br> | ||
| + | |||
== Типы задач == | == Типы задач == | ||
Задачи бывают трех видов: | Задачи бывают трех видов: | ||
Версия 12:44, 28 декабря 2021
Задача планировщика - это некоторое JSON описание действия, которое повторяется по заданному времени. Планировщик поддерживает несколько видов задач, например, запрос к сервису, запуск методики или цепочка задач.
Содержание
Структура задач планировщика
JSON описание задачи содержит следующую структуру:
- id - идентификатор задачи.
- name - наименование задачи.
- runUrl - настройки Url для запуска задачи.
- checkStateUrl - настройки Url для проверки состояния задачи.
- schedule - расписание задачи.
- isEnable - признак включенности задачи, если отметкаtrue - задача включена и будет обрабатываться планировщиком.
- authenticationSettingsId - идентификатор настроек аутентификации.
- taskIds - коллекция идентификаторов задач цепочки, которые будут выполнятся последовательно (только для ChainScheduledTaskDto).
- discriminator - тип задачи.
Пример структуры описания задачи:
Шаблон описания задачи в формате JSON
1 {
2 "id": 0,
3 "name": "string",
4 "runUrl": {
5 "type": "Get",
6 "url": "string",
7 "headers": [
8 {
9 "name": "string",
10 "value": "string"
11 }
12 ],
13 "discriminator": "string"
14 },
15 "checkStateUrl": {
16 "type": "Get",
17 "url": "string",
18 "headers": [
19 {
20 "name": "string",
21 "value": "string"
22 }
23 ],
24 "discriminator": "string"
25 },
26 "schedule": {
27 "period": {
28 "discriminator": "string"
29 },
30 "runTime": {
31 "hours": 0,
32 "minutes": 0
33 },
34 "discriminator": "string"
35 },
36 "isEnable": true,
37 "authenticationSettingsId": 0,
38 "discriminator": "string"
39 }
Типы задач
Задачи бывают трех видов:
- ScheduledTaskDto - выполнение запроса к сервису
Шаблон описания задачи в формате JSON
1 {
2 "runUrl": {
3 "type": "Get",
4 "url": "https://3v.3v-group.net/",
5 "headers": [],
6 "discriminator": "TaskUrlDto"
7 },
8 "checkStateUrl": null,
9 "schedule": {
10 "timeSpan": "00:00:00.1000000",
11 "period": {
12 "discriminator": "InfiniteTimesDto"
13 },
14 "runTime": {
15 "hours": 14,
16 "minutes": 57
17 },
18 "discriminator": "TimerScheduleDto"
19 },
20 "isEnable": false,
21 "authenticationSettingsId": 1,
22 "id": 67,
23 "name": "Дергаем дев каждые 100мс",
24 "discriminator": "ScheduledTaskDto"
25 }
- CalcScheduledTaskDto - запуск методики (может быть описана в виде выполнения запроса к сервису)
Шаблон описания задачи в формате JSON
1 {
2 "runUrl": {
3 "type": "Get",
4 "url": "https://******/engine/api/Calculation/20776",
5 "headers": [],
6 "discriminator": "TaskUrlDto"
7 },
8 "checkStateUrl": null,
9 "schedule": {
10 "timeSpan": "00:00:00",
11 "period": {
12 "discriminator": "OnceDto"
13 },
14 "runTime": {
15 "hours": 19,
16 "minutes": 12
17 },
18 "discriminator": "TimerScheduleDto"
19 },
20 "isEnable": true,
21 "authenticationSettingsId": null,
22 "id": 25,
23 "name": "pl3v_calculation_+1",
24 "discriminator": "CalcScheduledTaskDto"
25 }
- ChainScheduledTaskDto - цепочка задач
Шаблон описания задачи в формате JSON
1 {
2 "runUrl": {
3 "type": "Get",
4 "url": "https://********/MetaObjects/Copy?id=20636&parentId=20555",
5 "headers": [],
6 "discriminator": "TaskUrlDto"
7 },
8 "checkStateUrl": null,
9 "schedule": {
10 "timeSpan": "00:00:00",
11 "period": {
12 "discriminator": "OnceDto"
13 },
14 "runTime": {
15 "hours": 14,
16 "minutes": 5
17 },
18 "discriminator": "TimerScheduleDto"
19 },
20 "isEnable": true,
21 "authenticationSettingsId": null,
22 "id": 23,
23 "name": "pl3v_535_copy_dictionary_2",
24 "discriminator": "ScheduledTaskDto"
25 },
26 {
27 "taskIds": [
28 21,
29 22,
30 23
31 ],
32 "runUrl": null,
33 "checkStateUrl": null,
34 "schedule": {
35 "timeSpan": "00:00:00",
36 "period": {
37 "discriminator": "OnceDto"
38 },
39 "runTime": {
40 "hours": 19,
41 "minutes": 12
42 },
43 "discriminator": "TimerScheduleDto"
44 },
45 "isEnable": true,
46 "authenticationSettingsId": null,
47 "id": 24,
48 "name": "pl3v_535_copy_dictionary_chain_2",
49 "discriminator": "ChainScheduledTaskDto"
50 }
Настройки Url
Настройки Url для запуска задачи бывают трёх видов:
- TaskUrlDto - любой тип запроса без параметров в теле запроса
пример:
{
"type": "Get",
"url": "https://3v.3v-group.net/repository/api/MetaObjects/Copy?id=17403&parentId=17379",
"headers": null,
"discriminator": "TaskUrlDto"
}
- TaskUrlDto - любой тип запроса без параметров в теле запроса с аутентификацией в сервисе
пример:
{
"type": "Get",
"url": "https://***********/RefreshConnection",
"headers": [
{
"name": "secret",
"value": "*****************"
}
],
"discriminator": "TaskUrlDto"
},
- PostWithParamsTaskUrlDto - POST-запрос со строковым значением (JSON) параметров в теле запроса
пример:
{
"runBodyParams": "[{\"dictionaryId\":0,\"sortingOptions\":null,\"displayValueOptions\":null,\"options\":{\"groupingOptions\":null,\"groupingMethod\":\"Default\",\"sortingOptions\":null,\"rootElement\":null,\"virtualElements\":null,\"displayValueOptions\":null,\"dictionaryId\":6310,\"filter\":null,\"selection\":null,\"hierarchyId\":null},\"attributeValues\":null,\"defaultValue\":null,\"value\":2,\"isMultiselect\":false,\"isEmptyValuePossible\":false,\"isDisableable\":false,\"isDisabled\":false,\"dataControlOptions\":null,\"id\":2,\"name\":null,\"discriminator\":\"DictionaryParameterDto\"}]",
"type": "Post",
"url": "http://front.develop.trv-services.bars.group/engine/api/Calculation/16332",
"headers": [],
"discriminator": "PostWithParamsTaskUrlDto"
}
- CalcWithParamsTaskUrlDto - POST-запрос на запуск методики с описанием параметров в виде параметров методики.
пример:
{
"parameters": [
{
"options": {
"dictionaryId": 6310,
"filter": null,
"hierarchyId": null,
"limit": null
},
"value": 3,
"isMultiselect": false,
"id": 2,
"discriminator": "DictionaryParameterDto"
}
],
"type": "Post",
"url": "http://front.develop.trv-services.bars.group/engine/api/Calculation/16332",
"headers": [],
"discriminator": "CalcWithParamsTaskUrlDto"
}
Настройки Url для проверки состояния задачи аналогичны настройкам Url для запуска задачи.
Свойство type доступно только для TaskUrlDto, для CalcWithParamsTaskUrlDto и PostWithParamsTaskUrlDto оно игнорируется и считается равным Post
| Значение | Описание |
|---|---|
| Get(0) | GET-запрос |
| Post(1) | POST-запрос |
| Put(2) | PUT-запрос |
| Delete(3) | DELETE-запрос |
Расписание
Расписание бывает двух видов:
- DaysScheduleDto - расписание по дням
пример:
"schedule":
{
"days": [
"Monday",
"Friday"
],
"period": {
"discriminator": "InfiniteTimesDto"
},
"runTime": {
"hours": 11,
"minutes": 31
},
"discriminator": "DaysScheduleDto"
}
- TimerScheduleDto - расписание по таймеру.
пример:
"schedule":
{
"timeSpan": "00:05:00",
"period": {
"discriminator": "InfiniteTimesDto"
},
"runTime": {
"hours": 11,
"minutes": 31
},
"discriminator": "TimerScheduleDto"
}
Расписание содержит в себе:
- Period - период действия задачи.
- RunTime - время первого запуска задачи, см. Метод GetSchedulerTime.
Период действия задачи
- DatePeriodDto - период в диапазоне дат.
пример:
"period":
{
"startDate": "2020-10-12T00:00:00Z",
"endDate": "2020-10-14T00:00:00Z",
"discriminator": "DatePeriodDto"
}
- InfiniteTimesDto - бесконечный период.
пример:
"period":
{
"discriminator": "InfiniteTimesDto"
}
- ManyTimesDto - период, ограниченный количеством раз.
пример:
"period":
{
"times": 5,
"discriminator": "ManyTimesDto"
}
- OnceDto - Период, ограниченный единственным разом.
пример:
"period":
{
"discriminator": "OnceDto"
}
Пример
Пример описания включенной задачи, которая 2 раза с интервалом в 2 минуты выполняет запуск методики 8380 со значениями [2,3] параметра на справочнике с идентификатором 8376, с первым запуском в 10:58 по времени планировщика и настройками аутентификации с идентификатором 1:
{
"runUrl": {
"parameters": [
{
"dictionaryId": 8376,
"discriminator": "DictionaryParameterDto",
"isMultiselect": true,
"id": 1,
"value": [
2,
3
]
}
],
"type": "Post",
"url": "http://engine/api/Calculation/8380",
"headers": [],
"discriminator": "CalcWithParamsTaskUrlDto"
},
"checkStateUrl": null,
"schedule": {
"timeSpan": "00:02:00",
"period": {
"times": 2,
"discriminator": "ManyTimesDto"
},
"runTime": {
"hours": 10,
"minutes": 58
},
"discriminator": "TimerScheduleDto"
},
"isEnable": true,
"authenticationSettingsId": 1,
"id": 1,
"name": "calc_example",
"discriminator": "CalcScheduledTaskDto"
}