Платформа 3V/Планировщик/Получение задач: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
 
(не показано 11 промежуточных версий этого же участника)
Строка 1: Строка 1:
'''Статья находится в разработке!'''
+
Вы можете [https://drive.google.com/file/d/1HkOhJMIGwFmDNAAtUUOx7wdkCTYgSVJ1/view?usp=sharing скачать] уже настроенные объекты для получения задач планировщика или создать объекты самостоятельно.  
Вы можете [https://drive.google.com/file/d/1EeD3x0UFAYExJIUi3eMajlICWyBUl74u/view?usp=sharing скачать] уже настроенные объекты для получения задач планировщика или создать объекты самостоятельно.  
+
== Объекты ==
== Объекты аудита ==
 
 
Для получения информации о состоянии задач планировщика вам понадобится несколько объектов:
 
Для получения информации о состоянии задач планировщика вам понадобится несколько объектов:
 
# Соединение с источником
 
# Соединение с источником
Строка 31: Строка 30:
 
[[Файл:Соединение с планировщиком.png|слева|750px|border]] <br clear="both" /><br>
 
[[Файл:Соединение с планировщиком.png|слева|750px|border]] <br clear="both" /><br>
 
== Настройка внешних справочников ==
 
== Настройка внешних справочников ==
После настройки соединения с источником необходимо создать и настроить несколько внешних справочников. Для настройки аудита используются следующие справочники:  
+
После настройки соединения с источником необходимо создать и настроить несколько внешних справочников. Для настройки связи с планировщиком используются следующие справочники:  
# '''Справочник сессий (Sessions)''' - в нем содержится информация о сессии пользователей:
+
# '''Справочник задач планировщика (ScheduledTask)''' - в нем содержится информация о задачах планировщика, их описание, статус запуска, сообщение об ошибках.
## Идентификатор сессии - атрибут справочника "ExternalId";
+
## Идентификатор задачи в планировщике - атрибут справочника "Id";
## Дата начала сессии - атрибут справочника "StartTime";  
+
## Наименование задачи в планировщике - атрибут справочника "Name";
## Дата окончания сессии - атрибут справочника "EndTime";  
+
## Информация из раздела RunUrl(настройки Url для запуска задачи) задачи в планировщике - атрибут справочника "RunUrl";
## Логин пользователя - атрибут справочника "UserLogin";  
+
## Информация из раздела CheckStateUrl(настройки Url для проверки состояния задачи) задачи в планировщике - атрибут справочника "CheckStateUrl";
## Имя пользователя - атрибут справочника "UserName";  
+
## Дата последнего запуска задачи - атрибут справочника "LastStartDate";
# '''Справочник список действий (AuditingAction)''' - в нем содержится перечень действий, которые используются в аудите.
+
## Guid - атрибут справочника "Guid";
# '''Справочник взаимодействия с объектами (Entries)''' - в нем содержится информация о:<br>
+
## Статус выполнения задачи - атрибут справочника "State";
## Сессии - атрибут справочника "Сессия" (может быть связанным со справочником Sessions);
+
## Отметка о включении задачи - атрибут справочника "IsEnable";
## Дате выполнения действия - атрибут справочника "Дата действия";
+
## Расписание задачи - атрибут справочника "Schedule";
## Действие пользователя - атрибут справочника "Действие"(может быть связанным со справочником AuditingAction);
+
## Тип задачи - атрибут справочника "Discriminator";
## Идентификаторе объекта в 3V - атрибут справочника "Идентификатор объекта";
+
## Настройка аутентификации задачи - атрибут справочника "AuthenticationSettingsId";
## Наименование объекта в 3V- атрибут справочника "Наименование объекта";
+
## Сообщение об ошибки- атрибут справочника "ErrorMessage";
## Сообщении о действиях - атрибут справочника "Сообщение";
+
## Идентификаторы задач для цепочки задач - атрибут справочника "ChainTaskIds";
## JSON - атрибут справочника "JSON";
+
## Статусы цепочки задач - атрибут справочника "ChainTaskStates";
 +
# '''Справочник настроек аутентификаций (AuthenticationSettings)''' - в нем содержится перечень настроек аутентификаций которые содержаться в планировщике.<br>
 +
## Идентификатор настройки аутентификации  - атрибут справочника "Id";
 +
## Наименование настройки аутентификации - атрибут справочника "Name";
 +
## Адрес по которому можно запросить токен - атрибут справочника "TokenRequestUrl";
 +
## Идентификатор клиента для которого запрашиваем токен - атрибут справочника "ClientId";
 +
## Секрет клиента для которого запрашиваем токен - атрибут справочника "ClientSecret";
 +
# '''Справочник состояния задач (TaskState)''' - в нем содержится информация о состоянии задач. <br>
 
Для создания Внешнего справочника нажмите кнопку '''"Создать"''' и выберите '''"Внешний справочник"'''. Далее откройте созданный вами справочник и зайдите в '''"Конструктор"'''. <br>
 
Для создания Внешнего справочника нажмите кнопку '''"Создать"''' и выберите '''"Внешний справочник"'''. Далее откройте созданный вами справочник и зайдите в '''"Конструктор"'''. <br>
 
В '''"Конструкторе"''' в поле '''"Соединение"''' укажите созданное ранее соединение с источником, а в поле '''"Идентификатор объекта"''' выберете один из предложенных идентификаторов (для одного справочника можно добавить только один объект). После настройки соединения нажмите кнопку '''"Загрузить"''', отобразятся атрибуты справочника, вы можете дополнительно настроить их, более подробно о настройке справочника вы можете прочитать [[Платформа_3V/Внешний_справочник|здесь]]. После всех необходимых настроек нажмите на кнопку '''"Готово"'''.
 
В '''"Конструкторе"''' в поле '''"Соединение"''' укажите созданное ранее соединение с источником, а в поле '''"Идентификатор объекта"''' выберете один из предложенных идентификаторов (для одного справочника можно добавить только один объект). После настройки соединения нажмите кнопку '''"Загрузить"''', отобразятся атрибуты справочника, вы можете дополнительно настроить их, более подробно о настройке справочника вы можете прочитать [[Платформа_3V/Внешний_справочник|здесь]]. После всех необходимых настроек нажмите на кнопку '''"Готово"'''.
[[Файл:создание внешнего справочника аудита.gif|слева]]<br clear="both" /><br>
 
  
 
== Настройка отчета ==
 
== Настройка отчета ==
 
После создания и настройки справочников следует создать отчет на справочнике. Для создания отчета нажмите на кнопку '''"Создать"''' и выберите '''"Отчет"'''.<br>
 
После создания и настройки справочников следует создать отчет на справочнике. Для создания отчета нажмите на кнопку '''"Создать"''' и выберите '''"Отчет"'''.<br>
 
В отчете вы можете самостоятельно выбрать и настроить поля, а так же добавить собственные параметры. Узнать более подробную информацию о настройках отчета вы можете [[Платформа_3V/Отчет|здесь]].
 
В отчете вы можете самостоятельно выбрать и настроить поля, а так же добавить собственные параметры. Узнать более подробную информацию о настройках отчета вы можете [[Платформа_3V/Отчет|здесь]].
[[Файл:отчет по аудиту.png|слева|750px|border]]<br clear="both" /><br>
+
[[Файл:Отчет по загрузке задач.png|слева|750px|border]]<br clear="both" /><br>

Текущая версия на 10:11, 14 февраля 2022

Вы можете скачать уже настроенные объекты для получения задач планировщика или создать объекты самостоятельно.

Объекты

Для получения информации о состоянии задач планировщика вам понадобится несколько объектов:

  1. Соединение с источником
  2. Внешние справочники
  3. Отчет

Для настройки получения задач планировщика необходимо создать и настроить каждый из этих объектов.

Настройка соединения с источником

Создайте новое "Соединение с источником" для этого нажмите кнопку "Создать" и выберете пункт "Соединение с источником".
Далее откройте "Редактор" в правой панели навигатора и добавьте JSON описание соединения:

  • dbType - тип соединения для планировщика используется "Web",
  • connectionString - адрес для подключения: "http://scheduler/api/SchedulerDataSource/",
  • id - идентификатор соединения (при создании нового Соединения его идентификатор отобразится в столбце "Идентификатор")
  • name - наименование соединения
Пример описания соединения в формате JSON
1 {
2   "dbType": "Web",
3   "connectionString": "http://scheduler/api/SchedulerDataSource/",
4   "id": 1559,
5   "name": "Соединение с планировщиком"
6 }

Пример настройки соединения:

Соединение с планировщиком.png



Настройка внешних справочников

После настройки соединения с источником необходимо создать и настроить несколько внешних справочников. Для настройки связи с планировщиком используются следующие справочники:

  1. Справочник задач планировщика (ScheduledTask) - в нем содержится информация о задачах планировщика, их описание, статус запуска, сообщение об ошибках.
    1. Идентификатор задачи в планировщике - атрибут справочника "Id";
    2. Наименование задачи в планировщике - атрибут справочника "Name";
    3. Информация из раздела RunUrl(настройки Url для запуска задачи) задачи в планировщике - атрибут справочника "RunUrl";
    4. Информация из раздела CheckStateUrl(настройки Url для проверки состояния задачи) задачи в планировщике - атрибут справочника "CheckStateUrl";
    5. Дата последнего запуска задачи - атрибут справочника "LastStartDate";
    6. Guid - атрибут справочника "Guid";
    7. Статус выполнения задачи - атрибут справочника "State";
    8. Отметка о включении задачи - атрибут справочника "IsEnable";
    9. Расписание задачи - атрибут справочника "Schedule";
    10. Тип задачи - атрибут справочника "Discriminator";
    11. Настройка аутентификации задачи - атрибут справочника "AuthenticationSettingsId";
    12. Сообщение об ошибки- атрибут справочника "ErrorMessage";
    13. Идентификаторы задач для цепочки задач - атрибут справочника "ChainTaskIds";
    14. Статусы цепочки задач - атрибут справочника "ChainTaskStates";
  2. Справочник настроек аутентификаций (AuthenticationSettings) - в нем содержится перечень настроек аутентификаций которые содержаться в планировщике.
    1. Идентификатор настройки аутентификации - атрибут справочника "Id";
    2. Наименование настройки аутентификации - атрибут справочника "Name";
    3. Адрес по которому можно запросить токен - атрибут справочника "TokenRequestUrl";
    4. Идентификатор клиента для которого запрашиваем токен - атрибут справочника "ClientId";
    5. Секрет клиента для которого запрашиваем токен - атрибут справочника "ClientSecret";
  3. Справочник состояния задач (TaskState) - в нем содержится информация о состоянии задач.

Для создания Внешнего справочника нажмите кнопку "Создать" и выберите "Внешний справочник". Далее откройте созданный вами справочник и зайдите в "Конструктор".
В "Конструкторе" в поле "Соединение" укажите созданное ранее соединение с источником, а в поле "Идентификатор объекта" выберете один из предложенных идентификаторов (для одного справочника можно добавить только один объект). После настройки соединения нажмите кнопку "Загрузить", отобразятся атрибуты справочника, вы можете дополнительно настроить их, более подробно о настройке справочника вы можете прочитать здесь. После всех необходимых настроек нажмите на кнопку "Готово".

Настройка отчета

После создания и настройки справочников следует создать отчет на справочнике. Для создания отчета нажмите на кнопку "Создать" и выберите "Отчет".
В отчете вы можете самостоятельно выбрать и настроить поля, а так же добавить собственные параметры. Узнать более подробную информацию о настройках отчета вы можете здесь.

Отчет по загрузке задач.png