Интеграция АСУ «Спрут» с СЭО 3KL (СДО Русский Moodle)

1. Общие принципы интеграции

Данная интеграция позволяет автоматизировать процедуру обмена данными между СЭО 3КL (оценки, курсы и т. п.) и АСУ «Спрут» (данные по студентам, зачетные книжки, ведомости и т. п.). Основной обмен данными происходит через буферную базу данных MS SQL (Рис. 1.1).

Общий алгоритм интеграции:

1) Из АСУ «Спрут» в буферную БД выгружаются данные по учащимся (определенный набор полей пользователей), зарегистрированным в системе (Рис. 1.2).

2) СЭО 3КL по расписанию синхронизируется с внешней БД, забирает из нее данные о новых пользователях и обновляет данные по ранее загруженным (если есть изменения).

3) Учащиеся, по своему логину, зарегистрированному в АСУ «Спрут», входят в СЭО 3КL, в соответствии с учебным планом изучают курсы (=дисциплины), получают оценки за них.

4) Итоговые оценки за дисциплины выгружаются из СЭО 3КL в буферную БД (по расписанию и событию). Критерием выгрузки служит выставление оценки или изменение ранее выставленной.

5) АСУ «Спрут» забирает оценки пользователей из буферной БД, использует их для контроля успеваемости, формирует на их основании соответствующие документы (ведомости, зачетные книжки и т. п.).

6) АСУ «Спрут» по расписанию выгружает сформированные документы по учащимся в формате pdf во внешнее файловое хранилище (Рис. 1.4).

7) В СЭО 3КL, в личном кабинете пользователя, отображаются ссылки на документы пользователя в файловом хранилище (Рис. 1.5).

Интеграция включает следующие независимые сценарии (Табл. 1):

-Вернуться к содержанию-

2. Спецификации интеграции с АСУ «Спрут»

2.1. Версия 1 спецификации интеграции с АСУ «Спрут» (текущая)

2.1.1. Сценарий «Передача пользовательских данных из АСУ «Спрут» в СЭО 3КL»

Назначение сценария:

Выгрузка значений полей базы данных АСУ «Спрут» в базу данных СЭО 3КL с использованием буферной БД (таблица данных пользователей).

Требования к БД:

Тип внешней БД — MS SQL. Кодировка внешней базы данных Cyrillic_General_100 или Cyrillic_General.

Условия запуска:

Выгрузка данных из АСУ «Спрут» во внешнюю БД выполняется по расписанию.

Выгрузка новых записей из внешней БД в СЭО 3КL выполняется по расписанию, раз в сутки.

Обновление данных пользователя в СЭО 3КL из внешней БД выполняется по событию авторизации этого пользователя в СЭО 3КL.

Транслируемые поля:

Описание сценария:

1) Из АСУ «Спрут» во внешнюю БД выгружаются данные полей пользователей (Табл. 3): добавляются новые записи (если значение ключа-идентификатора в таблице не найдено) и обновляются записи, данные в которых изменились.

2) СЭО 3КL с настроенной периодичностью синхронизируется с внешней БД и, в случае появления в там новых записей, информация по новым пользователям добавляется в базу данных среды электронного обучения. Поиск и проверка выполняются по значению ключа-идентификатора. Сопоставление полей внешней БД и БД СЭО 3КL происходит на основании настроек плагина «Внешняя база данных» (auth_db). Обновление данных по ранее добавленным в В СЭО 3КL пользователям на этом этапе не выполняется.

3) В СЭО 3КL авторизуется пользователь, еще ни разу не заходивший в систему, но данные по которому синхронизированы. Пользователь применяет сценарий восстановления пароля в СЭО 3КL по логину (значение поля student_login таблицы данных пользователей во внешней БД), система генерирует временный пароль и высылает на электронную почту пользователя ссылку на страницу создания пароля.

4) В СЭО 3КL входит пользователь, у которого уже есть пара логин/пароль. В момент авторизации происходит обновление полей пользователя в СЭО 3КL, если его данные во внешней БД изменились.

Запрос на создание таблицы:

