- Plugin basics
- Introduction
- Platform overview
- Plugin guides
- First UI package
- Package registration
- First Backend package
- Portal package creation
- REST API
- REST API using
-
Request Formats
- HTTP GET: Getting a list of elements of type Entity
- HTTP GET: Getting a specific Element of the Entity Type
- HTTP PUT: Editing an Entity Type Element
- HTTP POST: Creating a new Element of Entity Types
- HTTP POST: Doing an Action for Element of Entity Types
- HTTP POST: Creating an new element Sub-Entity of Types
- HTTP DELETE: Deleting the element of Entity Types
- HTTP PATCH: Partially editing the element of Entity Types
- Handling Errors When Calling HTTP Methods
Registration and uploading of packages
Дана інструкція для реєстрації та завантаження UI плагіну для платформи MEF.DEV. Для цього необхідно бути зареєстрованим користувачем платформи - якщо Ви не зареєстровані, то під час першого входу на mef.dev technical preview Вам буде надано можливість пройти реєстрацію на основі облікового запису LinkedIn.
Згідно послідовності нижче будемо реєструвати плагін-приклад із мінімальним функціоналом за типом Canvas
але для інших типів плагінів процес аналогічний.
Package registration into platform
Для початку перейдемо на сторінку створення плагіну - вона знаходиться в пункті меню Плагіни
платформи mef.dev та доступна після логіну користувача на mef.dev technical preview.
![]() |
---|
Примітка. Даний функціонал доступний користувача із ролями Developer Admin та Developer
Після натискання кнопці Додати ми попадаємо на сторінку створення плагіну. При цьому нам необхідно вказати деталі нового плагіну, наведені нижче:
- Аліас - назва предметної області плагіну, яка використовується задля об’єднання плагінів за функціональним призначенням (логічна група). Важливо зрозуміти, що назви плагінів не можуть пересікатись у межах одного аліасу.
- Ім'я - назва плагіну.
Вводимо ці дані, і переходимо до вибору типу плагіну. У поточної версії платформі існує 4 основних типи плагінів - про призначення кожного типу та відмінності між ними написано в блоці допомоги зеленого коліру. Зараз нас цікавить тип
Canvas
- плагін, що містить лише UI складову, тому ми вибираємо його. Після вибору у нас активувавсяFrontend
блок. Він містить лише одне полеFrontendPluginName
. Це є селектор основного модуля в плагіні. Детальніше про нього розказувалось в інструкції створення плагінуз нуля
. Вводимо назву з прикладу, яка становить значенняplugin-example
та нажимаємо кнопку Зберегти.
В разі, якщо всі поля введені правильно, відбудеться перехід на сторінку конфігурації плагіна.
Примітка. В подальшому на неї можна попасти через кнопку
Налаштувати
в рядку плагіна що розташований в меню Плагіни
![]() |
---|
Configuration of package
Для того щоб плагін працював перед завантаженням потрібно провести базові налаштування.
General settings
Це лише інформаційні параметри - вони не впливають на роботу плагіна та використовуються лише для відображення плагіна в межах платформи.
Dependencies settings
Використовується в випадку, якщо плагін використовує функціонал інших та вже завантажених backend плагінів платформи, наприклад API або Service.
Примітка. При добавленні Dependencies базова інформація про них передаватиметься в UI плагін за допомогою @natec/mef-dev-platform-connector
Router Links settings
Застосовується тільки для плагінів типу Canvas
та Portal
. Необхідний для прописування сторінок в межах плагіну. Платформа резервує набір сторінок в межах плагіну. Для роботи потрібно прописати сторінки які будуть використовуватись плагіном.
Uploading version of package
Завантаження першої або нової версію плагіна відбувається в блоці Frontend.
При натисканні кнопки для завантаження потрібно вибрати архів зібраного контенту плагіна – цей архів уявляє собою упакований контент папки dist
.
Увага! Контент повинен розміщуватися в корені архіву!
Завантажити вже завантажену версію неможливо – тому важливо керувати номерами версій та змінити версію аплікації в package.json
.
В комбо вибору версії відображається актуальна версія, яка буде надана користувачеві по замовчанням при звернення до плагіну.
У деяких сценариях використання доцільно звернення до різних версій одночасно, тому платформа надає такої можливості на протязі життьового циклу плагіну у платформі