ExportToPdfCommand

Команда; генерирует PDF-файл на основе шаблона формата DOC или DOCX, в котором вместо переменных подставляются определенные значения.

Поддерживаемые переменные

<#variable#>

Служит для отображения скалярного значения.

<%variable%>

Служит для отображения массива (для использования в таблице).

<~variable~>

Служит для полного переноса содержимого другого документа (подшаблона) в шаблон.

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

В качестве значения переменной должен передаваться либо полный путь до вставляемого файла, либо относительный к текущей форме.

Выражение может быть дополнено параметрами: <~variable[?pageBreakBefore][?pageBreakAfter]~>, где:

• pageBreakBefore - вставить символ переноса на новую страницу перед текстом подшаблона;

• pageBreakAfter - вставить символ переноса на новую страницу после текста подшаблона.

<@PATH@>

Служит для вставки изображения.

Например, для вставки изображения с параметризованным путем следует указать выражения вида <@<#variable#>@> - для скалярных значений и <@<%variable%>@> - для массивов.

Выражение PATH имеет следующий формат: PATH[?width=INT][?height=INT][?mode=MODE], где:

• PATH - полный путь до файла изображения;

• width - необязательный параметр ширины изображения; в качестве значения INT ожидается положительное целочисленное значение;

• height - необязательный параметр высоты изображения; в качестве значения INT ожидается положительное целочисленное значение;

• mode - необязательный параметр типа размера; в качестве значения MODE ожидается тип размера изображения (по умолчанию "Zoom").

Типы размера изображения

Zoom	Растягивание изображения до указанной ширины и высоты (в большую или меньшую сторону), сохраняя пропорции изображения
ZoomLess	Растягивание изображения до указанной ширины и высоты (только в меньшую сторону), сохраняя пропорции изображения
Stretch	Растягивание изображения до указанной ширины и высоты без сохранения пропорций изображения

Шаблон ExportToPdfCommand

<Command Name="" Type="ExportToPdfCommand">
  <!--Тэги, общие для всех команд-->
  <Condition Name="" />
  <!--Тэги, специфичные для ExportToDocxCommand-->  
  <ExportBy Type="">
    <LibreOfficePathSqlQuery>
      <Text></Text>
    </LibreOfficePathSqlQuery>
  </ExportBy>
  <TemplateFileNamesSqlQuery>
    <Text></Text>
  </TemplateFileNamesSqlQuery>
  <ExportFileNamesSqlQuery>
    <Text></Text>
  </ExportFileNamesSqlQuery>
  <Parameters>
    <ParameterSqlQuery>
      <Text></Text>
    </ParameterSqlQuery>
  </Parameters>
  <GroupTags SingleFile="False" Parameter="">
    <GroupSqlQuery>
      <Text></Text>
    </GroupSqlQuery>
  </GroupTags>
</Command>

Описание ExportToPdfCommand

<Command Name="ExportToPdfCommandName" Type="ExportToPdfCommand" Assembly="Commands">
  <!--Тэги, общие для всех команд-->
  <!--Тэги, специфичные для ExportToPdfCommand-->
</Command>

Результат выполнения ExportToPdfCommand

Value

Полный путь с названием файла, который будет сгенерирован из указанного шаблона с подстановкой данных.

Тэги, специфичные для ExportToPdfCommand

ExportBy

Признак определяющий способ формирования pdf-файла.

Необязательный тэг. Для обязательного атрибута Type ожидается одно из доступных значений:

OpenXml	Для экспорта данных в pdf-файл используется библиотека, не привязанная к приложениям Microsoft Office или Libre Office.
LibreOffice	Для экспорта данных в pdf-файл используется приложение LibreOffice, которое должно быть установлено на сервере.

По умолчанию используется значение OpenXml.

<ExportBy Type="">
  <LibreOfficePathSqlQuery>
    <Text>SQL-query</Text>
  </LibreOfficePathSqlQuery>
</ExportBy>

LibreOfficePathSqlQuery

Sql-запрос, возвращающий путь до файла soffice.exe, установленного экземпляра приложения Libre Office. Учитывается если выбран способ LibreOffice.

Необязательный тэг. Любое значение будет переведено в текстовое.

