Автоматизация

1

Данный раздел предназначен для настройки заданий автоматизации и доступен только для узлов [[Платформа НЕЙРОСС>>neyross.WebHome]].

2

3

4

**Переход к функционалу**:

5

6

* С версии 20.40 ~[[[doc:ui.Рабочий стол НЕЙРОСС.Изменения интерфейса НЕЙРОСС.WebHome]]]: [[doc:ui.Рабочий стол НЕЙРОСС.WebHome]] > [[doc:ui.Параметры узла.WebHome]] > Автоматизация.

7

* До версии 20.39 включительно: [[doc:ui.Рабочий стол НЕЙРОСС.WebHome]] > Конфигурация узлов > Автоматизация.

8

9

10

== {{id name="Автоматизация-Общиесведения"/}}Общие сведения ==

11

12

Платформа НЕЙРОСС обеспечивает автоматическое выполнение заданий автоматизации по факту возникновения какого-либо внутреннего или внешнего события или по фиксированному расписанию. Это может быть информирование ответственных лиц (по электронной почте или в канал Telegram), автоматические действия в системе (в том числе, — взаимодействие с «внешней» системой). Возможны сложные условия запуска задания автоматизации (выполнение нескольких условий, накопление определённого количества сигналов, либо наоборот — отсутствие сигналов). Предусмотрена возможность тестирования выполнения задания без ожидания выполнения входного условия.

13

14

15

**Задание автоматизации** — это совокупность действия с сигналом, по которому это действие может выполняться. Есть набор предустановленных типов сигналов и типов действий. Задание автоматизации может быть сформировано по любому сигналу или набору сигналов — событию в Платформе НЕЙРОСС или событию сети НЕЙРОСС, которое проходит [[входной фильтр событий.>>doc:ui.Параметры узла.Дополнительные настройки.WebHome||anchor="Дополнительныенастройки-Входнойфильтрсобытий"]]

**ВАЖНО**

Выполнение задач автоматизации осуществляется от имени пользователя НЕЙРОСС. Предварительно настройте учётную запись пользователя, задайте требуемые права на управление и укажите учётную запись в качестве пользователя автоматизации ~[[[neyross.Настройка Платформы НЕЙРОСС.Настройка заданий автоматизации.WebHome]]].

22

23

24

[[image:attach:ui.Параметры узла.WebHome@content.png||thumbnail="true" height="10"]] Содержание:

{{excerpt-include nopanel="true" 0="ui.Параметры узла.Автоматизация.Сигналы автоматизации.WebHome"/}}

29

30

{{excerpt-include nopanel="true" 0="ui.Параметры узла.Автоматизация.Действия автоматизации.WebHome"/}}

31

32

== {{id name="Автоматизация-Окнораздела"/}}Окно раздела ==

33

34

[[image:attach:s_automat_conf_wnd.png||width="900"]]

35

36

1. (((

37

**Список заданий**: перечень имеющихся заданий; если наименование задания не задано, после номера задания через вертикальную черту указывается тип сигнала и тип действия. Иконка задания отображает его статус. Список статусов см. в таблице ниже.

|=(((

Цвет иконки

)))|=(((

Статус задания

)))|=(((

Комментарий

)))

|(% class="highlight-green" title="Цвет фона: Зеленый" style="background-color: #e3fcef" %)(((

Зелёный

)))|(((

Активно

)))|(((

Задание успешно прошло проверку при запуске (инициализацию), выполняется. в ходе выполнения ошибок не возникало.

52

)))

53

|(% class="highlight-yellow" title="Цвет фона: Желтый" style="background-color: #fffae6" %)(((

54

Оранжевый

55

)))|(((

56

Активно, в ходе выполнения возникали ошибки

57

)))|(((

58

Задание успешно прошло проверку при запуске (инициализацию), выполняется, в ходе выполнения возникали ошибки. Данные по ошибкам можно просмотреть в системном журнале, либо на вкладке Диагностика. Дана ссылка на описание последней выявленной ошибки.

59

)))

60

|(% class="highlight-red" title="Цвет фона: Красный" style="background-color: #ffebe6" %)(((

Красный

)))|(((

Ошибка инициализации

)))|(((

На этапе первичной проверки (инициализации) задания возникли ошибки: неверно заданы параметры задания. Задание не выполняется.

66

)))

67

|(% class="highlight-grey" title="Цвет фона: Серый" style="background-color: #f4f5f7" %)(((

Серый

)))|(((

Отключено

)))|(((

Задание не выполняется, остановлено пользователем вручную.

73

)))

74

75

**Команды управления списком заданий**: Добавить задание [[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.АРМ НЕЙРОСС Доступ.Уровни доступа.WebHome@fa-copy.png||thumbnail="true" height="21"]] для возможности создания нового на основе старого.

76

)))

