Инструкция по внедрению Synergy Knowledge¶
Первоначальная настройка¶
Настройки для портала¶
Прописать логин и пароль системного пользователя для Knowledge в файле /opt/synergy/jboss/standalone/deployments/lms.war/init.js
:
var _SYNERGY_ACCESS_LOGIN_ = 'knowledge_login';
var _SYNERGY_ACCESS_PASS_ = 'knowledge_password';
Также необходимо проверить, что в файле /etc/nginx/sites-enabled/synergy-base
настроен доступ к порталу:
location ~* /kw {
proxy_pass http://127.0.0.1:8080;
}
Install/upgrade configuration¶
- Добавить системного пользователя в группу
HCM полный доступ
. - Проверить, что группе пользователей
HCM полный доступ
предоставлены все права на реестры. - Проверить корректность URL до Synergy в настройках внешнего модуля
kw
. - Прописать логин и пароль системного пользователя в настройках всех скриптов интерпретатора:
event.blocking.interpreter.addIndexCUS
event.blocking.interpreter.anketaCUS
event.blocking.interpreter.changeCUS
event.blocking.interpreter.changePictureCourse
event.blocking.interpreter.checkSertificationUser
event.blocking.interpreter.courseCompleted
event.blocking.interpreter.removeIndexCUS
event.blocking.interpreter.rprofileCUS
event.blocking.interpreter.setImageCUS
event.blocking.interpreter.workCoursesNotify
event.blocking.interpreter.wprofileCUS
- Создать 2 пункта меню кнопки «Создать»:
- Карточка пользователя
- код:
hcm_create_userCard
- реестр: «Карточка пользователя»
- галочка «Добавить в «Избранное» пользователя по умолчанию» включена
- права: автогруппе «ROOT»
- код:
- Сформировать ИПР
- код:
hcm_create_idp
- реестр: «ИПР»
- галочка «Добавить в «Избранное» пользователя по умолчанию» включена
- права: автогруппе «ROOT»
- код:
Manual¶
Импортировать приложение Knowledge из архива
/opt/synergy/apps/knowledge/app-knowledge.7zip
.Подсказка
- При импорте приложения рекомендуем руководствоваться документацией.
- Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве.
Добавить системного пользователя в группу
HCM полный доступ
.Проверить, что группе пользователей
HCM полный доступ
предоставлены все права на реестры.Заменить URL до Synergy в настройках внешнего модуля
KW
.Прописать логин и пароль системного пользователя в настройках всех скриптов интерпретатора:
event.blocking.interpreter.addIndexCUS
event.blocking.interpreter.anketaCUS
event.blocking.interpreter.changeCUS
event.blocking.interpreter.changePictureCourse
event.blocking.interpreter.checkSertificationUser
event.blocking.interpreter.courseCompleted
event.blocking.interpreter.removeIndexCUS
event.blocking.interpreter.rprofileCUS
event.blocking.interpreter.setImageCUS
event.blocking.interpreter.workCoursesNotify
event.blocking.interpreter.wprofileCUS
Создать 2 пункта меню кнопки «Создать»:
- Карточка пользователя
- код:
hcm_create_userCard
- реестр: «Карточка пользователя»
- галочка «Добавить в «Избранное» пользователя по умолчанию» включена
- права: автогруппе «ROOT»
- код:
- Сформировать ИПР
- код:
hcm_create_idp
- реестр: «ИПР»
- галочка «Добавить в «Избранное» пользователя по умолчанию» включена
- права: автогруппе «ROOT»
- код:
В Kibana создать следующие шаблоны индексов:
r-hcm_registry_usercards_custom
r-hcm2_registry_competence
r-hcm_registry_idp
В шаблоне индексов
r-hcm_registry_usercards_custom
добавить следующиеScripted fields
:course_finished
language: painless;
type: number;
script:
int fvalue=0; if (doc['hcm_form_userCard_status_key.keyword'].value == '2' || doc['hcm_form_userCard_status_key.keyword'].value == '3') { fvalue=1; } return fvalue;
user_certified
language: painless;
type: number;
script:
int tvalue=0; if (doc['hcm_form_userCard_certified_key.keyword'].value == '1') { tvalue=1; } return tvalue;
Проверить, что установлен плагин Kibana
gauge
(имеется непустая папка/usr/share/kibana/plugins/gauge-sg
).Примечание
При необходимости установить плагин самостоятельно по ссылке.
Импортировать визуализации из файла
/opt/synergy/apps/knowledge/knowledge_visualizations.json
.Импортировать дашборды из файла
/opt/synergy/apps/knowledge/knowledge_dashboards.json
.
Подсказка
Дополнительные подробности доступны в подробной документации о Kibana.
Добавление контента¶
Общий порядок добавления нового контента в систему:
- создать каталог умений;
- создать каталог обучающих курсов;
- добавить в каждое умение ссылку на соответствующий курс;
- создать группы курсов;
- создать каталог должностей, указать обязательный набор курсов;
- создать профили обучающихся
Дополнительные возможности:
- создать тестовые вопросы;
- создать группы тестовых вопросов, привязав ее к какому-либо курсу;
- создать инструменты оценки курсов;
Реестры, в которых данные формируются исключительно автоматически:
- «Анкета эффективности курсов»
- «ИПР»
- «Форма оповещений курсов»
Настройки портала обучения¶
По умолчанию портал доступен по адресу <host>:<port>/kw
.
URL витрины регулируется именем соответствующего файла war
в папке /opt/synergy/jboss/standalone/deployments
.
Для изменения URL необходимо:
указать новое имя для файла
kw.war
в конфигурации nginx
/etc/nginx/sites-enabled/synergy-base
изменитьlocation
для портала. Пример настройки для нового имени academy:location /academy { proxy_pass http://127.0.0.1:8080/; }
Портал содержит следующие основные страницы:
- Авторизация
- «Профиль»
- «Мои курсы»
- «Все курсы»
- «Библиотека»
- Страница курса
Список должностей для страницы регистрации формируется из реестра «Профиль обучения». Страницы «Профиль», «Мои курсы» и «Библиотека» берут значения из записи реестра «Карточка пользователя», соответствующей авторизованному пользователю. Страница «Все курсы» - из реестров «Группы курсов» и «Обучающие курсы». Страница курса - из реестра «Обучающие курсы».
Авторизация¶
Страница авторизации содержит следующую форму ввода:
- «Логин»
- «Пароль»
- Кнопка входа в портал
Авторизация произойдет успешно только при одновременном выполнении следующих условий:
- на хосте существует введенная учетная запись пользователя
- на хосте имеются все реестры из списка:
- «Умения» (код
hcm_skills
) - «Обучающие курсы» (код
hcm2_registry_competence
) - «Группы курсов» (код
hcm_registry_courseGroups
) - «Инструменты оценки курсов» (код
hcm_registry_edu_instruction
) - «Профиль обучения» (код
hcm_registry_trainingProfile
) - «Карточка пользователя» (код
hcm_registry_userCards
) - «ИПР» (код
hcm_registry_idp
)
- «Умения» (код
- в реестре «Карточка пользователя» имеется запись, поле
hcm_form_userCard_user
которого совпадает с учетной записью авторизующегося пользователя - если в реестре «Карточка пользователя» еще нет записи, система предлагает создать Карточку пользователя
Профиль¶
В профиль попадают все поля из статической таблицы hcm_form_userCard_profile
. Новое поле таблицы
необходимо добавлять наподобие уже добавленных в неё полей:
- задать имя основному компоненту
- добавить отдельный компонент для лейбла, задать ему имя в формате
имя_основного_компонента-label
После полей профиля отображается кнопка выхода на страницу авторизации.
Дополнительно на странице профиля отображается статистика прохождения курсов. Данные считываются из
статической таблицы hcm_form_userCard_certificateTable
.
Мои курсы¶
Страница делится на 2 категории:
- обязательные курсы (автоматически формируемый список на основе должности пользователя): из динамической таблицы
hcm_form_userCard_competenceTable
- дополнительные курсы (добавленные пользователем вручную): из динамической таблицы
hcm_form_userCard_competenceTable_other
Для каждого курса отображается его фоновая картинка, название, статус, прогресс прохождения (при наличии), при наведении на плашку дополнительно - автор.
Все курсы¶
Страница содержит список всех курсов в двух видах:
- сгруппированный список
- сплошной список
Для каждой группы курсов отображается ее фоновая картинка, количество курсов в группе, название, описание.
Для каждого курса отображается его фоновая картинка, название, статус, прогресс прохождения (при наличии), при наведении на плашку дополнительно - автор.
Библиотека¶
На страницу библиотеки попадают файлы / ссылки из динамической таблицы hcm_form_userCard_books
.
Страница курса¶
Страница содержит 2 блока:
- содержание курса (список уроков)
- описание курса / содержимое выбранного урока
Содержание и содержимое уроков считывает данные динамических таблиц hcm_form_competence_tableCourseContent
и hcm_form_competence_tableRes
. Допускается добавление новых строк в блоки таблиц, поддерживаемые
компоненты - однострочное поле, многострочное поле, файл, ссылка:
- задать имя основному компоненту (полю ввода)
- добавить отдельный компонент для лейбла, задать ему имя в формате
имя_основного_компонента-label
- для файла задать имя в формате
имя_основного_компонентаfile
- для ссылки задать имя в формате
имя_основного_компонентаlink
В описание попадают поле hcm_form_compitience_pasport
, а также данные статических таблиц
hcm_form_competence_tableMain
и hcm_form_competence_tableAdditional
. Допускается добавление
новых поле в таблицу hcm_form_competence_tableAdditional
:
- задать имя основному компоненту
- добавить отдельный компонент для лейбла, задать ему имя в формате
имя_основного_компонента-label