Сигналы 2.0: различия между версиями
(не показано 10 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
==Базовые понятие и принципы работы== | ==Базовые понятие и принципы работы== | ||
+ | |||
+ | Модуль "Сигналы 2.0" предназначен для автоматизации выполнения повторяющихся задач и процедур. | ||
+ | |||
+ | Общий скрипт - это общая библиотека переменных, используемая всеми обработчиками и триггерами. Инструментарий поддерживает версионность скриптов, в один момент времени активен один общий скрипт. Обработчики и триггеры компилируются в привязке к конкретной версии общего скрипта. | ||
+ | |||
+ | Обработчик - это описание реакции системы на наступление описанного в связанном триггере условия - отправка сообщения/инкрементация счетчика и тому подобное. | ||
+ | |||
+ | Триггер - это описание регистрируемых условий в терминах машинных данных и/или данных формируемых системой/вводимых пользователями. | ||
+ | |||
+ | Запуск одного обработчика может быть инициирован срабатыванием нескольких триггеров. Срабатывание одного триггера может быть ассоциировано с несколькими обработчиками. При этом активная версия общего скрипта всегда одна. Однако, если скрипт или разработчик были скомпилированы на основе устаревшей версии скрипта они будут работоспособны вплоть до декомпиляции. | ||
+ | Поскольку модуль работает с элементами кода DPA, просим внимательно следить за анонсами обновлений. В случае, если обновление будет требовать корректировки и рекомпиляции ранее выданных вам скриптов, мы сообщим об этом. | ||
==Настройка сигнала 2.0== | ==Настройка сигнала 2.0== | ||
Строка 44: | Строка 55: | ||
===Добавление триггера=== | ===Добавление триггера=== | ||
+ | |||
+ | Выберите вкладку "Триггер". | ||
[[File:Trigger 1.PNG | 1000px]] | [[File:Trigger 1.PNG | 1000px]] | ||
+ | |||
+ | Нажмите кнопку "Добавить", заполните поля "Название" и "Описание", укажите следует ли запускать триггер автоматически после перезапуска/перезагрузки сервера. В случае если на момент загрузки триггера в системе настроены обработчики, вы можете связать один триггер с несколькими обработчиками, выбрав их их списка. | ||
[[File:Trigger 2.png | 1000px]] | [[File:Trigger 2.png | 1000px]] | ||
+ | |||
+ | Нажмите "Открыть" в строке скрипт. Скопируйте переданный скрипт в открывшееся диалоговое окно, нажмите "Сохранить". | ||
[[File:Trigger 3.png | 1000px]] | [[File:Trigger 3.png | 1000px]] | ||
+ | |||
+ | Выберите созданный триггер, Нажмите кнопку "Компиляция", затем кнопку "Включить". | ||
[[File:Trigger 4.png | 1000px]] | [[File:Trigger 4.png | 1000px]] | ||
[[File:Trigger 5.png | 1000px]] | [[File:Trigger 5.png | 1000px]] | ||
+ | |||
+ | В случае если при компиляции любого из элементов (скрипт, триггер или обработчик) возникли ошибки, это будет отражено в виде всплывающего сообщения и в виде текста в соответствующем поле. | ||
[[File:Trigger error.png | 1000px]] | [[File:Trigger error.png | 1000px]] | ||
+ | |||
+ | ==Рекомендации по работе со скриптами "Сигналов 2.0"== | ||
+ | |||
+ | Скрипты, обработчики и триггеры представляют собой (и передаются в виде) файлов в формате ".cs", при отсутствии специализированных средств для работы с кодом, вы можете открыть файлы в "Блокнот" или "Notepad". | ||
+ | Откройте файл, внесите правки, если это было рекомендованы специалистами X-tensive, затем скопируйте текст в DPA для компиляции. | ||
+ | Модуль "Сигналы 2.0" предоставляет возможность формирования сложных сценариев и не предполагает расширенного настроечного инструментария в рамках пользовательского интерфейса, поэтому для адаптации скриптов вам может потребоваться внести небольшие корректировки в код. | ||
+ | |||
+ | <b>Пример </b>: скрипты, использованные в примерах выше, позволяют настроить отправку web-уведомления с идентификатором "31175" пользователю с табельным номером "123" в случае, если в течении часа с начала регистрации простой не был классифицирован, скрипт так же предполагает эскалацию и отправку уведомления с идентификатором "31175" пользователю с табельным номером "321", в случае, если через четыре часа с начала регистрации простой не был классифицирован. | ||
+ | Вы можете заменить табельные номера и длительность простоев и идентификатор шаблона, чтобы адаптировать скрипт для своих потребностей. | ||
+ | |||
+ | [[File:Tr.PNG | 1000px]] | ||
+ | |||
+ | [[File:Hl.PNG | 1000px]] | ||
+ | |||
+ | Передаваемые или публикуемые специалистами X-tensive скрипты "Сигналов 2.0" содержат комментарии в формате: | ||
+ | <b>Важно</b>: для корректной работы описанного выше примера шаблон уведомления (Главное меню->Справочники->Справочник шаблонов сообщений) с идентификатором "31175" должен содержать тег {EquipmentName}. Идентификатор шаблона вы можете увидеть в режиме разработчика на вкладке "Сеть". |
Текущая версия на 21:33, 1 августа 2021
Содержание
Базовые понятие и принципы работы
Модуль "Сигналы 2.0" предназначен для автоматизации выполнения повторяющихся задач и процедур.
Общий скрипт - это общая библиотека переменных, используемая всеми обработчиками и триггерами. Инструментарий поддерживает версионность скриптов, в один момент времени активен один общий скрипт. Обработчики и триггеры компилируются в привязке к конкретной версии общего скрипта.
Обработчик - это описание реакции системы на наступление описанного в связанном триггере условия - отправка сообщения/инкрементация счетчика и тому подобное.
Триггер - это описание регистрируемых условий в терминах машинных данных и/или данных формируемых системой/вводимых пользователями.
Запуск одного обработчика может быть инициирован срабатыванием нескольких триггеров. Срабатывание одного триггера может быть ассоциировано с несколькими обработчиками. При этом активная версия общего скрипта всегда одна. Однако, если скрипт или разработчик были скомпилированы на основе устаревшей версии скрипта они будут работоспособны вплоть до декомпиляции. Поскольку модуль работает с элементами кода DPA, просим внимательно следить за анонсами обновлений. В случае, если обновление будет требовать корректировки и рекомпиляции ранее выданных вам скриптов, мы сообщим об этом.
Настройка сигнала 2.0
Важно: данный раздел не содержит инструкции по разработке исполняемых скриптов, в нем описан порядок действий по загрузке и настройке готовых скриптов. В случае, если преданный вам обработчик содержит команды, запускающие работу микросервисов/работают с уведомлениями, убедитесь, что соответствующие настройки выполнены на сервере.
Добавление общего скрипта
Перейдите: Главное меню -> Сигналы 2.0. Выберите вкладку "Общие скрипты".
Нажмите кнопку "Добавить", заполните поля "Название" и "Описание", если загружаемый скрипт уже готов к использованию, укажите "Да" в поле "Используется".
Нажмите "Открыть" в строке скрипт. Скопируйте переданный скрипт в открывшееся диалоговое окно, нажмите "Сохранить".
Нажмите кнопку "Recompile"
Добавление обработчика
Выберите вкладку "Обработчик".
Нажмите кнопку "Добавить", заполните поля "Название" и "Описание", если загружаемый обработчик уже готов к использованию, укажите "Да" в поле "Используется". В случае если на момент загрузки обработчика в системе настроены триггеры, вы можете связать один обработчик с несколькими триггерами, выбрав их их списка.
Нажмите "Открыть" в строке скрипт. Скопируйте переданный скрипт в открывшееся диалоговое окно, нажмите "Сохранить".
Выберите созданный обработчик, Нажмите кнопку "Компиляция", затем кнопку "Включить".
Добавление триггера
Выберите вкладку "Триггер".
Нажмите кнопку "Добавить", заполните поля "Название" и "Описание", укажите следует ли запускать триггер автоматически после перезапуска/перезагрузки сервера. В случае если на момент загрузки триггера в системе настроены обработчики, вы можете связать один триггер с несколькими обработчиками, выбрав их их списка.
Нажмите "Открыть" в строке скрипт. Скопируйте переданный скрипт в открывшееся диалоговое окно, нажмите "Сохранить".
Выберите созданный триггер, Нажмите кнопку "Компиляция", затем кнопку "Включить".
В случае если при компиляции любого из элементов (скрипт, триггер или обработчик) возникли ошибки, это будет отражено в виде всплывающего сообщения и в виде текста в соответствующем поле.
Рекомендации по работе со скриптами "Сигналов 2.0"
Скрипты, обработчики и триггеры представляют собой (и передаются в виде) файлов в формате ".cs", при отсутствии специализированных средств для работы с кодом, вы можете открыть файлы в "Блокнот" или "Notepad". Откройте файл, внесите правки, если это было рекомендованы специалистами X-tensive, затем скопируйте текст в DPA для компиляции. Модуль "Сигналы 2.0" предоставляет возможность формирования сложных сценариев и не предполагает расширенного настроечного инструментария в рамках пользовательского интерфейса, поэтому для адаптации скриптов вам может потребоваться внести небольшие корректировки в код.
Пример : скрипты, использованные в примерах выше, позволяют настроить отправку web-уведомления с идентификатором "31175" пользователю с табельным номером "123" в случае, если в течении часа с начала регистрации простой не был классифицирован, скрипт так же предполагает эскалацию и отправку уведомления с идентификатором "31175" пользователю с табельным номером "321", в случае, если через четыре часа с начала регистрации простой не был классифицирован. Вы можете заменить табельные номера и длительность простоев и идентификатор шаблона, чтобы адаптировать скрипт для своих потребностей.
Передаваемые или публикуемые специалистами X-tensive скрипты "Сигналов 2.0" содержат комментарии в формате: Важно: для корректной работы описанного выше примера шаблон уведомления (Главное меню->Справочники->Справочник шаблонов сообщений) с идентификатором "31175" должен содержать тег {EquipmentName}. Идентификатор шаблона вы можете увидеть в режиме разработчика на вкладке "Сеть".