Быстрый старт разработки расширений
Подготовка к работе
Система ELMA поддерживает расширение функционала с помощью модулей или плагинов.
Такие модули разрабатываются на языке C# в Visual Studio. Для того чтобы начать разработку расширений, вам требуется:
- Отдельный тестовый сервер или сервер разработки.
- ELMA Plugin for Visual Studio для разработки расширений. Партнеры могут получить ссылку для скачивания в личном кабинете. ASP.NET MVC необходимой версии будет установлен совместно с плагином.
- Visual Studio 2010/2012 Professional и выше. Или Visual Studio 2013/2015/2017/2019 Community Edition и выше.
После того, как вы загрузили все необходимые дистрибутивы на свой компьютер, приступайте к установке:
- Установите Visual Studio.
- Установите ELMA plugin for Visual Studio.
После установки плагина в общей папке с файлами системы ELMA будет создана папка Dev. В данной папке вы найдете все необходимое для начала разработки.
Также в данной папке лежит файл readme.txt — краткая инструкция.
Создание проекта
Запустите Visual Studio. Выберите меню Файл — Проект — Visual C# — ELMA. (рис. 1)
В данном окне вы увидите шаблоны для проектов моделей. На данным момент вы можете создать проект Серверной части, которая содержит модели и классы для работы с ними. А также модуль веб-части, данный модуль содержит в себе представления, портлеты, и др. Модуль системы представляет собой ничто иное, как ASP.NET MVC проект, оформленный специальным образом, для того чтобы система при запуске распознала его как свой. Вы можете создать новый ASP.NET MVC проект или же воспользоваться шаблонами.
Рис.1. Окно создание нового проекта из шаблона
Функции доступные для расширения
В системе доступно огромное количество точек расширения, которые позволяют дополнить функционал системы.
Ниже приведен список наиболее востребованных с точки зрения бизнеса функций доступных для расширения:
- добавление в систему собственного портлета (например, портлета для отображения списка новых пользователей);
- добавление в левое или верхнее меню нового пункта, в том числе с собственной разметкой;
- создание собственных страниц в системе (создание веб-модуля);
- изменение визуального представления системных страниц (уровень пользовательской конфигурации).
Полный список доступных для использования точек расширения можно посмотреть в сгенерированной справке: 3.13, 3.15, 4.0.
Ниже представлены обучающие видео, рассказывающие, как добавить в систему собственный портлет и как создать свой модуль системы.
В этом видео запись вебинара для партнеров, в нем объясняется, как создать новый веб-модуль для системы (также смотри статью "Создание модуля для приложения"). Также в этом видео показано, как можно создать собственный портлет и вывести в нем существующие данные. Для создания примера в данном видео не использовался плагин Visual Studio, поэтому вы можете использовать версию Visual Studio 2010 Express для обучения.
В этом видео мы идем дальше и создаем свой серверный модуль, и с использованием плагина добавляем в него новые модели данных. Также мы вносим новые доработки в портлет и разбираем, как создавать табличные представления данных. Для создания примера в данном видео использовался плагин Visual Studio, поэтому вы можете использовать версию Visual Studio 2010 Professional или выше для обучения.