Creation of UI package with Backend logic

Передумови: Перш ніж почати, вам потрібно встановити Node.js та @angular/cli.

Цей репозиторій служить розширеним прикладом пакету на платформі mef.dev technical preview. Ми рекомендуємо використовувати цей приклад після ознайомлення з процесом створення базового плагіну.

Цей плагін не має втілення бізнес-логіки. Його мета - пояснити дизайн проекту Angular для взаємодії з власним бекендом на платформі.

Репозиторій призначений для запуску як пакет типу Portal разом з прикладом пакету: tutorial-backend-plugin.

У цьому проекті наведено пояснення основних можливостей передачі даних між плагінами.

Data acsses diagram

Як показано на діаграмі, деякі можливості REST обробляються за допомогою @natec/mef-dev-platform-connector, тоді як доступ до API бекенду плагіна та потоку BPMN можна реалізувати вільно і не містить обмежень.

First start

Можливості реєстрації та побудови плагіна описані тут. Ось короткий огляд:

Plugin Registration

Після встановлення пакетів та успішної побудови, якщо ви ще не реєстрували плагін на платформі MEF.DEV , вам необхідно це зробити.

Для цього вкажіть ваші базові облікові дані (bauth) у src\environments\environment.ts. Якщо ви ще не отримали облікові дані, вони можуть бути згенеровані на платформі MEF.DEV у розділі Settings, у елементі Credential. Після додавання нових облікових даних, замініть заглушку у файлі src\environments\environment.ts.

Тепер ви готові опублікувати свій плагін вперше. Запустіть CLI-скрипт з package.json.

npm run publish

Якщо ви побачите повідомлення Publish success після виконання скрипта, ви можете спробувати працювати з плагіном на платформі.

Debugging

Якщо ви згенерували облікові дані та зареєстрували плагін, ви можете запустити плагін у режимі налагодження (команда ng serve) на своєму комп'ютері.

ng serve та режим налагодження можливі лише після реєстрації плагіна!

Якщо ви бачите інформацію про плагін у першій вкладці, налаштування завершено, і ви вільні реалізувати та тестувати будь-яку функціональність на своєму комп'ютері без публікації.

Backend plugin

Для успішної роботи третьої вкладки (Запит до API плагіну) вам необхідно опублікувати бекенд частину плагіну. Робота з бекенд частиною описана тут. Вихідний код для бекенд частини зберігається у цьому репозиторію.

BPMN

Для успішного запуску процесу BPMN вам потрібно опублікувати потік simple-flow-example.bpmn (натисніть Create NEW у BPMN Flow Designer) з назвою simple-flow-example. Потім збережіть його у MyDraft і скомпілюйте. Якщо ви змінюєте назви, вам слід оновити Angular-додаток відповідно - збігайте назву бібліотеки тенанта та флоу у файлі.

Publish

Процес побудови та завантаження пакетів для пакету типу Портал схожий на попередні посібники, з основною відмінністю - вибір типу Порталу під час реєстрації. Цей тип пакету призначений для роботи з фронтендом + бекендом, що означає, що дані для обох компонентів фронтенду та бекенду повинні бути налаштовані належним чином.

Якщо ви вибрали реєстрацію через CLI publish, важливо встановити властивість serviceType як APIUI у файлі metadata.json file. Додаткову інформацію можна знайти тут.