Налаштування регламенту для формування витягів (звітів) у форматі PDF, DOCX, CSV

ЗМІСТ

1. Загальний опис
2. Робота з регламентом реєстру

1. Загальний опис

Формування та завантаження витягів (звітів) у форматі .pdf, .docx, .csv, а також заповнення файлів відповідними бізнес-даними реєстру можливе лише за умови попередньої конфігурації на рівні регламенту реєстру.

Адміністратор реєстру має додати попередньо сформований шаблон витягу (звіту) та його атрибути до відповідної директорії регламенту реєстру, наприклад:

для .pdf — excerpts/my-report-excerpt-pdf/index.html.ftl;
для .docx — excerpts-docx/my-report-excerpt-docx.docx;
для .csv — excerpts-csv/my-report-excerpt-csv.csv.

де:

excerpts, excerpts-docx, excerpts-csv — обов’язкова назва директорії для витягів (звітів) у відповідному форматі;
index.html.ftl, my-report-excerpt-docx.docx, my-report-excerpt-csv.csv — приклади назв звітів у відповідному форматі.

Назви кожної директорії та самих файлів мають бути унікальними, навіть для різних форматів.

На базі цих шаблонів формуватимуться файли витягів (звітів) у Кабінетах користувачів реєстру у відповідному форматі.

2. Робота з регламентом реєстру

2.1. Налаштування регламенту для витягу (звіту) у форматі PDF

Для додавання шаблону генерування витягів (звітів) у форматі .pdf, необхідно виконати такі налаштування у регламенті відповідного реєстру:

Детальну інформацію щодо роботи з регламентом реєстру ви можете знайти на сторінці Процес розгортання регламенту в Gerrit.

Увійдіть до локального репозиторію Gerrit реєстру.

Покладіть файл із шаблоном витягу (звіту) до директорії з ресурсами шаблону, яка має унікальне ім’я для заданого шаблону excerpts/my-report-excerpt-pdf/index.html.ftl.

Шаблон витягів (звітів) має бути розроблений у спеціальному форматі .html.ftl. Такий шаблон необхідно створити у розмітці HTML за допомогою технології шаблонізації Apache FreeMarker, обробника шаблонів, що використовується для читання синтаксису, який налаштовується для підстановки змінних у шаблонах pdf (.html.ftl) або для фортму .docx.

Детальну інформацію щодо Apache FreeMarker можливо отримати за посиланням:

https://freemarker.apache.org/

Назва файлу шаблону завжди вказується index.html.ftl, а директорією задається назва витягу (звіту), наприклад, my-report-excerpt-pdf.

Збережіть стилі, які застосовуватимуться для шаблону витягу (звіту). Для цього сформуйте файл style.css та покладіть його до директорії excerpts/my-report-excerpt-pdf/css.

Приклад: <link rel="stylesheet" href="style1.css">.

Також можливе використання декількох файлів стилізацій .css для цього необхідно вказати посилання на кожен файл, наприклад:

<html>
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="style1.css">
    <link rel="stylesheet" href="style2.css">
    <link rel="stylesheet" href="style3.css">
    <style>
    .....
    * { font-family: Roboto; }
    </style>
</head>
<body>

Обов’язково застосовується кодування UTF-8;
За замовчуванням використовується шрифт * { font-family: Roboto; }, що автоматично додається до стилів. Використання інших шрифтів не допускається, в іншому випадку це може призвести до конфліктних помилок в роботі.

Можливо задати горизонтальну орієнтацію сторінки витягу (звіту), для цього необхідно налаштувати style.css, наприклад:

@page {
size: 15in 8.5in;
margin-bottom: 0.75in;
margin-left: 0.9in;
margin-right: 0.9in;
margin-top: 0.75in;
}

У параметрі "size" зазначається широта (у прикладі 15in) і висота (у прикладі 8,5in) файлу у дюймах (inches), також налаштовуються додаткові параметри відступу полів.

Збережіть зображення у форматі .png, яке використовуватиметься для файлу витягу (звіту). Для цього покладіть зображення до директорії excerpts/my-report-excerpt-pdf/images.

Приклад: <img src="images/image.png">.
Збережіть внесені зміни до віддаленого репозиторію Gerrit.
Після розгортання регламенту реєстру та налаштування бізнес-процесу, у Кабінеті користувача з’явиться можливість ініціювати бізнес-процес для формування та завантаження витягу (звіту) у форматі .pdf (детальніше — за посиланням).

2.2. Налаштування регламенту для витягу (звіту) у форматі DOCX

Для додавання шаблону генерування витягів (звітів) у форматі .docx, необхідно виконати такі налаштування у регламенті відповідного реєстру:

Увійдіть до локального репозиторію Gerrit реєстру.
Покладіть файл із шаблоном витягу (звіту) до директорії з ресурсами шаблону, яка має унікальне ім’я для заданого шаблону excerpts-docx/my-report-excerpt-docx.docx.
Збережіть внесені зміни до віддаленого репозиторію Gerrit.
Після розгортання регламенту реєстру та налаштування бізнес-процесу, у Кабінеті користувача з’явиться можливість ініціювати бізнес-процес для формування та завантаження витягу (звіту) у форматі .docx (детальніше — за посиланням).

За вказаним прикладом можна ознайомитися з можливостями формування вмісту витягу (звіту) у форматі .docx.

Приклад моделювання бізнес-процесу з формування витягів (звітів) у форматі csv та docx доступний за посиланням.

2.3. Налаштування регламенту для витягу (звіту) у форматі CSV

Для додавання шаблону генерування витягів (звітів) у форматі .csv, необхідно виконати такі налаштування у регламенті відповідного реєстру:

Увійдіть до локального репозиторію Gerrit реєстру.

Покладіть файл із шаблоном витягу (звіту) до директорії з ресурсами шаблону, яка має унікальне ім’я для заданого шаблону excerpts-csv/my-report-excerpt-csv.csv.

Для того, щоб змінити назви заголовків колонок, необхідно в директорії excerpts-csv відповідного витягу (звіту) створити файл .json або .csv з налаштуваннями заміни назв, наприклад:

{
  "lastName": "Прізвище",
  "firstName": "Ім'я",
  "secondName": "По батькові",
  "birthday": "Дата народження",
  "residenceAddress": "Адреса",
  "phoneNumber": "Телефон",
  "gender": "Стать",
}

У першій колонці зазначаються назви параметрів, що буде використано у витягу (звіті), у другій вказуються назви, на які потрібно замінити заголовки колонок.

Збережіть внесені зміни до віддаленого репозиторію Gerrit.
Після розгортання регламенту реєстру та налаштування бізнес-процесу, у Кабінеті користувача з’явиться можливість ініціювати бізнес-процес для формування та завантаження витягу (звіту) у форматі .csv (детальніше — за посиланням).

Приклад моделювання бізнес-процесу з формування витягів (звітів) у форматі csv та docx доступний за посиланням.