Инструменты пользователя

Инструменты сайта


кассир5:внешниемодули:reports

Это старая версия документа!


Предназначение Мин. интерфейс. Осн. форма с экспортными функциями. Когда вызываются эти функции. Параметры экспортных функций. Описание функций.

Предназначение

Механизм расширенных отчетов позволяют отображать визуальные отчеты на различные устройства вывода, а также автоматически формировать такие отчеты при снятии Z отчета. Расширенный отчет может не иметь визуального отображения и иметь функциональное назначение, например, выполнять определенные операции с КММ и т.п.

Минимальный программный интерфейс

Расширенный отчет это внешняя обработка, которая должна располагаться в каталоге «путь к базе»\ExtFiles\Reports. Синоним обработки является представлением отчета в меню Расширенные отчеты.
Обработка обязательно должна иметь основную форму, в которой располагаются основные экспортные функции, со строго определенными именами:
Функция ПолучитьВерсиюПротокола (обязательная)
Процедура ВывестиОтчет
Процедура НастройкаОтчета
Процедура НастройкаПечатиПриZОтчете
Функция СформироватьОтчетПриСнятииZОтчета
Наличие функции ПолучитьВерсиюПротокола обязательно, в ней определяется возможности расширенного отчета, от которых зависит наличие остальных экспортных функций.

Вызов экспортных функций

Получить версию протокола - служебная функция, вызывается для проверки функциональных возможностей расширенного отчета: в форме настройки расширенных отчетов и в супервизоре при нажатии кнопки «Расширенные отчеты».
ВывестиОтчет - вызывается при нажатии кнопки в меню «Расширенные отчеты».
НастройкаОтчета - вызывается при нажатии кнопки настройки отчета в форме «Настройка расширенных отчетов».
НастройкаПечатиПриZОтчете - вызывается при нажатии кнопки настройки печати при снятии Z отчета в форме «Настройка расширенных отчетов».
СформироватьОтчетПриСнятииZОтчета - вызывается при снятии Z отчета (если для отчета установлена настройка «Печатать при Z отчете»).

Параметры экспортных функций

Функция ПолучитьВерсиюПротокола(ПолучитьВерсиюПротокола)
ПолучитьВерсиюПротокола - Структура - содержит набор строго определенных ключей:

  • ВывестиОтчет - если значение данного элемента структуры установить в истину, то отчет будет отображаться в меню «Расширенные отчеты».
  • НастройкаОтчета - если значение данного элемента структуры установить в истину, то для отчета можно установить настройки в форме настроек расширенных отчетов, иначе кнопка для настройки будет недоступна.
  • НастройкаПечатиПриZОтчете - если значение данного элемента структуры установить в истину, то для отчета можно установить настройки при печати Z отчета в форме настроек расширенных отчетов, иначе кнопка для настройки будет недоступна.
  • ПечататьПриZОтчете - если значение данного элемента структуры установить в истину, то отчет будет иметь возможность формироваться при снятии Z отчета.

Данную структуру можно получить функцией глобального общего модуля - ПолучитьСтруктуруФункцийОтчета()

Процедура ВывестиОтчет(СтрокаНастроек, лККМДляПечати)
СтрокаНастроек - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр(). Берётся из сохраненных настроек, установленных процедурой НастройкаОтчета().
лККМДляПечати - СтрокаТаблицыЗначений - ККМ для печати. Можно получить функцией Кассир5_DataAccess.ПолучитьККМ()

Процедура НастройкаОтчета(СтрокаНастроек)
СтрокаНастроек - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр().

Процедура НастройкаПечатиПриZОтчете(СтрокаНастроек)
СтрокаНастроек - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр().

Функция СформироватьОтчетПриСнятииZОтчета(СтрокаНастроек, лККМДляПечати)
СтрокаНастроек - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр(). Берётся из сохраненных настроек, установленных процедурой НастройкаПечатиПриZОтчете().
лККМДляПечати - СтрокаТаблицыЗначений - ККМ для печати. Можно получить функцией Кассир5_DataAccess.

Описание функций

кассир5/внешниемодули/reports.1383133098.txt.gz · Последнее изменение: 2013/10/30 11:38 — dzayonchkovskiy