TemplateFileNameSqlQuery

Sql-запрос, возвращающий список путей DOCX-файлов шаблонов, хранящихся на сервере.

Обязательный тэг. Любое значение будет переведено в текстовое.

<TemplateFileNameSqlQuery>
  <Text>SQL-query</Text>
</TemplateFileNameSqlQuery>

ExportFileNameSqlQuery

Sql-запрос, возвращающий список полных путей до DOCX-файлов, в которые будут выгружены данные.

Обязательный тэг. Любое значение будет переведено в текстовое.

<ExportFileNameSqlQuery>
  <Text>SQL-query</Text>
</ExportFileNameSqlQuery>

Parameters

Необязательный тэг. Ожидает список тэгов <ParameterSqlQuery>.

<Parameters>
  <ParameterSqlQuery>
    <Text>SQL-query</Text>
  </ParameterSqlQuery>
</Parameters>

ParameterSqlQuery

Sql-запрос, возвращающий данные, которые будут переданы в файл шаблона для замены.

Необязательный тэг. Содержит обязательный тэг <Text>, ожидающий текст SQL-запроса.

Разделение данных на несколько тэгов <ParameterSqlQuery> позволяет избежать построение громоздких SQL-забросов, а так же отделить скалярные данные от табличных.

Пример

В примере в первом запросе возвращаются скалярные данные заказа, а во втором - таблица позиций заказа:

<Parameters>
  <ParameterSqlQuery>
    <Text>
    	SELECT
		    O.order_number AS "OrderNumber",
	  	  O.order_date AS "OrderDate"
	  	FROM
		    template.order O
		  WHERE
    		O.order_id = {OrderId};
    </Text>
  </ParameterSqlQuery>
  <ParameterSqlQuery>
    <Text>
	    SELECT
	      M.title AS "OrderPositionTitle",
	      OP.quantity AS "OrderPositionQuantity",
	      OP.unit_price AS "OrderPositionUnitPrice",
	      OP.quantity * OP.unit_price AS "OrderPositionTotalPrice"
    	FROM
    	  template.order_position OP
    	  LEFT JOIN template.material M USING(material_id)
		  WHERE
    		OP.order_id = {OrderId}
    	ORDER BY OP.order_position_id;
    </Text>
  </ParameterSqlQuery>
</Parameters>

GroupTags

Задает имя поля и наборы данных для группировки по разным файлам.

Необязательный тэг. Ожидается список тэгов <GroupSqlQuery>.

Если тэг <GroupTags> отсутствует, то экспорт происходит только в 1 файл.

<GroupTags SingleFile="True" Parameter="">
  <GroupSqlQuery>
    <Text>SQL-query</Text>
  </GroupSqlQuery>
</GroupTags>

SingleFile

Признак, определяющий, будут ли данные группироваться в один файл, или для каждой группы будет создаваться отдельный файл.

Необязательный атрибут. Ожидается логическое значение.

По умолчанию используется значение False.

Parameter

Атрибут задает имя параметра, по которому будет происходить группировка данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

GroupSqlQuery

Sql-запрос, возвращающий данные для группировки. Одно из полей должно совпадать с именем параметра для группировки, указанном в атрибуте Parameter.

Необязательный тэг. Содержит обязательный тэг <Text>, ожидающий текст SQL-запроса.

Разделение данных на несколько тэгов <GroupSqlQuery> позволяет избежать построение громоздких SQL-забросов, а так же отделить скалярные данные от табличных.

Пример

В примере в первом запросе возвращаются скалярные данные клиентов, а во втором - таблица телефонных номеров для каждого клиента:

<GroupTags SingleFile="True" Parameter="ClientId">
  <GroupSqlQuery>
    <Text>
	    SELECT
	      client.client_id AS "ClientId",
	      client.title AS "ClientName",
	      city.title AS "ClientCity",
	      client.email AS "ClientEmail"
	    FROM
	      template.client;
    </Text>
  </GroupSqlQuery>
  <GroupSqlQuery>
    <Text>
	    SELECT
	      client.client_id AS "ClientId",
	      client.phone AS "ClientPhone"
	    FROM
	      template.client_phone;
    </Text>
  </GroupSqlQuery>
</GroupTags>