CREATE TABLE [dbo].[student] (
  [student_login] nvarchar(100) NOT NULL,
  [student_firstname] nvarchar(100) NOT NULL,
  [student_lastname] nvarchar(100) NOT NULL,
  [student_middlename] nvarchar(100) NULL,
  [student_fullname] ntext NULL,
  [student_dateofbirth] bigint NULL,
  [student_gender] ntext NULL,
  [student_email] nvarchar(100) NOT NULL,
  [PIN] nvarchar(255) NOT NULL,
  [student_contract_num] ntext NULL,
  [student_contract_date] bigint NULL,
  [student_numbook] ntext NULL,
  [student_phonecell] nvarchar(20) NULL,
  [student_numgroup] ntext NULL,
  [student_formob] ntext NULL,
  [student_direc] ntext NULL,
  [student_prof] ntext NULL,
  [semestr] tinyint NULL,
  [status] ntext NULL,
  [dolg] float NULL,
  [ak_dolg] smallint NULL,
  [student_sp] ntext NULL,
  [comment] ntext NULL,
  [customfield] ntext NULL
);
ALTER TABLE [dbo].[student] ADD PRIMARY KEY ([student_login]);
CREATE UNIQUE INDEX [student_PIN] ON [dbo].[student] ([PIN]);

-Вернуться к содержанию-

2.1.2. Сценарий «Передача pdf-документов из АСУ «Спрут» в СЭО 3КL»

Назначение сценария:

Доступ учащихся из личного кабинета пользователя СЭО 3КL к документам, сформированным в АСУ «Спрут».

Тип контента и протокол передачи:

Файлы в формате pdf по протоколу WebDAV.

Условия запуска:

Выгрузка из АСУ «Спрут» во внешнее файловое хранилище документов по учащимся выполняется по расписанию, еженедельно.

Генерируемые документы:

Название документа	Пример внешнего вида
Учебная карточка
Зачетная книжка
Академическая задолженность
Электронный журнал
Контроль оплаты
Квитанция на оплату	Форма ПД-4

Описание сценария:

1) На стороне СПРУТ происходит генерация необходимых документов, сгенерированные документы помещаются в папку внешнего хранилища (в тематические подпапки «Оплата обучения» и «Ход и результаты обучения»), где название папки = индивидуальному номеру пользователя (idnumber) в СЭО 3KL (Рис. 2.1.2.а).

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

2) В личном кабинете пользователя СЭО 3КL, в блоке «Внешние данные», доступны ссылки на документы, выгруженные АСУ «Спрут» в папку внешнего хранилища (Рис. 2.1.2.б) или соответствующее сообщение, если никаких файлов в папке нет.

-Вернуться к содержанию-

2.1.3. Сценарий «Передача оценок из СЭО 3КL в АСУ «Спрут»

Назначение сценария:

Выгрузка данных по оценкам (значения итоговых оценок за курс и служебных полей) из СЭО 3КL в базу данных АСУ «Спрут» с использованием буферной БД (таблица оценок).

Требования к БД:

Тип внешней БД — MS SQL. Кодировка внешней базы данных Cyrillic_General_100 или Cyrillic_General.

Условия запуска:

Выгрузка данных по оценкам из СЭО 3КL во внешнюю БД выполняется:

• по расписанию, раз в сутки, в процессе отработки регулярной задачи «Ежедневная обработка прецедентов» (выгрузка всех данных);
• по событию «Изменена история оценки» (создание или обновление записи в таблице).

Выгрузка данных из внешней БД в АСУ «Спрут» выполняется по расписанию.

Транслируемые поля:

Описание сценария:

1) СЭО 3КL выгружает (по расписанию или по событию) во внешнюю БД значения оценок пользователей за курс и служебных полей, необходимых для корректной обработки на стороне СПРУТ этих оценок (Табл. 6). Идентификация записей во внешней базе данных выполняется по составному ключу вида «Идентификатор пользователя (поле PIN) + Идентификатор курса» (idKurs):

• если составной ключ не найден - в базе данных создается новая запись;
• если запись уже есть в таблице - обновляются значения изменившихся полей.

2) АСУ «Спрут» с настроенной периодичностью загружает из буферной БД данные по оценкам.

3) В случае, если оценка удаляется из СЭО 3КL, оценка удаляется и из буферной БД. Решение необходимости сохранения или удаления данной оценки из своей базы данных АСУ «Спрут» принимает самостоятельно.

Запрос на создание таблицы:

