.. _примеры:

=========
Примеры
=========

Архив примеров
----------------

В данном разделе можно ознакомиться с примерами запросов и шаблонов для сервиса.

:download:`Архив примеров <files/examples.zip>` необходимо распаковать в директорию **templates** в корне сервиса. Распакованный архив содержит следующие каталоги:

* ``pdf`` - содержит PDF - шаблоны страниц, используемых в :ref:`генераторе отчетов PDF <генератор отчетов PDF>`
* ``examples`` - содержит каталоги code, docx, pdf, xlsx

Каталог **code** содержит примеры для генерации QR-кодов.

Каталоги **docx, xlsx** содержат набор запросов (в форматах json/xml), документов - шаблонов (.docx и .xlsx) и скриптов (.sh) для получения отчетов.

Каталог **pdf** содержит следующие каталоги:

* ``embedded-report-generator`` -запросы (.json) и скрипты (.sh) для формирования отчетов в формате .pdf  через :ref:`Генератор отчетов PDF <генератор отчетов PDF>`.
* ``pdf_merge`` -запросы (.json) и скрипты (.sh) для :ref:`объединения PDF-документов <Объединение PDF-документов>`.
* ``print_form`` -запросы (.json) и скрипты (.sh) для :ref:`формирования печатной формы <Формирование печатной формы>`.
* ``report-generator`` -запросы (.json) и скрипты (.sh) для формирования отчетов через :ref:`Генератор отчетов PDF <генератор отчетов PDF>` с примером :ref:`генератора как часть сервиса <Генератор как часть сервиса>`. Каталог ``pdf_report_gen`` с примерами генераторов необходимо разместить в корневом каталоге сервиса.
* ``fill-form`` -запросы (.json) и скрипты (.sh) для :ref:`заполнения PDF-форм <сервис заполнения форм>`

Формирование отчета из архива примеров
----------------------------------------

Рассмотрим генерацию отчета из каталога docx на основе запроса lists.json

::
	
    {
      "template": {
        "uri": "local",
        "id": "examples/docx/lists"
      },
      "input-data": {
        "CONDITIONAL_TAG_TRUE": "true",
        "CONDITIONAL_TAG_FALSE": "false",
        "BULLET_LIST": [
          "bullet item 1",
          "bullet item 2",
          "bullet item 3"
        ],
        "NUMBERED_LIST": [
          "numbered item 1",
          "numbered item 2",
          "numbered item 3"
        ],
        "EMPTY_BULLET_LIST": [
        ],
        "EMPTY_NUMBERED_LIST": [
        ]
      },
      "options": {
        "enable-debug-report-save": false,
        "output-mode": "binary",
        "formatting": {
          "tables": {
            "enable-cells-auto-merge": true
          }
        }
      }
    }

В результате запуска скрипта lists.sh

::
	
	curl --request POST --data-binary "@lists.json" http://localhost:8886/word_report_json --output "lists_report.docx"

в каталоге templates/examples/docx был записан файл отчета lists_report.docx

.. note:: скриптам может понадобиться назначить права на исполнение. Это можно сделать следующей командой: chmod +x *.sh