77

1. (((

78

**Общая информация о задании**: перечень параметров приведён в таблице ниже:

|=(((

Параметр

)))|=(((

Значение

)))|=(((

Комментарий

)))

|(((

Название

)))|(((

Текстовое поле

)))|(((

Наименование задания; если задано, оно указывается в списке заданий [1].

)))

|(((

Статус

)))|(((

* активно (включено)

* отключено

* ошибка инициализации

100

)))|(((

101

(((

102

Текущий статус задания, статус отмечается цветом иконке задания в списке [1]. По факту сохранения задания автоматизации выполняется его инициализация. При возникновении ошибок заданию в списке [1] присваивается иконка красного цвета, задание не выполняется, ошибка фиксируется в Системном журнале. Для просмотра текста ошибки предоставляется ссылка.

103

104

[[image:attach:task_error.png||width="600"]]

105

106

[[image:attach:task_error_journal.png||width="800"]]

)))

)))

|(((

Успешно обработанных сигналов

111

)))|(((

112

Число успешно обработанных сигналов (выполненных действий)

113

)))|(((

114

Ведётся статистика выполнения задания (учёт количества сигналов, приведших к срабатыванию задания автоматизации). Сигнал является успешно обработанным, если действие, заданное в задании, выполнено успешно, не выявлено ошибок. Указывается общее количество успешно обработанных сигналов и время выполнения последнего. Для сброса счётчика нажмите на кнопку **Очистить статистику**.

115

)))

116

|(((

117

Сигналов, обработанных с ошибкой

118

)))|(((

119

Число сигналов, действие по которым не удалось успешно выполнить

120

)))|(((

121

(((

122

Ведётся статистика выполнения задания (учёт количества сигналов, приведших к срабатыванию задания автоматизации). Сигнал является обработанным с ошибкой, если выполнение действия, заданного в задании, привело к возникновению ошибки. Указывается общее количество таких сигналов и время возникновения последней ошибки. Описание всех ошибок можно просмотреть в Системном журнале. Дана ссылка на описание последней найденной ошибки.

123

[[image:attach:task_stat.png||width="600"]]

124

[[image:attach:action_journal.png||width="800"]]

)))

)))

)))

1. **Параметры сигнала**: предустановлено четыре типа сигнала: по расписанию, по событию, по HTTP-запросу, по системному действию (отмеченному записью в Системном журнале);

129

1. **Параметры действия**: предустановлено семь типов действий: команда управления, отправка письма на email, отправка отчёта на email, Telegram-уведомление, произвольный скрипт, HTTP-запрос, логирование.

130

**Выполнить тест**: команда запускает задание на выполнение немедленно, вне зависимости от указанного расписания или наличия события; используется для тестирования правильности настройки параметров (не учитывается в статистике выполнения задания). В качестве альтернативы для целей тестирования можно использовать эмуляцию входного http-запроса, при этом количество выполненных заданий увеличивается на единицу.

131

1. (((

132

**Команды управления заданием:

**

|=(((

Команда

)))|=(((

Комментарий

)))

|(((

Выключить

)))|(((

Остановить выполнение задания. Сделать задание неактивным.

)))

|(((

Включить

)))|(((

Возобновить выполнение задания. Сделать задание активным. Задание будет выполняться согласно собственному условию запуска. Будет возобновлено ведение статистики задания.

)))

|(((

Сбросить статистику

)))|(((

Обнулить данные в полях //Успешно обработанных сигналов//, //Сигналов, обработанных с ошибкой//.

154

)))

155

)))

