Аудит UI-форм бізнес-процесів

Зниження продуктивності при рендерінгу форми в браузері

Ускладнення внесення змін до форми розробниками регламенту

Погіршення користувацького досвіду при заповненні або перегляді форми

Збільшення ймовірність виникнення системної помилки у користувача при роботі з формою (наприклад, втрата заповнених даних через закінчення сесії користувача)

Ускладнення тестування форми. Велика кількість тест кейсів, які треба покрити

При внесенні даних, розбивати форму на декілька окремих і робити збір даних поетапно

При перегляді даних:

Уникати комплексної вкладеності компонентів зі складними зв’язками

При первинному рендерінгу форми

При зміні в пов’язаному компоненті

При оновленні користувацького токена (системна поведінка, яка відбувається безумовно незалежно від дій користувача)

Додаткове навантаження на сервери та мережу

Збільшення часу рендерінгу форми

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

Уникати створення великих форм (див. FR-01. Великі форми)

Використовувати lazy load для компонентів Select якщо їх кількість на формі достатньо велика (понад 5)

Використовувати eager load у випадках, коли це дійсно може покращити користувацький досвід. Наприклад, для першого компоненту Select на формі, щоб у користувача відразу після рендерінгу форми були необхідні дані для вибору

Контроль обсягу використання Javascript. Обмежувати складність javascript логіки в формах. Намагатися зберігати логіку якомога простішою та більш прямолінійною.

Використовувати вбудовані можливості конструктора форм для валідації та обробки даних

Уникати побічних ефектів в місцях використання. Кожна вставка javascript логіки має єдину відповідальність (валідація, умовне відображення, обробка даних тощо) та не має впливати на інші частини форми

Браузер заблокує виконання запиту до АПІ сервісу через CORS політики

АПІ сервіс заблокує запит через відсутність необхідної Cookie

Якщо АПІ сервіс відкритий і не потребує авторизації:

Якщо АПІ сервіс потребує авторизації та рішення припускає наявність кукі (cookie) для авторизації на домен АПІ сервісу в браузері необхідні наступні умови:

Додатково перед виходом в промислове середовище потрібно перевірити налаштування АПІ сервісу та форми та впевнитися, що вони заздалегідь адаптовані до вимог CORS політик. Наприклад, домен користувача кабінету доданий в налаштування зовнішнього АПІ сервісу

Оновлені: адаптовані компоненти під рішення та дизайн кабінетів. Розробка та тестування цих компонентів підтримується командою розробки платформи

Експериментальні: стандартні компоненти Form.io. Не адаптовані під систему. Не підтримуються командою розробки платформи й не тестуються на відповідність вимогам системи

Компоненти: застарілі адаптовані компоненти, які вже не підтримуються командою розробки платформи

Працездатність форми, яка містить компоненти з категорій Експериментальні та Компоненти не гарантується

Використовувати компоненти з категорії Оновлені

Якщо використання компонентів з інших категорій є обґрунтованим, врахувати всі можливі ризики й приділити тестування таких форм більшу увагу

Окремо слід зауважити, що використання компонентів з категорії Експериментальні чи Компоненти з подальшим ручним виправленням коду і зміни типа на latest, що відповідає оновленому компоненту може призвести до непередбачуваних наслідків і працездатність не гарантується в такому випадку

Додаткове непотрібне навантаження на реляційну базу даних

Додаткове непотрібне навантаження на сервіс синхронного управління даними реєстру

Збільшення часу рендерінгу форми

Задавати параметр limit для компонента Select в мінімально необхідне значення для коректного функціонування форми

Використання параметра Disable limiting response повинно бути обґрунтоване і у більшості випадків не рекомендується

Результат математичних обчислень, що виконують на стороні клієнта можуть бути скомпрометовані й не можуть вважатися правдивими

Компонент Number використовує Javascript тип Number, який не є точним для фінансових обчислень і його використання для великих чисел може бути небезпечним

Використовувати DMN таблиці чи бізнес-процеси для виконання математичних обчислень

Для покращення користувацького досвіду та швидшого розуміння результату обчислення користувачем, логіка може бути продубльована на клієнті, але результат повинен ігноруватися на сервері

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

Користувач не зможе виконати користувацьку задачу при наступних умовах:

На формах, де передбачається використання маски, перевіряти відповідні дані для передзаповнення полів в бізнес-процесі

Особливу увагу приділяти даним, які були отримані зі сторонніх систем, і які з великою ймовірністю можуть не відповідати масці

Розглянути можливість відмови від використання масок. Іноді додаткові зусилля на підтримку масок для даних з різних джерел можуть бути недоцільними. Також маску можна залишити для вводу даних, але не використовувати її для передзаповнення

Збільшення часу рендерінгу форми через наступні причини:

Використовувати параметр для оптимізації рендерінгу колонок Edit Grid (Вкладка Data, чекбокс Optimize column render). Цей параметр вимикає всі можливості по складній логіці вкладених компонентів (javascript код, який відповідає за валідацію, умовне відображення, обчислювальне значення, виклики критеріїв пошуку тощо). Тобто, таблиця буде відображати тільки дані які підготовлені заздалегідь в бізнес-процесі, або додані користувачем. При цьому форма, яка відповідає за додавання нового елементу в таблицю збереже відповідні можливості.

Уникати використання файлів в Edit Grid для відображення даних, які були підготовленні в БП. Для перегляду файлів використовувати детальну картку для окремого запису на окремій формі.

Використовувати мінімум даних для перегляду в таблиці: