.. _примеры:

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

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

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

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

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

::
	
	├───docx
	├───pdf
	│   ├───embedded-report-generator
	│   ├───pdf_merge
	│   ├───print_form
	│   └───report-generator
	│       └───pdf_report_gen
	└───xlsx

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

.. image:: /_static/images/docx.jpg
	:width: 200


Каталог **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`` с примерами генераторов необходимо разместить в корневом каталоге сервиса.

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

Рассмотрим генерацию отчета из каталога 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,
	      "enable-binary-output": true,
	        "formatting":
	        {
	            "tables":
	            {
	                "enable-cells-auto-merge": true
	            }
	        }
	    }
	}

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

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

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

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