156

1. **Импорт и экспорт **параметров задания автоматизации ~[[[#Импорт и экспорт заданий автоматизации>>doc:||anchor="Автоматизация-Импортиэкспортзаданийавтоматизации"]]]

157

1. **Диагностика**: на вкладке //Диагностика// вы можете в режиме «живого» журнала отследить результат выполнения всех активных заданий автоматизации.

158

[[image:attach:action_diagnosys.png||width="700"]]

159

160

== {{id name="Автоматизация-Управлениезаданиямиавтоматизации"/}}Управление заданиями автоматизации ==

161

162

Чтобы //**создать** //задание автоматизации:

163

164

1. В списке заданий [1] нажмите на кнопку **Добавить новое задание** [[image:attach:btn_plus_new.png||thumbnail="true" width="18"]].

165

[[image:attach:action_newtask.png]]

166

1. В блоке **Общая информация** [2] в поле **Название** укажите наименование нового задания, если требуется. Оно будет отображаться в списке заданий. Если название не задано, то в списке будет отображаться номер задания, заданный тип сигнала и тип действия.

167

1. (((

168

В блоке **Параметры сигнала** [3] выберите из раскрывающегося списка требуемый тип сигнала и задайте дополнительные параметры.

|=(((

Тип сигнала

)))|=(((

Комментарий

)))

|(((

[[По расписанию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по расписанию.WebHome]]

177

)))|(((

178

Если задание требуется выполнять в определённое время или с определённой периодичностью вне зависимости от событий в системе, в поле **Тип сигнала** выберите **По расписанию**, настройте расписание запуска задания

179

)))

180

|(((

181

[[По событию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по событию.WebHome]]

182

)))|(((

183

Если задание требуется выполнять по какому-либо событию от какого-либо источника событий в системе, в поле **Тип сигнала** выберите **По событию** и настройте фильтр событий.

184

)))

185

|(((

186

[[По системному действию>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по сообщению системного журнала.WebHome]]

187

)))|(((

188

Если задание следует запускать по произвольному событию, регистрируемому в Системном журнале Платформы НЕЙРОСС, в поле **Тип сигнала** выберите **По системному действию** и задайте параметры записи.

189

)))

190

|(((

191

[[Группа сигналов>>doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: группа сигналов.WebHome]]

192

)))|(((

193

Если задание следует запускать при накоплении определённого количества событий, либо по причине отсутствия событий, а также при выполнения целой последовательности условий, в поле **Тип сигнала** выберите **Группа сигналов**, настройте параметры группы.

194

)))

195

|(((

196

[[doc:ui.Параметры узла.Автоматизация.Сигналы автоматизации.Тип сигнала\: по HTTP-запросу.WebHome]]

197

)))|(((

198

Если задание следует запускать по команде из внешней системы, в поле **Тип сигнала** выберите **По HTTP-запросу**, скопируйте предложенную строку и сформируйте http-запрос.

)))

)))

1. (((

В блоке **Параметры действия** [4] выберите из раскрывающегося списка требуемый тип действия и задайте дополнительные параметры.\\

|=(((

Тип действия

)))|=(((

Комментарий

)))

|(((

[[Команда управления>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: команда управления.WebHome]]

211

)))|(((

212

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления.

213

)))

214

|(((

215

[[Отправка письма на email>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: отправка письма по email.WebHome]]

216

)))|(((

217

Если по сигналу требуется отправить уведомительное письмо по электронной почте, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления.

218

)))

219

|(((

220

[[Отправка отчёта на email>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: отправка отчёта по email.WebHome]]

221

)))|(((

222

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Команда управления**, настройте список элементов и команд управления.

223

)))

224

|(((

225

[[Telegram-уведомление>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: Telegram-уведомление.WebHome]]

226

)))|(((

227

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Отправка письма по email**, настройте параметры сообщения.

228

)))

229

|(((

230

[[Пользовательский скрипт>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: пользовательский скрипт.WebHome]]

231

)))|(((

232

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Отправка отчёта по email**, настройте параметры сообщения и параметры отчёта.

233

)))

234

|(((

235

[[HTTP-запрос>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: HTTP-запрос.WebHome]]

236

)))|(((

237

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **HTTP запрос**, укажите параметры запроса.

238

)))

239

|(((

240

[[Счётчик пропусков>>doc:ui.Параметры узла.Автоматизация.Действия автоматизации.Тип действия\: счётчик пропусков.WebHome]]

241

)))|(((

242

Если по сигналу требуется отправить команды управления элементам, в поле **Тип действия** выберите **Счётчик пропусков**, укажите название счётчика.

243

)))

244

)))

245

1. Нажмите на кнопку **Создать новое задание**.

246

1. (((

247

При необходимости проверки действия задания, нажмите **выполнить тест**.

**ВНИМАНИЕ**

Команда **выполнить тест** запускает на выполнение действия, заданные в задании. В зависимости от параметров задания, будет произведена попытка выполнения команд управления, либо отправлено письмо/Telegram-уведомление. Если задание создано для запуска по событию и в шаблоне письма/уведомления заданы переменные, относящиеся к источнику события, то в тестовом сообщении данные поля будут пустыми.

253

254

Команда доступа только для включенных заданий автоматизации.

)))

Чтобы **//приостановить//** выполнения задания, нажмите на кнопку **Выключить**. Для возобновления — нажмите на кнопку **Включить**.

259

260

Чтобы //**удалить задание**//, наведите указатель мыши на имя задания в списке заданий [1] и нажмите на кнопку [[image:attach:btn_del_new.png||thumbnail="true" height="15"]]** Удалить задание**, расположенную в строке задания.

261

262

Чтобы **//создать новое задание на основе имеющегося//**, наведите указатель мыши на имя задания в списке заданий [1] и нажмите на кнопку [[image:attach:neyross.АРМ НЕЙРОСС Доступ.Уровни управления.WebHome@fa-copy.png||thumbnail="true" width="18"]]** Копировать задание**, расположенную в строке задания. повторите шаги пп.2-6 инструкции выше.

263

264

== {{id name="Автоматизация-Импортиэкспортзаданийавтоматизации"/}}Импорт и экспорт заданий автоматизации(%%) ==

265

266

С версии Платформы НЕЙРОСС 20.5.757 реализована возможность передачи заданий автоматизации с одного узла Платформа НЕЙРОСС на другой.

**Экспорт**

Чтобы выполнить экспорт задания автоматизации, то есть сохранить набор параметров в файле формата JSON:

271

272

1. В списке заданий [1] выберите задание, параметры которого требуется сохранить.

273

1. (((

274

В карточке задания нажмите на кнопку **Экспорт **[6]. Будет сформирован файл, содержащий сведения о номере задания и его названии вида:

275

276

277

задание_автоматизации_№1__ По расписанию → Команда управления.json

278

279

280

и сохранён в папку загрузок браузера.

281

)))

282

1. Сохраните файл на надёжном носителе и, при необходимости, передайте лицу, осуществляющему импорт на другом узле Платформа НЕЙРОСС.

\\

**Импорт**

Чтобы выполнить импорт задания автоматизации:

289

290

1. В списке заданий [1] нажмите на кнопку **Добавить новое задание** [[image:attach:btn_plus_new.png||thumbnail="true" width="18"]].

291

1. В карточке задания нажмите на кнопку **Импорт** [6].

292

[[image:attach:action_newtask.png]]

293

1. Укажите путь к сформированному на этапе экспорта файлу формата JSON. Параметры задания будут отображены в карточке задания.

294

1. (((

295

При необходимости, откорректируйте параметры и нажмите на кнопку **Создать новое задание**.

296

297

298

Вследствие разницы в конфигурации разных узлов Платформа НЕЙРОСС (отличается список элементов, фильтры) часто бывает необходима корректировка параметров задания автоматизации перед его запуском.

299

300

)))

Wiki source code of Автоматизация