Survey

Визначення:

Survey - конструктор для форми зворотнього зв’язку з можливістю відслідковувати результати на дашборді та вивантаження даних для подальшого опрацювання.

Особливості:

1. Відображається лише одна форма опитування (статус in published). (Наявний механізм який дозволяє розширити кількість)
2. Одна сторінка сайту - одна форма опитування.
3. Опитування можна застосувати як для Учасників аукціонів так і Спостерігачів (При активації Public survey).
4. В відповідях користувача відображаються номер питання на які він відповідав

5. Для створення опитування користувач повинен мати відповідні права

6. Де саме буде відображатись форма опитування залежить від того в яку частину коду сторінки його вбудували. 
7. При видаленні форми опитування, відповіді користувачів на неї зберігаються

Доступні панелі(сторінки) в адмінці:

1. General window
   1. Dashboard
2. Autentification and Autorization
   1. Group
   2. Users
3. Axes
   1. Access attempts
   2. Access failures
   3. Access logs
4. Celery Results
   1. Group results
   2. Task results
5. Forms
   1. Answers
   2. Questions
   3. Sites
   4. Surveys

Типи прав користувачів:

Опис панелей(сторінок)

Dashboard

Опис - панель (швидкого доступу/дії) до всіх сторінок адмін компоненти

Доступні дії:

1. Перехід на сторінку додавання/зміни налаштувань користувачів
2. Перехід на сторінку додавання/зміни налаштувань груп користувачів
3. Перехід на сторінку зміни можливостей доступу
4. Перехід на сторінку зміни помилок доступу
5. Перехід на сторінку зміни журналів доступу
6. Перехід на сторінку додавання/зміни результатів технічної оборобки групових результатів опитування
7. Перехід на сторінку додавання/зміни результатів технічної обробки позаданих результатів опитування
8. Перехід на сторінку зміни форми відповідей
9. Перехід на сторінку додавання/зміни результатів форми питань
10. Перехід на сторінку додавання/зміни результатів форми переліку сайтів 
11. Перехід на сторінку додавання/зміни результатів форми  survey

Groups

Опис - панель відображення вже наявних груп користувачів адмін компоненти та створення нових

Доступні дії:

1. Створення нової групи користувачів 
2. Текстовий пошук по співпадінню з полем - Group
3. Редагування/зміна/перегляд доступних дій (тільки для існуючих записів)
4. Видалення групи через сторінку групи або вибору через форму для швидкого видалення (тільки для існуючих записів)
5. Перегляд історії змін сторінки групи користувачів (тільки для існуючих записів)

Users

Опис - панель відображення/редагування вже наявних користувачів адмін компоненти та створення нових

Доступні дії:

1. Створення нового користувача
2. Пошук через форму/вибір з переліку користувача.
3. Текстовий пошук по співпадінню з полями
   • • • Username 
       • Email address
       • First name
       • Last name
       • Staff status
4. Редагування/внесення додаткової інформації про користувача/додання до групи коричтувачів (тільки для існуючих записів)
5. Видалення користувача через сторінку користувача або вибору через форму для швидкого видалення (тільки для існуючих записів)
6. Перегляд історії змін сторінки користувача (тільки для існуючих записів)

Access attempts

Опис - сторінка відображення/пошуку запитів доступу до адмін панелі

Доступні дії:

1. Пошук по часу спроби доступу
2. Пошук по шляху (Path)
3. Текстовий пошук по співпадінню з полями
4. Видалення інформації про запит доступу через сторінку запиту доступу або через форму для швидкого видалення (тільки для існуючих записів)

Access failures

Опис - сторінка відображення/пошуку помилок доступа до адмін панелі

Доступні дії:

1. Пошук по часу спроби доступу (Attempt Time)
2. Пошук по блокуванню доступу (Access lock out)
3. Пошук по шляху (Path)
4. Текстовий пошук по співпадінню з полями
5. Видалення інформації про помилку доступу через сторінку помилки доступу або через форму для швидкого видалення (тільки для існуючих записів)

Access logs

Опис - сторінка відображення/пошуку логірування дій користувачів адмін панелі

Доступні дії:

1. Пошук по роках
2. Пошук по часу логірування (Attempt Time)
3. Пошук по періоду розлогірування (Logout Time)
4. Пошук по шляху (Path)
5. Текстовий пошук по співпадінню з полями:
   • • • IP Address
       • Username
       • User Agent
       • Path