CREATE TABLE [dbo].[studentMark] (
  [id] int NOT NULL IDENTITY PRIMARY KEY,
  [SubjCode] int NOT NULL,
  [MarkTypeCode] int NOT NULL,
  [MarkCode] nvarchar(100) NOT NULL,
  [MarkDate] datetime2 NULL,
  [PIN] int NOT NULL,
  [idKurs] int NOT NULL,
  [DateVig] datetime2 NULL,
  [Lesson] int NOT NULL
);
CREATE UNIQUE INDEX [studentMark_PIN_idKurs] ON [dbo].[studentMark] ([PIN], [idKurs]);

-Вернуться к содержанию-

2.2. Версия 2 спецификации интеграции с АСУ «Спрут» (планируемая)

2.2.1. Сценарий «Передача пользовательских данных из АСУ «Спрут» в СЭО 3КL»

Соответствует аналогичному сценарию версии 1.

-Вернуться к содержанию-

2.2.2. Сценарий «Передача pdf-документов из АСУ «Спрут» в СЭО 3КL»

Соответствует аналогичному сценарию версии 1.

-Вернуться к содержанию-

2.2.3. Сценарий «Передача оценок из СЭО 3КL в АСУ «Спрут»

Назначение сценария:

Выгрузка данных по оценкам (значения итоговых оценок за курс и служебных полей) из СЭО 3КL в базу данных АСУ «Спрут» с использованием буферной БД (таблица оценок).

Требования к БД:

Тип внешней БД — MS SQL. Кодировка внешней базы данных Cyrillic_General_100 или Cyrillic_General.

Условия запуска:

Выгрузка данных по оценкам из СЭО 3КL во внешнюю БД выполняется:

• по расписанию, раз в сутки, в процессе отработки регулярной задачи «Ежедневная обработка прецедентов» (выгрузка всех данных);
• по событию «Изменена история оценки» (создание или обновление записи в таблице).

Выгрузка данных из внешней БД в АСУ СПРУТ выполняется по расписанию.

Транслируемые поля:

Описание сценария:

1) СЭО 3КL выгружает (по расписанию или по событию) во внешнюю БД значения оценок пользователей за курс и служебных полей, необходимых для корректной обработки на стороне СПРУТ этих оценок (Табл. 6). Идентификация записей во внешней базе данных выполняется по составному ключу вида «Идентификатор пользователя (поле PIN) + Идентификатор курса» (idKurs):

• если составной ключ не найден - в базе данных создается новая запись;
• если запись уже есть в таблице - обновляются значения изменившихся полей.

2) АСУ «Спрут» с настроенной периодичностью загружает из буферной БД данные по оценкам.

3) В случае, если оценка удаляется из СЭО 3КL, оценка удаляется и из буферной БД. Решение необходимости сохранения или удаления данной оценки из своей базы данных АСУ «Спрут» принимает самостоятельно.

Запрос на создание таблицы:

CREATE TABLE [dbo].[studentMark] (
  [id] int NOT NULL IDENTITY PRIMARY KEY,
  [PIN] int NOT NULL,
  [idKurs] int NOT NULL,
  [MarkCode] nvarchar(100) NOT NULL,
  [MarkDate] datetime2 NULL,
  [DateVig] datetime2 NULL
);
CREATE UNIQUE INDEX [studentMark_PIN_idKurs] ON [dbo].[studentMark] ([PIN], [idKurs]);

-Вернуться к содержанию-

2.2.4. Сценарий «Передача данных по курсам из СЭО 3КL в АСУ «Спрут»

Назначение сценария:

Выгрузка данных по курсам (идентификаторов курсов, названий и служебные полей) из СЭО 3КL в базу данных АСУ «Спрут» с использованием буферной БД (таблица данных по курсам).

Требования к БД:

Тип внешней БД — MS SQL. Кодировка внешней базы данных Cyrillic_General_100 или Cyrillic_General.

Условия запуска:

Выгрузка данных по курсам из СЭО 3КL во внешнюю БД выполняется по расписанию, раз в сутки, в процессе отработки регулярной задачи «Ежедневная обработка прецедентов» (выгрузка всех данных).

Выгрузка данных из внешней БД в АСУ «Спрут» выполняется по расписанию.

Транслируемые поля:

Описание сценария:

1) СЭО 3КL выгружает во внешнюю БД данные по курсам. Идентификация записей во внешней базе данных выполняется по ключу «Идентификатор курса СЭО 3KL» (id).

• если ключ не найден - в базе данных создается новая запись;
• если запись уже есть в таблице - обновляются значения изменившихся полей.

2) АСУ «Спрут» с настроенной периодичностью загружает из буферной БД данные по курсам.

Запрос на создание таблицы:

CREATE TABLE [dbo].[3kl_courses] (
  [id] int NOT NULL PRIMARY KEY,
  [fullname] nvarchar(254) NOT NULL,
  [shortname] nvarchar(255) NOT NULL,
  [idnumber] nvarchar(100) NOT NULL,
  [category] int NOT NULL,
  [sync_session_status] nvarchar(50) NOT NULL,
  [sync_session_start_ts] int NOT NULL,
  [sync_item_finish_ts] int NOT NULL,
  [sync_item_status] nvarchar(50) NOT NULL
);
CREATE UNIQUE INDEX [3kl_courses_shortname] ON [dbo].[3kl_courses] ([shortname]);

-Вернуться к содержанию-

2.2.5. Сценарий «Передача данных по категориям курсов из СЭО 3КL в АСУ «Спрут»

Назначение сценария:

Выгрузка данных по категориям курсов (идентификаторов категорий курсов, их названий и служебные полей) из СЭО 3КL в базу данных АСУ СПРУТ с использованием буферной БД (таблица данных по категориям курсов).

Требования к БД:

Тип внешней БД — MS SQL. Кодировка внешней базы данных Cyrillic_General_100 или Cyrillic_General.

Условия запуска:

Выгрузка данных по категориям курсам из СЭО 3КL во внешнюю БД выполняется по расписанию, раз в сутки, в процессе отработки регулярной задачи «Ежедневная обработка прецедентов» (выгрузка всех данных).

Выгрузка данных из внешней БД в АСУ СПРУТ выполняется по расписанию.

Транслируемые поля:

Описание сценария:

1) СЭО 3КL выгружает во внешнюю БД данные по категориям курсов. Идентификация записей во внешней базе данных выполняется по ключу «Идентификатор категории курса СЭО 3KL» (id).

• если ключ не найден - в базе данных создается новая запись;
• если запись уже есть в таблице - обновляются значения изменившихся полей.

2) АСУ «Спрут» с настроенной периодичностью загружает из буферной БД данные по категориям курсам.

Запрос на создание таблицы:

CRE ATE TABLE [dbo].[3kl_course_categories] (
 [id] int NOT NULL,
 [name] nvarchar(255) NOT NULL,
 [idnumber] nvarchar(100) NULL,
 [path] nvarchar(255) NOT NULL,
 [sync_session_status] nvarchar(50) NOT NULL,
 [sync_session_start_ts] int NOT NULL,
 [sync_item_finish_ts] int NOT NULL,
 [sync_item_status] nvarchar(50) NOT NULL
);
ALT ER TABLE [dbo].[3kl_course_categories] ADD PRIMARY KEY ([id]);

-Вернуться к содержанию-

3. Настройка интеграции СЭО 3КL с АСУ «Спрут» (версия 1)требуются права администратора

Реквизиты, необходимые для настройки интеграции (на стороне СЭО 3КL):

Подключение к внешней БД

• Адрес сервера БД
• Название БД
• Имя пользователя БД
• Пароль к БД
• Название таблицы данных пользователей
• Название таблицы оценок

Подключение к файловому хранилищу

• Адрес файлового хранилища СПРУТ
• Имя пользователя для подключения к файловому хранилищу СПРУТ
• Пароль к файловому хранилищу СПРУТ

3.1. Настройка сценария «Передача пользовательских данных из АСУ «Спрут» в СЭО 3КL»

1) На странице настроек плагина аутентификации «Внешняя база данных» (Администрирование->Плагины->Аутентификация->Внешняя база данных) установить следующие параметры (Рис. 3.1.1.):

