XSQUARE – REPORTS

XSQUARE — REPORTS is a web service for reports in various formats. XSQUARE — REPORTS receives HTTP requests in XML or JSON and uses template documents to generate reports.

1. In the management console, select the folder where you want to deploy the application.

2. Create a cloud network and a subnet to host the virtual machine (VM).

3. Get an SSH key pair for connection to the VM.

4. Go to Cloud Apps.

5. In the left-hand panel, select Marketplace.

6. Select XSQUARE — REPORTS and click Use.

7. On the page that opens:

   1. Specify the application name and (optionally) description.
   2. Select a service account from the list or click Automatically to create a service account with all required permissions automatically during the installation of the app. This service account will be used to create the application resources. It needs at least the following roles:
      • resource-manager.admin
      • compute.editor
      • iam.editor
      • vpc.publicAdmin
   3. Select the cloud network and subnet you created earlier.
   4. Enter a VM user login.
   5. Specify the user’s public SSH key for connection to the VM.
   6. Specify the size of the user disk for templates in the range from 10 to 100 GB.

8. Click Install and wait for the installation to complete.

9. Connect to the VM over SSH:

    ```bash
    ssh <VM_user_login>@<VM_public_IP_address>
    ```
   

10. To use you own templates:

    1. Create a directory for templates on the /data disk, e.g., /data/mytemplates/templates/:

       sudo mkdir -p /data/mytemplates/templates/
       

    2. Copy your templates to the new directory. The templates must reside in the templates/ subdirectory.

       sudo cp -r /path/to/your/templates/* /data/mytemplates/templates/
       

    3. Edit the XSQUARE — REPORTS configuration file, /usr/local/xsquare.xreports/config.json. In the "app" object, add or update the "data-directory" property by specifying the template directory path without the /templates suffix. For more information, see this guide.

    4. Restart the service for the changes to take effect:

       sudo systemctl restart xsquare.xreports
       

Calling the service to generate a DOCX document:

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": "Example LLC",
            "DATE": "01.01.2023",
            "EMP": "John Richard Doe"
          },
        "options":
          {
            "output-mode": "binary"
          }
      }' \
  --output "my_first_report.docx"

For more report generation test use cases, see the xsquare.xreports/templates/examples/ directory on the VM.

XSQUARE
To get support, contact support@xsquare.ru or your XSQUARE Profile support module.

Yandex Cloud
Yandex Cloud does not provide support for this product. If you have any issues, please refer to the vendor’s information resources.