Исходный код вики Автоматизация
Скрыть последних авторов
| author | version | line-number | content |
|---|---|---|---|
 |
4.1 | 1 | Данный раздел предназначен для настройки заданий автоматизации и доступен только для узлов [[Платформа НЕЙРОСС>>neyross.WebHome]]. |
| |
1.1 | 2 | |
| 3 | {{info}} | ||
| |
11.9 | 4 | **Переход к функционалу**: [[doc:ui.Рабочий стол НЕЙРОСС.WebHome]] > [[doc:ui.Параметры узла.WebHome]] > Автоматизация ~[[[doc:ui.Рабочий стол НЕЙРОСС.ui-changes.WebHome]]]. |
| |
1.1 | 5 | {{/info}} |
| 6 | |||
| |
7.1 | 7 | == Общие сведения == |
| 8 | |||
| |
1.1 | 9 | Платформа НЕЙРОСС обеспечивает автоматическое выполнение заданий автоматизации по факту возникновения какого-либо внутреннего или внешнего события или по фиксированному расписанию. Это может быть информирование ответственных лиц (по электронной почте или в канал Telegram), автоматические действия в системе (в том числе, — взаимодействие с «внешней» системой). Возможны сложные условия запуска задания автоматизации (выполнение нескольких условий, накопление определённого количества сигналов, либо наоборот — отсутствие сигналов). Предусмотрена возможность тестирования выполнения задания без ожидания выполнения входного условия. |
| 10 | |||
| 11 | {{info}} | ||
| 12 | **Задание автоматизации** — это совокупность действия с сигналом, по которому это действие может выполняться. Есть набор предустановленных типов сигналов и типов действий. Задание автоматизации может быть сформировано по любому сигналу или набору сигналов — событию в Платформе НЕЙРОСС или событию сети НЕЙРОСС, которое проходит [[входной фильтр событий.>>doc:ui.Параметры узла.Дополнительные настройки.WebHome||anchor="Дополнительныенастройки-Входнойфильтрсобытий"]] | ||
| 13 | {{/info}} | ||
| 14 | |||
| 15 | {{error}} | ||
| 16 | **ВАЖНО** | ||
| 17 | |||
| |
11.8 | 18 | Выполнение задач автоматизации осуществляется от имени пользователя НЕЙРОСС. Предварительно настройте учётную запись пользователя, задайте требуемые права на управление и укажите учётную запись в качестве пользователя автоматизации ~[[[neyross.setup.automation-tasks.WebHome]]]. |
| |
1.1 | 19 | {{/error}} |
| 20 | |||
| 21 | |||
| |
6.4 | 22 | |=(% scope="row" %)[[Сигналы автоматизации>>doc:.Сигналы автоматизации.WebHome]]|Перечень возможных типов сигналов для запуска задания автоматизации. |
| |
6.5 | 23 | |=[[Действия автоматизации>>doc:.Действия автоматизации.WebHome]]|Перечень возможных действий заданий автоматизации. |
| |
1.1 | 24 | |
| |
6.3 | 25 | == Окно раздела == |
| |
1.1 | 26 | |
| 27 | [[image:attach:s_automat_conf_wnd.png||width="900"]] | ||
| 28 | |||
| 29 | 1. ((( | ||
| 30 | **Список заданий**: перечень имеющихся заданий; если наименование задания не задано, после номера задания через вертикальную черту указывается тип сигнала и тип действия. Иконка задания отображает его статус. Список статусов см. в таблице ниже. | ||
| 31 | |||
| 32 | |=((( | ||
| 33 | Цвет иконки | ||
| 34 | )))|=((( | ||
| 35 | Статус задания | ||
| 36 | )))|=((( | ||
| 37 | Комментарий | ||
| 38 | ))) | ||
| |
6.3 | 39 | |(% class="highlight-green" style="background-color:#e3fcef" title="Цвет фона: Зеленый" %)((( |
| |
4.1 | 40 | Зелёный |
| |
1.1 | 41 | )))|((( |
| 42 | Активно | ||
| 43 | )))|((( | ||
| 44 | Задание успешно прошло проверку при запуске (инициализацию), выполняется. в ходе выполнения ошибок не возникало. | ||
| 45 | ))) | ||
| |
6.3 | 46 | |(% class="highlight-yellow" style="background-color:#fffae6" title="Цвет фона: Желтый" %)((( |
| |
4.1 | 47 | Оранжевый |
| |
1.1 | 48 | )))|((( |
| |
4.1 | 49 | Активно, в ходе выполнения возникали ошибки |
| |
1.1 | 50 | )))|((( |
| 51 | Задание успешно прошло проверку при запуске (инициализацию), выполняется, в ходе выполнения возникали ошибки. Данные по ошибкам можно просмотреть в системном журнале, либо на вкладке Диагностика. Дана ссылка на описание последней выявленной ошибки. | ||
| 52 | ))) | ||
| |
6.3 | 53 | |(% class="highlight-red" style="background-color:#ffebe6" title="Цвет фона: Красный" %)((( |
| |
4.1 | 54 | Красный |
| |
1.1 | 55 | )))|((( |
| 56 | Ошибка инициализации | ||
| 57 | )))|((( | ||
| 58 | На этапе первичной проверки (инициализации) задания возникли ошибки: неверно заданы параметры задания. Задание не выполняется. | ||
| 59 | ))) | ||
| |
6.3 | 60 | |(% class="highlight-grey" style="background-color:#f4f5f7" title="Цвет фона: Серый" %)((( |
| |
4.1 | 61 | Серый |
| |
1.1 | 62 | )))|((( |
| 63 | Отключено | ||
| 64 | )))|((( | ||
| 65 | Задание не выполняется, остановлено пользователем вручную. | ||
| 66 | ))) | ||
| 67 | |||
| |
11.4 | 68 | **Команды управления списком заданий**: Добавить задание [[image:attach:btn_plus_new.png||thumbnail="true" width="18"]], Поиск по списку заданий[[image:attach:fa-search.png||thumbnail="true" width="18"]], удалить задание [[image:attach:btn_del_new.png||thumbnail="true" height="15"]], копировать задание[[image:attach:neyross.arm-access.access-levels.WebHome@fa-copy.png||thumbnail="true" height="21"]] для возможности создания нового на основе старого. |
| |
1.1 | 69 | ))) |
| 70 | 1. ((( | ||
| 71 | **Общая информация о задании**: перечень параметров приведён в таблице ниже: | ||
| 72 | |||
| 73 | |=((( | ||
| 74 | Параметр | ||
| 75 | )))|=((( | ||
| 76 | Значение | ||
| 77 | )))|=((( | ||
| 78 | Комментарий | ||
| 79 | ))) | ||
| 80 | |((( | ||
| 81 | Название | ||
| 82 | )))|((( | ||
| 83 | Текстовое поле | ||
| 84 | )))|((( | ||
| 85 | Наименование задания; если задано, оно указывается в списке заданий [1]. | ||
| 86 | ))) | ||
| 87 | |((( | ||
| 88 | Статус | ||
| 89 | )))|((( | ||
| 90 | * активно (включено) | ||
| 91 | * отключено | ||
| 92 | * ошибка инициализации | ||
| 93 | )))|((( | ||
| 94 | ((( | ||
| 95 | Текущий статус задания, статус отмечается цветом иконке задания в списке [1]. По факту сохранения задания автоматизации выполняется его инициализация. При возникновении ошибок заданию в списке [1] присваивается иконка красного цвета, задание не выполняется, ошибка фиксируется в Системном журнале. Для просмотра текста ошибки предоставляется ссылка. | ||
| 96 | |||
| 97 | [[image:attach:task_error.png||width="600"]] | ||
| 98 | |||
| 99 | [[image:attach:task_error_journal.png||width="800"]] | ||
| 100 | ))) | ||
| 101 | ))) | ||
| 102 | |((( | ||
| 103 | Успешно обработанных сигналов | ||
| 104 | )))|((( | ||
| 105 | Число успешно обработанных сигналов (выполненных действий) | ||
| 106 | )))|((( | ||
| 107 | Ведётся статистика выполнения задания (учёт количества сигналов, приведших к срабатыванию задания автоматизации). Сигнал является успешно обработанным, если действие, заданное в задании, выполнено успешно, не выявлено ошибок. Указывается общее количество успешно обработанных сигналов и время выполнения последнего. Для сброса счётчика нажмите на кнопку **Очистить статистику**. | ||
| 108 | ))) | ||
| 109 | |((( | ||
| 110 | Сигналов, обработанных с ошибкой | ||
| 111 | )))|((( | ||
| 112 | Число сигналов, действие по которым не удалось успешно выполнить | ||
| 113 | )))|((( | ||
| 114 | ((( | ||
| 115 | Ведётся статистика выполнения задания (учёт количества сигналов, приведших к срабатыванию задания автоматизации). Сигнал является обработанным с ошибкой, если выполнение действия, заданного в задании, привело к возникновению ошибки. Указывается общее количество таких сигналов и время возникновения последней ошибки. Описание всех ошибок можно просмотреть в Системном журнале. Дана ссылка на описание последней найденной ошибки. | ||
| 116 | [[image:attach:task_stat.png||width="600"]] | ||
| 117 | [[image:attach:action_journal.png||width="800"]] | ||
| 118 | ))) | ||
| 119 | ))) | ||
| 120 | ))) | ||
| 121 | 1. **Параметры сигнала**: предустановлено четыре типа сигнала: по расписанию, по событию, по HTTP-запросу, по системному действию (отмеченному записью в Системном журнале); | ||
| 122 | 1. **Параметры действия**: предустановлено семь типов действий: команда управления, отправка письма на email, отправка отчёта на email, Telegram-уведомление, произвольный скрипт, HTTP-запрос, логирование. | ||
| 123 | **Выполнить тест**: команда запускает задание на выполнение немедленно, вне зависимости от указанного расписания или наличия события; используется для тестирования правильности настройки параметров (не учитывается в статистике выполнения задания). В качестве альтернативы для целей тестирования можно использовать эмуляцию входного http-запроса, при этом количество выполненных заданий увеличивается на единицу. | ||
| 124 | 1. ((( | ||
| |
6.3 | 125 | **Команды управления заданием:** |
| |
1.1 | 126 | |
| 127 | |=((( | ||
| 128 | Команда | ||
| 129 | )))|=((( | ||
| 130 | Комментарий | ||
| 131 | ))) | ||
| 132 | |((( | ||
| 133 | Выключить | ||
| 134 | )))|((( | ||
| 135 | Остановить выполнение задания. Сделать задание неактивным. | ||
| 136 | ))) | ||
| 137 | |((( | ||
| 138 | Включить | ||
| 139 | )))|((( | ||
| 140 | Возобновить выполнение задания. Сделать задание активным. Задание будет выполняться согласно собственному условию запуска. Будет возобновлено ведение статистики задания. | ||
| 141 | ))) | ||
| 142 | |((( | ||
| 143 | Сбросить статистику | ||
| 144 | )))|((( | ||
| 145 | Обнулить данные в полях //Успешно обработанных сигналов//, //Сигналов, обработанных с ошибкой//. | ||
| 146 | ))) | ||
| 147 | ))) | ||
| 148 | 1. **Импорт и экспорт **параметров задания автоматизации ~[[[#Импорт и экспорт заданий автоматизации>>doc:||anchor="Автоматизация-Импортиэкспортзаданийавтоматизации"]]] | ||
| 149 | 1. **Диагностика**: на вкладке //Диагностика// вы можете в режиме «живого» журнала отследить результат выполнения всех активных заданий автоматизации. | ||
| 150 | [[image:attach:action_diagnosys.png||width="700"]] | ||
| 151 | |||
| 152 | == {{id name="Автоматизация-Управлениезаданиямиавтоматизации"/}}Управление заданиями автоматизации == | ||
| 153 | |||
| 154 | Чтобы //**создать** //задание автоматизации: | ||
| 155 | |||
| 156 | 1. В списке заданий [1] нажмите на кнопку **Добавить новое задание** [[image:attach:btn_plus_new.png||thumbnail="true" width="18"]]. | ||
| 157 | 1. В блоке **Общая информация** [2] в поле **Название** укажите наименование нового задания, если требуется. Оно будет отображаться в списке заданий. Если название не задано, то в списке будет отображаться номер задания, заданный тип сигнала и тип действия. | ||
| |
9.1 | 158 | [[image:action_newtask.png||height="431" width="800"]] |
| |
1.1 | 159 | 1. ((( |
| 160 | В блоке **Параметры сигнала** [3] выберите из раскрывающегося списка требуемый тип сигнала и задайте дополнительные параметры. | ||
| 161 | |||
| 162 | |=((( | ||
| 163 | Тип сигнала | ||
| 164 | )))|=((( | ||
| 165 | Комментарий | ||
| 166 | ))) | ||
| 167 | |((( | ||
| 168 | [[По расписанию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по расписанию.WebHome]] | ||
| 169 | )))|((( | ||
| 170 | Если задание требуется выполнять в определённое время или с определённой периодичностью вне зависимости от событий в системе, в поле **Тип сигнала** выберите **По расписанию**, настройте расписание запуска задания | ||
| 171 | ))) | ||
| 172 | |((( | ||
| 173 | [[По событию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по событию.WebHome]] | ||
| 174 | )))|((( | ||
| 175 | Если задание требуется выполнять по какому-либо событию от какого-либо источника событий в системе, в поле **Тип сигнала** выберите **По событию** и настройте фильтр событий. | ||
| 176 | ))) | ||
| 177 | |((( | ||
| 178 | [[По системному действию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по сообщению системного журнала.WebHome]] | ||
| 179 | )))|((( | ||
| 180 | Если задание следует запускать по произвольному событию, регистрируемому в Системном журнале Платформы НЕЙРОСС, в поле **Тип сигнала** выберите **По системному действию** и задайте параметры записи. | ||
| 181 | ))) | ||
| 182 | |((( | ||
| 183 | [[Группа сигналов>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: группа сигналов.WebHome]] | ||
| 184 | )))|((( | ||
| 185 | Если задание следует запускать при накоплении определённого количества событий, либо по причине отсутствия событий, а также при выполнения целой последовательности условий, в поле **Тип сигнала** выберите **Группа сигналов**, настройте параметры группы. | ||
| 186 | ))) | ||
| 187 | |((( | ||
| 188 | [[doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по HTTP-запросу.WebHome]] | ||
| 189 | )))|((( | ||
| 190 | Если задание следует запускать по команде из внешней системы, в поле **Тип сигнала** выберите **По HTTP-запросу**, скопируйте предложенную строку и сформируйте http-запрос. | ||
| 191 | ))) | ||
| 192 | ))) | ||
| 193 | 1. ((( | ||
| |
6.3 | 194 | В блоке **Параметры действия** [4] выберите из раскрывающегося списка требуемый тип действия и задайте дополнительные параметры. |
| |
1.1 | 195 | |
| 196 | |=((( | ||
| 197 | Тип действия | ||
| 198 | )))|=((( | ||
| 199 | Комментарий | ||
| 200 | ))) | ||
| 201 | |((( | ||
| 202 | [[Команда управления>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: команда управления.WebHome]] | ||
| 203 | )))|((( | ||
| 204 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления. | ||
| 205 | ))) | ||
| 206 | |((( | ||
| 207 | [[Отправка письма на email>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: отправка письма по email.WebHome]] | ||
| 208 | )))|((( | ||
| 209 | Если по сигналу требуется отправить уведомительное письмо по электронной почте, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления. | ||
| 210 | ))) | ||
| 211 | |((( | ||
| 212 | [[Отправка отчёта на email>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: отправка отчёта по email.WebHome]] | ||
| 213 | )))|((( | ||
| 214 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления. | ||
| 215 | ))) | ||
| 216 | |((( | ||
| 217 | [[Telegram-уведомление>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: Telegram-уведомление.WebHome]] | ||
| 218 | )))|((( | ||
| 219 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Отправка письма по email**, настройте параметры сообщения. | ||
| 220 | ))) | ||
| 221 | |((( | ||
| 222 | [[Пользовательский скрипт>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: пользовательский скрипт.WebHome]] | ||
| 223 | )))|((( | ||
| 224 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Отправка отчёта по email**, настройте параметры сообщения и параметры отчёта. | ||
| 225 | ))) | ||
| 226 | |((( | ||
| 227 | [[HTTP-запрос>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: HTTP-запрос.WebHome]] | ||
| 228 | )))|((( | ||
| 229 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **HTTP запрос**, укажите параметры запроса. | ||
| 230 | ))) | ||
| 231 | |((( | ||
| 232 | [[Счётчик пропусков>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: счётчик пропусков.WebHome]] | ||
| 233 | )))|((( | ||
| 234 | Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Счётчик пропусков**, укажите название счётчика. | ||
| 235 | ))) | ||
| 236 | ))) | ||
| 237 | 1. Нажмите на кнопку **Создать новое задание**. | ||
| 238 | 1. ((( | ||
| 239 | При необходимости проверки действия задания, нажмите **выполнить тест**. | ||
| 240 | |||
| 241 | {{error}} | ||
| 242 | **ВНИМАНИЕ** | ||
| 243 | |||
| 244 | Команда **выполнить тест** запускает на выполнение действия, заданные в задании. В зависимости от параметров задания, будет произведена попытка выполнения команд управления, либо отправлено письмо/Telegram-уведомление. Если задание создано для запуска по событию и в шаблоне письма/уведомления заданы переменные, относящиеся к источнику события, то в тестовом сообщении данные поля будут пустыми. | ||
| 245 | |||
| 246 | Команда доступа только для включенных заданий автоматизации. | ||
| 247 | {{/error}} | ||
| 248 | ))) | ||
| 249 | |||
| 250 | Чтобы **//приостановить//** выполнения задания, нажмите на кнопку **Выключить**. Для возобновления — нажмите на кнопку **Включить**. | ||
| 251 | |||
| 252 | Чтобы //**удалить задание**//, наведите указатель мыши на имя задания в списке заданий [1] и нажмите на кнопку [[image:attach:btn_del_new.png||thumbnail="true" height="15"]]** Удалить задание**, расположенную в строке задания. | ||
| 253 | |||
| |
11.5 | 254 | Чтобы **//создать новое задание на основе имеющегося//**, наведите указатель мыши на имя задания в списке заданий [1] и нажмите на кнопку [[image:attach:neyross.arm-access.control-levels.WebHome@fa-copy.png||thumbnail="true" width="18"]]** Копировать задание**, расположенную в строке задания. повторите шаги пп.2-6 инструкции выше. |
| |
1.1 | 255 | |
| |
6.3 | 256 | == {{id name="Автоматизация-Импортиэкспортзаданийавтоматизации"/}}Импорт и экспорт заданий автоматизации == |
| |
1.1 | 257 | |
| 258 | С версии Платформы НЕЙРОСС 20.5.757 реализована возможность передачи заданий автоматизации с одного узла Платформа НЕЙРОСС на другой. | ||
| 259 | |||
| 260 | **Экспорт** | ||
| 261 | |||
| 262 | Чтобы выполнить экспорт задания автоматизации, то есть сохранить набор параметров в файле формата JSON: | ||
| 263 | |||
| 264 | 1. В списке заданий [1] выберите задание, параметры которого требуется сохранить. | ||
| 265 | 1. ((( | ||
| 266 | В карточке задания нажмите на кнопку **Экспорт **[6]. Будет сформирован файл, содержащий сведения о номере задания и его названии вида: | ||
| 267 | |||
| |
11.6 | 268 | {{code language="text"}} |
| |
1.1 | 269 | задание_автоматизации_№1__ По расписанию → Команда управления.json |
| 270 | {{/code}} | ||
| 271 | |||
| 272 | и сохранён в папку загрузок браузера. | ||
| 273 | ))) | ||
| 274 | 1. Сохраните файл на надёжном носителе и, при необходимости, передайте лицу, осуществляющему импорт на другом узле Платформа НЕЙРОСС. | ||
| 275 | |||
| 276 | |||
| |
6.3 | 277 | |
| |
1.1 | 278 | **Импорт** |
| 279 | |||
| 280 | Чтобы выполнить импорт задания автоматизации: | ||
| 281 | |||
| 282 | 1. В списке заданий [1] нажмите на кнопку **Добавить новое задание** [[image:attach:btn_plus_new.png||thumbnail="true" width="18"]]. | ||
| 283 | 1. В карточке задания нажмите на кнопку **Импорт** [6]. | ||
| 284 | 1. Укажите путь к сформированному на этапе экспорта файлу формата JSON. Параметры задания будут отображены в карточке задания. | ||
| 285 | 1. ((( | ||
| 286 | При необходимости, откорректируйте параметры и нажмите на кнопку **Создать новое задание**. | ||
| 287 | |||
| 288 | {{info}} | ||
| 289 | Вследствие разницы в конфигурации разных узлов Платформа НЕЙРОСС (отличается список элементов, фильтры) часто бывает необходима корректировка параметров задания автоматизации перед его запуском. | ||
| 290 | {{/info}} | ||
| 291 | ))) |