XSQUARE – REPORTS

XSQUARE — REPORTS is an independent web service designed to generate reports in various formats from template documents using HTTP requests in XML or JSON formats based on data requests and document templates in various formats.

1. In the control console, select the directory where you want to deploy the application.
2. Select the Cloud Apps service.
3. In the left panel, select the App Store.
4. Select SQUARE — REPORTS and click the Use button.
5. Specify:
   • Application name.
   • (Optional) Application description.
   • Service account for the directory, or select Automatically to create the service account when the app is installed. This service account will be used to create app resources. The service account should have the following minimum roles specified:
     • resource-manager.admin
     • compute.editor
     • iam.editor
     • vpc.publicAdmin
   • Network.
   • Subnetwork.
   • VM user login.
   • User public key for connecting to the VM.
   • The size of the user’s disk for storing templates.
6. Click the Install button and wait for the app to install.
7. After installation, follow these steps to use your own templates:
   1. Place the directory with your templates in /data
   2. Specify the path to the directory in the service configuration file in /usr/local/xsquare.xreports/config.json in the "app" object using the "data-directory" key (for more information see documentation)
   3. Restart service
      sudo systemctl restart xsquare.xreports

Example of calling a 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": "ООО «Пример»",
            "DATE": "01.01.2023",
            "EMP": "Иванов Иван Иванович"
          },
        "options":
          {
            "output-mode": "binary"
          }
      }' \
  --output "my_first_report.docx"

More examples for testing report generation can be found in the directory xsquare.xreports/templates/examples/

For technical support on the report server, please contact support@xsquare.ru and the support module of the XSQUARE Personal Account