Каталог модулей

Каталог модулей используется для настройки скриптовых модулей. В каталог входят модули, добавленные пользователем и модули, представленные клиентским сервисом ITSM 365.

Модули (скриптовые модули) — это универсальные параметризованные groovy скрипты, написанные сотрудниками клиентского сервиса ITSM 365 или технологами клиента.

Возможности скриптовых модулей

В рамках модуля определяются методы, которые могут использоваться в скриптах при настройке системы. Для обращения к модулю и конкретному методу, определенному в нем, используется конструкция:

modules.{код модуля}.{имя метода}({параметры метода}...).

В рамках модуля (1) можно объявлять классы, внутри которых объявлять методы. В рамках другого модуля (2) можно объявлять классы и методы, в том числе такие, которые переопределяют методы, определенные в модуле (1) и это не повлияет на работу исходного модуля (1).

Список модулей. Карточка модуля

Список модулей

Список модулей отображается в интерфейсе администратора на странице "Каталог модулей".

Чтобы перейти к странице каталога, выберите в меню навигации "Настройка системы" → "Каталог скриптов и модулей" → "Каталог модулей".

Для каждого модуля в списке отображаются:

  • Параметры:

    • Код (уникальный код модуля).
    • Описание модуля, его назначение, краткий обзор методов модуля и т.д.
    • Текст groovy скрипта, в котором определяются методы модуля.
    • Доступен для REST-запросов
  • Иконки управления действием по событию:  "Редактировать и  "Удалить".

Карточка модуля

Параметры отдельного модуля хранятся в его карточке. На странице "Каталог модулей" нажмите на строке с описанием модуля, на экране отобразится его карточка.

Карточка модуля содержит:

  • Панель управления с кнопками: "Редактировать", "Удалить".
  • Блок "Свойства", в котором отображаются атрибуты модуля:

    • Код — уникальный код модуля.
    • Описание — описание модуля, его назначение, краткий обзор методов модуля и т.д.
    • Версия — номер версии модуля.
    • Текст — текст groovy-скрипта, в котором определяются методы модуля.
    • Доступен для REST-запросов

Чтобы вернуться к странице "Каталог модулей", перейдите по ссылке "Назад".

Добавление модуля в каталоге модулей

Добавление модуля в каталоге модулей — модуль создается вручную на странице "Каталог модулей", параметры модуля заполняются на форме добавления. Для модуля создается карточка с заполненными соответствующими значениями атрибутами.

Чтобы добавить скриптовый модуль, выполните следующие операции:

  1. Выберите в меню навигации "Настройка системы" → "Каталог скриптов и модулей" → "Каталог модулей".
  2. Нажмите кнопку "Добавить модуль". На экране откроется форма "Добавление модуля".
  3. Заполните параметры модуля:

    • Код — введите уникальный код модуля.

      Запрещено использовать код модуля, совпадающий:

      • с именем класса, используемого в скрипте в части создания нового объекта через конструктор или обращения к статическим полям/методам этого класса;
      • с именем класса, объявленного в данном скриптовом модуле;
      • с именем контекстной переменной, используемой в скриптовом модуле.

      Использование запрещенных кодов будет мешать корректной работе скриптового модуля.

    • Описание — введите описание модуля, его назначение, краткий обзор методов модуля и т.д.
    • Версия — введите номер версии модуля.
    • Текст — введите текст groovy скрипта, в котором определяются методы модуля.

    • Доступен для REST-запросов — признак, управляющий доступностью модуля для прямых вызовов через REST service.

      • флажок установлен (по умолчанию) — методы модуля доступны для прямых вызовов через REST service;
      • флажок снят — методы из текста самого модуля недоступны для прямого вызова REST-запросами (в ответе будет получена ошибка исполнения метода). Для внутренних вызовов из других groovy-модулей, а также прочих скриптовых сценариев внутри системы методы доступны.;
  4. Нажмите кнопку Сохранить. Форма добавления закроется, новый модуль отобразится на странице "Каталог модулей".

Загрузка модуля в виде xml файла

Загрузка модуля в виде xml файла — модуль загружается в виде xml файла на странице "Администрирование", параметры модуля заполняются автоматически на основании данных из xml файла. Для модуля создается карточка с заполненными соответствующими значениями атрибутами.

Для корректной загрузки xml файла требуется получить в клиентском сервисе ITSM 365 контрольную сумму модуля для проверки целостности данных.

Чтобы загрузить xml-файл модуля, выполните следующие действия:

  1. Выберите в меню навигации "Настройка системы" → "Администрирование" (вкладка "Управление системой").
  2. В блоке "Выгрузка/загрузка", в строке "Модули" нажмите на кнопку "Обзор" и выберите xml файл модуля.
  3. После этого выполнится стандартный процесс загрузки файла. Процедура загрузки и место сохранения файла на компьютере зависят от настройки интернет-браузера пользователя. Дождитесь отображения на экране сообщения об итоге загрузки. Новый модуль отобразится на странице "Каталог модулей".
  4. Если выполняется попытка сохранить модуль с кодом, который уже существует, то на экран выводится сообщение: "Модули со следующими кодами уже существуют: коды модулей через запятую. Обновить существующие модули?":

    • Да — окно с сообщением закроется, в карточке существующего модуля значения атрибутов "Описание", "Текст", "Версия" будут заменены соответствующими значениями загружаемого модуля;
    • "Нет" — окно с сообщением закроется, обновления модуля не происходит.

Редактирование модуля

Модули, предоставленные клиентским сервисом ITSM 365, могут иметь ограничение на редактирование.

Чтобы изменить параметры скриптового модуля, выполните следующие операции:

  1. Выберите в меню навигации "Настройка системы" → "Каталог скриптов и модулей" → "Каталог модулей".
  2. Для редактирования параметров модуля:

    • В списке модулей нажмите иконку  "Редактировать" в строке с описанием модуля.
    • В карточке модуля нажмите кнопку "Редактировать".
  3. Измените параметры модуля на форме "Редактирование модуля". Параметр "Код" не редактируется.
    • "Описание" — введите описание модуля, его назначение, краткий обзор методов модуля и т.д.
    • "Версия" — введите номер версии модуля.
    • "Текст" — введите текст groovy скрипта, в котором определяются методы модуля.

    • "Доступен для REST-запросов" — признак, управляющий доступностью модуля для прямых вызовов через REST service.

      • флажок установлен (по умолчанию) — методы модуля доступны для прямых вызовов через REST service;
      • флажок снят — методы из текста самого модуля недоступны для прямого вызова REST-запросами (в ответе будет получена ошибка исполнения метода). Для внутренних вызовов из других groovy-модулей, а также прочих скриптовых сценариев внутри системы методы доступны.;
  4. Нажмите кнопку Сохранить. Форма редактирования закроется, новые параметры модуля отобразятся на странице "Каталог модулей" и в карточке модуля.

Удаление модуля

Модули, предоставленные клиентским сервисом ITSM 365, не удаляются. Удалить можно только модули, созданные пользователем. При удалении все скрипты, использующие методы модуля, будут работать некорректно.

Чтобы удалить скриптовый модуль, выполните следующие операции:

  1. Выберите в меню навигации "Настройка системы" → "Каталог скриптов и модулей" → "Каталог модулей".
  2. Для удаления одного модуля:

    • В списке модулей нажмите иконку  "Удалить" в строке с описанием модуля.
    • В карточке модуля нажмите кнопку "Удалить".
  3. Для удаления нескольких модулей: в списке модулей установите флажки в строке модуля и нажмите ссылку "удалить" на панели массовых операций, см. Массовые операции с объектами списка.