Сервер баз данных = Адрес сервера БД
База данных = mssqlnative
Кавычки как в Sybase = Нет
Название базы данных = Название БД
Пользователь базы данных = Имя пользователя БД
Пароль = Пароль к БД
Таблица = Название таблицы данных пользователей
Поле логина = student_login
Формат пароля = Внутренний
Кодировка внешней базы данных = utf-8
При удалении пользователя во внешнем источнике = Сохранить внутреннюю учетную запись
Обновить пользователей = Нет

2) В разделе «Сопоставление данных» на странице настроек плагина аутентификации «Внешняя база данных» установить следующие соответствия полей (Табл. 11):

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

3) Убедиться, что в Планировщике задач (Администрирование->Сервер->Задачи->Планировщик задач) включено и настроено ежедневное выполнение задачи «Задача синхронизации пользователей» (\auth_db\task\sync_users) (Рис. 3.1.2, Рис. 3.1.3).

-Вернуться к содержанию-

3.2. Настройка сценария «Передача pdf-документов из «Спрут» в СЭО 3КL»

1) На странице «Настройки по умолчанию для страницы «Личный кабинет» (Администрирование->Внешний вид->Настройки по умолчанию для страницы «Личный кабинет») добавить блок «Внешние данные» (Рис. 3.2.1).

2) На добавленном блоке нажать кнопку «Управление контентом». На открывшейся странице настроек в поле «Тип контента» выбрать «Файлы по протоколу WebDAV»и нажать «Применить».

3) В открывшемся разделе «Конфигурация» заполнить поля настроек (Рис. 3.2.2):

Базовый url сервера = https://webdav.yandex.ru
Имя пользователя для подключения = Имя пользователя для подключения к файловому хранилищу СПРУТ
Пароль для подключения = Пароль к файловому хранилищу СПРУТ
Путь до директории, содержимое которой требуется отобразить = /sprut/{user.idnumber}/Ход и результаты обучения
Mustache-шаблон :

4) Повторить действия 1)-2) и создать еще один блок «Внешние данные».

5) В открывшемся разделе «Конфигурация» заполнить поля настроек:

Базовый url сервера = https://webdav.yandex.ru
Имя пользователя для подключения = Имя пользователя для подключения к файловому хранилищу СПРУТ
Пароль для подключения = Пароль к файловому хранилищу СПРУТ
Путь до директории, содержимое которой требуется отобразить = /sprut/{user.idnumber}/Оплата обучения/
Mustache-шаблон :

6) После сохранения настроек, добавленные блоки будут доступны в личном кабинете для всех пользователей СЭО 3КL (Рис. 3.2.3).

-Вернуться к содержанию-

3.3. Настройка сценария «Передача оценок из СЭО 3КL в АСУ «Спрут»

Настройка сценария состоит из следующих этапов:

• создание настраиваемых полей;
• настройка подключения к буферной БД;
• настройка Панели обработки прецедентов для выгрузки оценок;
• включение выгрузки оценок по расписанию.

-Вернуться к содержанию-

3.3.1. Создание настраиваемых полей

1) В поле «Курсы. Конфигурация настраиваемых полей» (Администрирование->Плагины->Локальные плагины->Настраиваемые поля->) необходимо вставить нижеприведенный yaml-код (Рис. 3.3.1.а):

class:
   coursecontroltype:
      type: text
      label: Тип испытания
   lesson:
      type: text
      label: Номер (номер семестра)
   subjcode:
      type: text
      label: Код дисциплины
   submit:
      type: submit
      label: Сохранить

2) Перейти в курс и убедиться, что на странице «Курс «Название курса». Редактирование настраиваемых полей» (Управление курсом->«Курс «Название курса». Редактирование настраиваемых полей») появились добавленные поля (Рис. 3.3.1.б, Рис. 3.3.1.в).

-Вернуться к содержанию-

3.3.2. Настройка подключения к буферной БД

1) Перейти на страницу «Управление подключениями к внешним БД» (Администрирование->Управление подключениями к внешним БД) и создать новое подключение, используя реквизиты подключения к внешней БД (Рис.3.3.2.а).

2) Нажав на ссылку «Проверить подключение», появившуюся в интерфейсе сохраненного подключения, протестировать корректность заданных настроек (Рис. 3.3.2.б).

В случае, если подключение было настроено правильно, отобразится соответствующее сообщение об этом (Рис. 3.3.2.в).

-Вернуться к содержанию-

3.3.3. Настройка Панели обработки прецедентов для выгрузки оценок

