XSQUARE – REPORTS

Обновлено 20 октября 2025 г.

XSQUARE — REPORTS — это самостоятельный веб-сервис, предназначенный для формирования отчетов в различных форматах из документов-шаблонов по HTTP-запросу в форматах XML или JSON на основе запросов с данными и шаблонов документов в различных форматах.

Инструкция по развертыванию
  1. В консоли управления выберите каталог, в котором хотите развернуть приложение.
  2. Выберите сервис Cloud Apps.
  3. На панели слева выберите Магазин приложений.
  4. Выберите XSQUARE — REPORTS и нажмите кнопку Использовать.
  5. Укажите:
    • Имя приложения.
    • (Опционально) Описание приложения.
    • Сервисный аккаунт на каталог или выберите Автоматически, чтобы нужный сервисный аккаунт создался при установке приложения. От имени этого сервисного аккаунта будут создаваться ресурсы приложения. У сервисного аккаунта минимально должны быть указаны следующие роли:
      • resource-manager.admin
      • compute.editor
      • iam.editor
      • vpc.publicAdmin
    • Сеть.
    • Подсеть.
    • Логин пользователя ВМ.
    • Публичный ключ пользователя для подключения к ВМ.
    • Размер пользовательского диска для хранения шаблонов.
  6. Нажмите кнопку Установить и дождитесь, пока приложение установится.
  7. После установки для использования собственных шаблонов выполните следующие действия:
    1. Поместите директорию с Вашими шаблонами в /data/<путь/к/шаблонам>/templates/
    2. Укажите путь к директории /data/<путь/к/шаблонам> (суффикс /templates не должен указываться в настройках) в файле конфигурации сервиса в /usr/local/xsquare.xreports/config.json в объекте "app" по ключу "data-directory" (подробнее см. документацию)
    3. Перезагрузите сервис
      sudo systemctl restart xsquare.xreports
Тип тарификации
Free
Тип
Cloud Apps
Категория
Базы данных
Инструменты для разработчиков
В реестре российского ПО
Издатель
ООО "ХИ-КВАДРАТ"
Примеры использования

Пример вызова сервиса для генерации DOCX документа:

curl -X POST \
  'http://<floating_ip_address>:8886/word_report_json' \
  -H 'Content-Type: application/json' \
  -d '{
        "template":
          {
            "uri": "local",
            "id": "examples/docx/first_report_template"
          },
        "input-data":
          {
            "ORGANIZATION": "ООО «Пример»",
            "DATE": "01.01.2023",
            "EMP": "Иванов Иван Иванович"
          },
        "options":
          {
            "output-mode": "binary"
          }
      }' \
  --output "my_first_report.docx"

Больше примеров для тестирования генерации отчетов находится в директории xsquare.xreports/templates/examples/

Техническая поддержка

Для получения технической поддержки по серверу отчетов обращайтесь на support@xsquare.ru и в модуль поддержки Личного Кабинета XSQUARE

Ресурсы приложения
Тип ресурсаКоличество
Сервисный аккаунт1
Диск1
Виртуальная машина1
Пользователь каталога1
Лицензионное соглашение
Используя данный продукт, вы соглашаетесь с Условиями использования Yandex Cloud Marketplace и с условиями использования следующих продуктов: Лицензионное соглашение с конечным пользователем
Тип тарификации
Free
Тип
Cloud Apps
Категория
Базы данных
Инструменты для разработчиков
В реестре российского ПО
Издатель
ООО "ХИ-КВАДРАТ"