@opengis/docm

This service provides a robust platform for dynamic document generation and template lifecycle management, enabling teams to create, manage, and export documents from structured data with full control over content and formatting.

Features

• Centralized template registry with list, view, and edit capabilities
• Support for multiple template formats: DOCX, Markdown/TXT, HTML, and block-based
• Online template editor for real-time updates
• Configurable variable schema for dynamic data binding
• Flexible document generation: template + JSON, template + form input, or template + external ID
• Ability to provide additional data during document creation
• Real-time preview with built-in sample data generator
• Document registry for managing generated documents
• Post-generation document editing
• Document lifecycle management: draft / in_approval / signed / closed
• Export to PDF and DOCX formats

Features Enterprise

• Template Registry – Centralized governance of templates with full lifecycle control and auditability
• Multi-Format Support – Standardize document creation across DOCX, HTML, and Markdown formats
• Dynamic Data Binding – Structured variable schema for consistent and controlled data injection
• Flexible Generation Engine – Integrate with internal systems via JSON, forms, or external IDs
• Document Lifecycle Management – Enforce workflows from draft to approval, signing, and closure
• Document Registry – Maintain a single source of truth with filtering, metadata, and traceability
• Real-Time Preview – Validate outputs instantly with controlled sample data
• Post-Generation Editing – Enable controlled updates while preserving document integrity
• Export & Compliance – Generate PDF/DOCX outputs for legal and operational use

Install

npm i @opengis/docm

Usage

// router.config
export default [
  {
    path: "/templates/:id?",
    component: () => import("@opengis/docm").then((m) => m.TemplateRoute),
    props: { routePath: "/templates/:id?" },
  },
  {
    path: "/documents/:id?",
    component: () => import("@opengis/docm").then((m) => m.Document),
  },
];

Config Data Provider

Конфігурація Data Provider описує джерела даних для підстановки в шаблони та генерації документів. Приклад user

Файли розміщуються в:

/config/docm/*.yml

Призначення:

• Отримання даних з БД (SQL)
• Підстановка змінних у шаблони
• Джерело для select/lookup полів
• Генерація документів (template + id)

Структура файлу

# Легкий SQL для autocomplete/select.
suggest: <SQL для пошуку> 

# Використовуються в UI
title.en: <Назва EN>
title.ua: <Назва UA>
description.ua: <Опис>

# Основний запит для отримання повних даних. Використовується при генерації документа.
sql:
  - <SQL частина 1>
  - <SQL частина 2>

Використання:

1. Користувач обирає запис (через suggest)
2. Система отримує дані (sql)
3. Дані підставляються в шаблон

UI Компоненти

| UI Компонент | Короткий опис | | ------------------------ | --------------------------------------------------------------------------------------------------------------------- | | Редактор шаблонів | Інтерфейс для створення, перегляду та редагування шаблонів документів із підтримкою змінних і preview. | | Реєстр документів | Список згенерованих документів із фільтрами, статусами, метаданими та діями перегляду/редагування/експорту. | | Віджет “Шаблон + ID” | Компонент для генерації документа за обраним шаблоном і зовнішнім ID джерела даних. | | Віджет “Документи по ID” | Компонент для перегляду всіх документів, пов’язаних з конкретним ID, з можливістю створити новий документ по шаблону. |

Бізнес-процес

1. Налаштувати Data Provider
2. Створити шаблон і привязати до провайдеру
3. Віджет в картку документу - шаблон + id
4. Віджет в картку документу перелік документів по id і створити по шаблону

Documentation

For a detailed understanding of dataset, its features, and how to use them, refer to our Documentation.

Technology stack

Contribute

Feel free to contact us through our website SOFTPRO.UA or email [email protected]

• Report bugs
• Share your ideas
• Ask questions

Follow Us

Official site

License

Copyright © SOFTPRO. All rights reserved.