1) В разделе настроек «Выгрузка оценок во внешнюю базу данных» Панели обработки прецедентов (Администрирование->Плагины->Локальные плагины->Панель обработки прецедентов) определить следующие параметры (Рис. 3.3.3.а):

Опция «Включить экспорт оценок во внешнюю базу данных» - установлена
Соединение с базой данных = ваше настроенное подключение
Имя таблицы = название таблицы данных пользователей
Какие оценки выгружать? = За курсы
Формат оценки для экспорта = Значение
Формат времени выставления оценки = YYYY-MM-DD
Формат времени выгрузки оценок = YYYY-MM-DD.

2) После сохранения настроек, установленных на первом шаге, в разделе «Выгрузка оценок во внешнюю базу данных» становятся доступны поля для идентификации и сопоставления данных. Необходимо установить следующие соответствия (Табл. 12):

Для остальных полей использовать значение «Не выгружать» или установленное по умолчанию ( Рис. 3.3.3.б).

-Вернуться к содержанию-

3.3.4. Включение выгрузки оценок по расписанию

В разделе настроек «Выгрузка существующих оценок во внешнюю базу данных по расписанию» Панели обработки прецедентов (Администрирование->Плагины->Локальные плагины->Панель обработки прецедентов) установить опцию «Включить выгрузку существующих оценок по расписанию» (Рис. 3.3.4.а).

Выгрузка оценок в СПРУТ будет выполняться по задаче «Ежедневная обработка прецедентов» (\local_pprocessing\task\daily\local_pprocessing\task\daily) планировщика задач (Администрирование->Сервер->Задачи->Планировщик задач) (Рис. 3.3.4.б).

Перейти к настройкам и изменить время выполнения задачи можно нажав на иконку в строке таблицы Планировщика задач (Рис. 3.3.4.в).

+в таблицу оценок для в2 добавить еще два поля: оценка в формате оценка (здесь: в данной версии синхронизация не используется, поле добавлено на перспективу), оценка в формате шкала ( здесь: такие-то рекомендованные значения).

+сценарий с подписками, чтобы можно было управлять подписками на курсы СЭО 3КL через плагин «Подписка по внешней БД»

-Вернуться к содержанию-

4. Настройка интеграции СЭО 3КL с АСУ «Спрут» (версия 2)требуются права администратора

Реквизиты, необходимые для настройки интеграции (на стороне СЭО 3КL):

Подключение к внешней БД

• Адрес сервера БД
• Название БД
• Имя пользователя БД
• Пароль к БД
• Название таблицы данных пользователей
• Название таблицы оценок

Подключение к файловому хранилищу

• Адрес файлового хранилища СПРУТ
• Имя пользователя для подключения к файловому хранилищу СПРУТ
• Пароль к файловому хранилищу СПРУТ

4.1. Настройка сценария «Передача пользовательских данных из АСУ «Спрут» в СЭО 3КL»

-Вернуться к содержанию-

4.2. Настройка сценария «Передача pdf-документов из «Спрут» в СЭО 3КL»

-Вернуться к содержанию-

4.3. Настройка сценария «Передача оценок из СЭО 3КL в АСУ «Спрут»

Настройка сценария состоит из следующих этапов:

• создание настраиваемых полей;
• настройка подключения к буферной БД;
• настройка Панели обработки прецедентов для выгрузки оценок;
• настройка Панели обработки прецедентов для выгрузки данных по курсам;
• настройка Панели обработки прецедентов для выгрузки данных по категориям курсов;
• включение выгрузки оценок по расписанию.

-Вернуться к содержанию-

4.3.1. Создание настраиваемых полей

-Вернуться к содержанию-

4.3.2. Настройка подключения к буферной БД

-Вернуться к содержанию-

4.3.3. Настройка Панели обработки прецедентов для выгрузки оценок

-Вернуться к содержанию-

4.3.4. Настройка Панели обработки прецедентов для выгрузки данных по курсам

-Вернуться к содержанию-

4.3.5. Настройка Панели обработки прецедентов для выгрузки данных по категориям курсов

-Вернуться к содержанию-

4.3.6. Включение выгрузки оценок по расписанию

-Вернуться к содержанию-

5. Примеры и решения

-Вернуться к содержанию-