6. Видалення інформації про логування через сторінку логування або через форму для швидкого видалення (тільки для існуючих записів)

Group results

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

Доступні дії:

1. Пошук по даті/часу завершення
2. Текстовий пошук по співпадінню з полем Group ID
3. Створення нової групи результатів
4. Видалення групи результатів через сторінку групи результатів або через форму для швидкого видалення (тільки для існуючих записів)
5. Перегляд історії змін для групи результатів (тільки для існуючих записів)

Task results

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

Доступні дії:

1. Пошук по роках
2. Пошук по статусу задачі:
   1. FAILURE
   2. PENDING
   3. RECEIVED
   4. RETRY
   5. REVOKED
   6. STARTED
   7. SUCCES
3. Пошук по даті завершення задачі
4. Пошук по назві періодичного завдання
5. Пошук по назві завдання
6. Пошук по процесу який опрацьовує фонову задачу
7. Текстовий пошук по співпадінню з полем Task ID
8. Створення нового результату виконання завдання
9. Видалення результату виконання завдання через сторінку результатів виконання завдання або вибору через форму для швидкого видалення (тільки для існуючих записів)
10. Перегляд історії результатів виконання завдання (тільки для існуючих записів)

Answers

Опис - сторінка відображення/редагуавння/пошуку вже існуючих відповідей на форми опитувань

Доступні дії:

1. Пошук по роках
2. Пошук по даті створення
3. Пошук по типу процедури
4. Пошук по типу аукціону
5. Пошук по статусу учасника аукціону
6. Пошук по майданчику через який зареєстрований учасник
7. Текстовий пошук по співпадінню з полем Auction ID
8. Видалення форми відповіді через сторінку відповіді виконання завдання або вибору через форму для швидкого видалення (тільки для існуючих записів)
9. Вивантаження відповедей
10. Редагування полів відповідей
11. Перегляд meta data 
12. Перегляд історії змін форми відповіді (тільки для існуючих записів)

Questions

Опис - сторінка відображення/радагування/пошуку вже існуючих питань та створення нових

Доступні дії:

1. Пошук по типу питання
2. Пошук по назві питання
3. Текстовий пошук по співпадінню з полем Description
4. Створення нового питання
5. Редагування питання
6. Видалення форми питання через сторінку питання або через форму для швидкого видалення (тільки для існуючих записів)
7. Перегляд історії змін форми питання (тільки для існуючих записів)

Sites

Опис - сторінка відображення/створення/редагування вже існуючих сторінок сайту для опитування та створення нових

Доступні дії:

1. Пошук по статусу опублікування
2. Текстовий пошук по співпадінню з полем Site Name
3. Створення нового сайту (сторінки для відображення опитування)
4. Редагування сайту (сторінки для відображення опитування)
5. Видалення сайту з переліку через сторінку сайту або через форму для швидкого видалення (тільки для існуючих записів)
6. Перегляд історії змін сайту (тільки для існуючих записів)

Surveys

Опис - сторінка відображення/створення/редагування вже існуючих сторінок опитувань та створення нових

Доступні дії:

1. Пошук опублікуванню
2. Пошук по назві сайту
3. Текстовий пошук по співпадінню з полем Name
4. Пошук по публікації для учасників аукціону або спостерігача
5. Cтворення нової форми опитування
6. Редагування форми опитування
7. Видалення форми опитуваання з переліку через сторінку опитування або через форму для швидкого видалення (тільки для існуючих записів)

Конфігурації опитувань

Типи опитувань

