XSQUARE – REPORTS

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

1. В консоли управления выберите каталог, в котором хотите развернуть приложение.

2. Создайте облачную сеть и подсеть, в которой будет находиться виртуальная машина (ВМ).

3. Получите пару SSH-ключей для подключения к ВМ.

4. Перейдите в сервис Cloud Apps.

5. На панели слева выберите Магазин приложений.

6. Выберите XSQUARE — REPORTS и нажмите кнопку Использовать.

7. На открывшейся странице:

   1. Укажите имя приложения и (опционально) описание.
   2. Выберите сервисный аккаунт из списка или нажмите Автоматически, чтобы сервисный аккаунт со всеми необходимыми правами создался автоматически во время установки приложения. От имени этого сервисного аккаунта будут создаваться ресурсы приложения. Он должен иметь как минимум следующие роли:
      • resource-manager.admin
      • compute.editor
      • iam.editor
      • vpc.publicAdmin
   3. Выберите облачную сеть и подсеть, созданные ранее.
   4. Укажите логин пользователя ВМ.
   5. Укажите публичный SSH-ключ пользователя для подключения к ВМ.
   6. Задайте размер пользовательского диска для хранения шаблонов в диапазоне от 10 ГБ до 100 ГБ.

8. Нажмите кнопку Установить и дождитесь, пока приложение установится.

9. Подключитесь к ВМ по SSH:

    ```bash
    ssh <логин_пользователя_ВМ>@<публичный_IP-адрес_ВМ>
    ```
   

10. Чтобы использовать собственные шаблоны:

    1. Создайте директорию для шаблонов на диске /data (например, /data/mytemplates/templates/):

       sudo mkdir -p /data/mytemplates/templates/
       

    2. Скопируйте ваши шаблоны в созданную директорию. Шаблоны должны находиться в поддиректории templates/:

       sudo cp -r /путь/к/вашим/шаблонам/* /data/mytemplates/templates/
       

    3. Отредактируйте файл конфигурации сервиса /usr/local/xsquare.xreports/config.json. В объекте "app" добавьте или измените параметр "data-directory", указав путь к директории с шаблонами без суффикса /templates. Подробнее читайте в документации.

    4. Перезагрузите сервис для применения изменений:

       sudo systemctl restart xsquare.xreports
       

Вызов сервиса для генерации 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/.

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

Yandex Cloud
Yandex Cloud не предоставляет техническую поддержку продукта. При возникновении проблем обращайтесь к информационным ресурсам разработчика.