• Questions with answer multiple options - питання з багатьма виборами відповіді. Потрібно вказати мінімальну та максимальну кількість обраних варіантів відповіді.
• Open question - питання з відкритою формою відповіді. Потрібно вказати мінімальне та максимальне значення символів у полі (при введенні відповіді, починаючи з 400 символу з'являється лічильник виду 400/500)
• Short open question - питання з короткою відкритою відповіддю. Потрібно вказати мінімальне та максимальне значення символів у полі
• Questions to determine NPS - питання з вибором оцінки від...до. Потрібно вказати мінімальне та максимальне значення оцінки. Користувач може обрати лише одне значення.
  Формула розрахунку: від суми кількості відповідей з оцінками 9,10 відняти суму кількості відповідей з оцінками 0,1,2,3,4,5,6 та розділити на загальну кількість відповідей.
• Questions with answer options - питання з вибором одного варіанту відповіді. 

Механіка відображення опитувань

Для Учасника аукціону та Спостерігача (При активації Public survey)

• якщо учасник взяв участь в опитуванні - після оновлень форма більше не відображається.
• якщо цей же учасник, що відправив відповіді у одному браузері, відкриє цей самий аукціон в іншому браузері - форма буде активна для нього.
• якщо учасник згортає форму, перезавантажує сторінку, закриває сторінку з непройденим опитуванням - при наступному відкритті сторінки форма активна
• через три години після завершення аукціону, форма доступна учаснику, що НЕ брав участь у опитуванні.
• через три години після завершення аукціону, форма НЕ доступна учаснику, що брав участь у опитуванні.

• Для МА показ відбувається після завершення аукціону.

Експорт сирих даних 

• Експорт сирих даних у форматі excel/csv у вигляді таблиці з наступними полями 
• Експорт даних реалізовано через bi з можливістю перегляду графіків

Вид відображення форми опитування

1. Формат показу: модальне вікно_, _блок у нижньому правому куті
2. Заголовок форми опитування
3. Підзаголовок форми опитування
4. 1-n питання, (будь-яких з доступних типів)
5. Вікно з заголовком та текстом подяки після заповнення форми
6. Кнопка для відправлення форми опитування (за замовчуванням не активна, активація відбувається після внесення відповіді на хоча б одне питання відповіді)
7. Кнопка для приховання форми опитування
8. Кнопка для закриття форми подяки

Функціональні можливості

Створення нового користувача (можливо для користувачів з певним переліком доступів)

1. Переходимо на сторінку Users
2. Натискаємо елемент «Add user»
3. Заповнюємо форму «Username» (латиниця, без пробілів)
4. Заповнюємо форму «Пароль»

Обмеження:

• Пароль не може бути дуже схожим на вашу іншу особисту інформацію.
• Пароль має містити не менше 8 символів.
• Пароль не може бути типовим паролем.
• Пароль не може бути повністю цифровим.

1. Заповнюємо форму «Підтвердження паролю» (повторно вводимо пароль з попередньої форми)
2. Підтверджуємо дію:

• • • • Зберегти
      • Видалити (доступно тільки для попередньо збережених елементів)
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування (доступно тільки для попередньо збережених елементів)

Редагування інформації про користувача (можливо для користувачів з певним переліком доступів)

1. Переходимо на сторінку Users
2. Обираємо необхідного користувача з переліку
3. Переходимо на сторінку користувача
4. Переходимо на вкладку Personal Info
5. Вносимо коректну інформацію в поля:

• • • • First Name
      • Last Name
      • Email Address

1. Переходимо на вкладку Permission та налаштовуємо доступ і права користувачу
2. Підтверджуємо дію:

• • • • Зберегти
      • Видалити
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування

Створення нової групи користувачів (можливо для користувачів з певним переліком доступів)

1. Переходимо на сторінку Groups
2. Натискаємо елемент «Add group»
3. Заповнюємо форму «Name»
4. Додаємо необхідні права для користування адмін компонентою
5. Підтверджуємо дію:

• • • • Зберегти
      • Зберегти і додати інші
      • Зберегти і подовжити редагування

Редагування/зміна/перегляд доступних дій для групи користувачів (можливо для користувачів з певним переліком доступів)

1. Переходимо на сторінку Groups
2. Обираємо групу користувачів для внесення змін або перегляду
3. Змінюємо назву (якщо потрібно)
4. Переносимо доступні дії (якщо потрібно)
5. Підтверджуємо дію:

• • • • Зберегти
      • Видалити
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування

Створення групового результату (можливо для користувачів з певним переліком доступів)

1. Переходимо на сторінку Group results
2. Натискаємо елемент «Add group results»
3. Вносимо коректну інформацію в поля:
   • • • Group ID* (обов'язкове поле)
       • Result Content Type * (обов'язкове поле)
       • Result Encoding * (обов'язкове поле)
4. Підтверджуємо дію:

• • • • Зберегти
      • Зберегти і додати інші
      • Зберегти і подовжити редагування

Механіка створення результату задачі (можливо для користувачів з певним переліком доступів)

 Технічна задача яка виконується при опрацюванні відповідей на форму опитування

Після відправки опитування на якийсь сайт, збільшується счетчик Showing number (без різниці чи бачила людина дане опитування чи ні, система віддала опитування і зробила +1) - фоновая celery задача.
Після прийняття відповіді на опитування, посинається процес отримання додаткової інформації, якщо в переданих нам даних наявний auction_id - фоновая celery задача.

• auction_id - не заповнює інтернет користувач, цю інформацію може надати сайт на якому встановлена форма опитування - третя сторона додаткової інформації отримується з сервису Search (вона публична), дані процедури:
• value - value.amount процедури
• procedure_type - з sellingMethod
• auction_type - з sellingMethod

• якщо разом з auction_id була передана інформація bidder_id :

• owner - майданчик користувача, який відповів на форму опитування (майданчик)
• bid_status - awards.status
• award_value - awards.value

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

1. Переходимо на сторінку Answers
2. Обираємо відповідь для внесення змін або перегляду
3. Змінюємо інформацію в полі Survey 
4. Змінюємо інформацію у вкладці Auction Data:
   • • • Auction ID
         
       • Auction Type
         
       • Procedure Type
         
       • Bid counts
       • Owner
       • Value
       • Award value
       • Bid status * (обов'язкове поле)
       • Auction terminated
       • Procedure terminated
5. Підтверджуємо дію:

• • • • Зберегти
      • Видалити
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування

Створення нового питання

1. Переходимо на сторінку Questions
2. Натискаємо елемент «Add question»
3. Вносимо коректну інформацію в поля:
   • • • Survey * (обов'язкове поле) - обираємо з переліку запропонованих
       • Required - чи є питання обов’язковим для заповнення
       • Type * (обов'язкове поле) - обираємо з переліку запропонованих
       • Description * (обов'язкове поле)
       • Order * (обов'язкове поле)
       • Config * (обов'язкове поле) заповнюється відповідно до типу питання
4. Підтверджуємо дію:
   • • • Зберегти
       • Зберегти і додати інші
       • Зберегти і подовжити редагування

Редагування питання

1. Переходимо на сторінку Questions
2. Обираємо питання для внесення змін або перегляду
3. Вносимо зміни в поля (якщо необхідно):
   • • • Survey * (обов'язкове поле) - обираємо з переліку запропонованих
       • Required - чи є питання обов’язковим для заповнення
       • Type * (обов'язкове поле) - обираємо з переліку запропонованих
       • Description * (обов'язкове поле)
       • Order * (обов'язкове поле)
       • Config * (обов'язкове поле) заповнюється відповідно до типу питання
4. Підтверджуємо дію:

• • • • Зберегти
      • Видалити
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування

Створення нового сайту (сторінки для відображення опитування)

1. Переходимо на сторінку Sites
2. Натискаємо елемент «Add site»
3. Вносимо коректну інформацію в поля:
   • Site Name *(обов'язкове поле)
   • Is published - чи опублікована форма
4. Підтверджуємо дію:

• • • • Зберегти
      • Зберегти і додати інші
      • Зберегти і подовжити редагування

Редагування сайту (сторінки для відображення опитування)

1. Переходимо на сторінку Sites
2. Обираємо сайт для внесення змін або перегляду
3. Змінюємо 
4. Підтверджуємо дію:

• • • • Зберегти
      • Видалити 
      • Зберегти і додати інші
      • Зберегти і подовжити редагування
      • Подивитись історію редагування

Додавання нової форми опитування

1. Переходимо на сторінку Surveys
2. Натискаємо елемент «Add survey»
3. Вносимо коректну інформацію в поля на вкладці General:
   • • • Site* (обов'язкове поле) - обираємо з переліку запропонованих де буде відображатися форма
       • Name* (обов'язкове поле) -  назва форми фітбеку
       • Public survey - даний пункт відповідає за форму лише для Спостерігача, не відмічати для Учасника
       • Is published - чи опублікована форма
       • Publication date - дата публікації
       • Expiration date - дата завершення активності форми
       • Auto render - опитування відображається в згорутому форматі або розкритому (активна - розкритий, неактивна - закритий)
       • Showing number* (обов'язкове поле) - скільки разів було показано опитування
       • Last seen datetime
       • Title - заголовок форми
       • Subtitle - підзаголовок форми
       • Thanks title - заголовок вікна подяки після заповнення форми
       • Thanks text* (обов'язкове поле) - текст для вікна подяки після заповнення форми
       • Cancel button title - текст кнопки, для приховування форми
       • Submit button title - текст кнопки, для відправки форми
       • Close button title - текст кнопки, для закриття вікна подяки
       • Language* (обов'язкове поле) - мова інтерфейсу, де буде відображено форму
4. Вносимо коректну інформацію в поля на вкладці Question
5. Натискаємо елемент «New question»
6. Вносимо коректну інформацію в поля:
   • • • Required - чи є питання обов’язковим для заповнення
       • Type * (обов'язкове поле) - обираємо з переліку запропонованих
       • Description * (обов'язкове поле)
       • Order * (обов'язкове поле)
       • Config * (обов'язкове поле) заповнюється відповідно до типу питання
       • Є можливість видалити питання за допомогою елемента Remove
7. Підтверджуємо дію:

• • • • Зберегти
      • Зберегти і додати інші 
      • Зберегти і подовжити редагування

Редагування форми опитування

1. Переходимо на сторінку Surveys
2. Обираємо форму опитування для внесення змін або перегляду
3. Вносимо зміни в поля на вкладці General (якщо необхідно):
   • • • Site* (обов'язкове поле) - обираємо з переліку запропонованих де буде відображатися форма
       • Name* (обов'язкове поле) -  назва форми фітбеку
       • Public survey - даний пункт відповідає за форму лише для Спостерігача, не відмічати для Учасника
       • Is published - чи опублікована форма
       • Publication date - дата публікації
       • Expiration date - дата завершення активності форми
       • Auto render
       • Showing number* (обов'язкове поле) - 
       • Last seen datetime
       • Title - заголовок форми
       • Subtitle - підзаголовок форми
       • Thanks title - заголовок вікна подяки після заповнення форми
       • Thanks text* (обов'язкове поле) - текст для вікна подяки після заповнення форми
       • Cancel button title - текст кнопки, для приховування форми
       • Submit button title - текст кнопки, для відправки форми
       • Close button title - текст кнопки, для закриття вікна подяки
       • Language* (обов'язкове поле) - мова інтерфейсу, де буде відображено форму
4. Вносимо зміни в поля на вкладці Question (якщо необхідно):
   • • • Required - чи є питання обов’язковим для заповнення
       • Type * (обов'язкове поле) - обираємо з переліку запропонованих
       • Description * (обов'язкове поле)
       • Order * (обов'язкове поле)
       • Config * (обов'язкове поле) заповнюється відповідно до типу питання
       • Є можливість видалити питання за допомогою елемента Delete
       • Є можливість додати інше питання за допомогою елемента Add another Question
5. Підтверджуємо дію:

• • • • Зберегти
      • Видалити
      • Зберегти і додати інші питання
      • Зберегти і подовжити редагування
      • Подивитись історію редагування
• Особливість: при редагуванні форми опитування користувачам що вже дали відповідь на нього, опитування не буде показано порторно

Додавання опитування на сторінку:

1. Створити новий запис на сторінці Sites
2. Створити новий запис на сторінці Surveys (де вказати назву створеного запису на сторінці Sites)
3. Створити новий запис на сторінці Questions (де вказати назву створеного запису на сторінці Surveys)/ створити на сторінці Surveys на вкладці Question

Технічні вимоги: 

ТЗ - https://gitlab.prozorro.sale/public-projects/documentations/-/blob/master/Product_requirements/Feedback_form_auction-module/MA-feedback-form.md

Swagger - https://auction-sandbox.prozorro.sale/api/survey/doc/

Дизайн Figma -https://www.figma.com/file/Rci9mTmSsjWSq0QBZPVQXo/Prozorro.Sale-Redesign?type=design&node-id=7640-73199&mode=design&t=84NYIkNSDttMPEqu-0

Endpoint to bi:

GET /api/survey/answers

[{

    "id": <id>,

    "survey_id": <survey_id>,

    "site_id": <site_id>

    "questions": [

        "answer": <data from answers value>,

        "type": <question_type>,

        "description": <description>

    ],

    "auction_data": {

       "auction_id": <auction_id>,

       "auction_type": <auction_type>,

      "procedure_type": <procedure_type>,

       "value": <value>,

       "owner": <owner>,

       "bid_status": <bid_status>,

       "bid_id": <bid_id>

    },

    "created_at": <created_at>

}]