Различия

Показаны различия между двумя версиями страницы.

--- кассир5:внешниемодули:reports [2013/10/31 08:25] – [Предназначение] versus
+++ кассир5:внешниемодули:reports [2024/04/04 17:34] (текущий) – [Расширенные отчеты] maimakarov
@@ Строка 1: / Строка 1: @@
 ====== Расширенные отчеты ======
-Для получения отчётов по базе данных "Штрих-М: Кассир 5" предусмотрен механизм формирования расширенных отчетов. В стандартной поставке имеются [[кассир5:руководствопользователя:супервизор:расширенныеотчёты|расширенные отчёты]], список которых можно дополнить пользовательскими без изменения конфигурации.
+Для получения отчётов по базе данных "Кассир 5" предусмотрен механизм формирования расширенных отчетов. В стандартной поставке имеются [[кассир5:руководствопользователя:супервизор:расширенныеотчёты|расширенные отчёты]], список которых можно дополнить пользовательскими без изменения конфигурации.
@@ Строка 16: / Строка 16: @@
 Основное назначение данного способа формирования отчёта -- регулярное формирование или предоставление данных отчёта (как правило за текущую кассовую смену) вместе с Z-отчётом. Формирование отчёта производится непосредственно перед снятем Z-отчёта в ККМ.
-===== Минимальный программный интерфейс =====
+===== Интеграция =====
-Расширенный отчет это внешняя обработка, которая должна располагаться в каталоге "путь к базе"\ExtFiles\Reports. Синоним обработки является представлением отчета в меню Расширенные отчеты.\\
+Для интеграции пользовательского расширенного отчёта в систему необходимо выполнить ряд требований:
-Обработка обязательно должна иметь основную форму, в которой должны располагаться основные экспортные функции, со строго определенными именами:\\
+  * отчёт должен быть внешней обработкой, код которой не приводит к ошибкам в контексте конфигурации "Кассир 5"
-Функция **ПолучитьВерсиюПротокола** (обязательная)\\
+  * синоним внешней обработки определяет имя расширенного отчёта в списке отчётов
-Процедура **ВывестиОтчет**\\
+  * внешняя обработка помещается в ExtFiles\Reports каталога базы данных
-Процедура **НастройкаОтчета**\\
+  * основная форма обработки реализует API расширенных отчётов.
-Процедура **НастройкаПечатиПриZОтчете**\\
-Функция **СформироватьОтчетПриСнятииZОтчета**\\
-Наличие функции ПолучитьВерсиюПротокола обязательно, в ней определяется возможности расширенного отчета, от которых зависит наличие остальных экспортных функций.
-===== Вызов экспортных функций =====
+===== API расширенных отчётов =====
-**Получить версию протокола** - служебная функция, вызывается для проверки функциональных возможностей расширенного отчета: в форме настройки расширенных отчетов и в супервизоре при нажатии кнопки "Расширенные отчеты".\\
+Основная форма обработки экспортирует следующие функции:
-**ВывестиОтчет** - вызывается при нажатии кнопки в меню "Расширенные отчеты".\\
+<code>
-**НастройкаОтчета** - вызывается при нажатии кнопки настройки отчета в форме "Настройка расширенных отчетов".\\
+Функция ПолучитьВерсиюПротокола(СтруктураФункций) Экспорт
-**НастройкаПечатиПриZОтчете** - вызывается при нажатии кнопки настройки печати при снятии Z отчета в форме "Настройка расширенных отчетов".\\
+Процедура ВывестиОтчет(Знач СтрокаНастроек, Знач ККМДляПечати) Экспорт
-**СформироватьОтчетПриСнятииZОтчета** - вызывается при снятии Z отчета (если для отчета установлена настройка "Печатать при Z отчете").\\
+Процедура НастройкаОтчета(СтрокаНастроек) Экспорт
+Процедура НастройкаПечатиПриZОтчете(СтрокаНастроек) Экспорт
+Процедура СформироватьОтчетПриСнятииZОтчета(Знач СтрокаНастроек, Знач ККМДляПечати) Экспорт
+</code>
-===== Параметры экспортных функций =====
+==== Функция ПолучитьВерсиюПротокола ====
-Функция **ПолучитьВерсиюПротокола(СтруктураФункций)**\\
+Функция является обязательной к экспорту. Вызывается для проверки функциональных возможностей расширенного отчета.\\
-**СтруктураФункций** - Структура - содержит набор строго определенных ключей. Данную структуру можно получить функцией глобального общего модуля - **ПолучитьСтруктуруФункцийОтчета()**\\
+Параметр **СтруктураФункций**.\\
+Тип -- Структура. Имеет следующие свойства, определяющие наличие одноименных экспортных функций модуля:\\
+ ВывестиОтчет (булево)\\
+ НастройкаОтчета (булево)\\
+ НастройкаПечатиПриZОтчете (булево)\\
+ ПечататьПриZОтчете (булево)\\
+Изменяя значения свойств передаваемой структуры, обработка сообщит кассовому ПО о поддержке функционала.\\
+**Возвращаемое значение** (число) -- 1.
-Процедура **ВывестиОтчет(СтрокаНастроек, лККМДляПечати)**\\
-**СтрокаНастроек** - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр(). Берётся из сохраненных настроек, установленных процедурой НастройкаОтчета().\\
-**лККМДляПечати** - СтрокаТаблицыЗначений - ККМ для печати. Можно получить функцией Кассир5_DataAccess.ПолучитьККМ()\\
-Процедура **НастройкаОтчета(СтрокаНастроек)**\\
+==== Функция ВывестиОтчет ====
-**СтрокаНастроек** - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр().\\
+Процедура является обязательной к экспорту, если параметр **ВывестиОтчет** (структуры СтруктураФункций) был установлен в значение Истина.\\
+Вызов процедуры производится при интерактивном формировании отчёта.\\
+Параметры:\\
+**СтрокаНастроек** (строка) -- Строка сожержащая настройки отчёта, которая была сохранена в базе данных при вызове процедуры НастройкаОтчета().\\
+**ККМДляПечати** -- Строка таблицы значений **СписокККМ**. Определяет ККМ на котором будет распечатан отчёт в случае его печати на ККМ.\\
-Процедура **НастройкаПечатиПриZОтчете(СтрокаНастроек)**\\
+==== Функция НастройкаОтчета ====
-**СтрокаНастроек** - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр().\\
+Процедура является обязательной к экспорту, если параметр **НастройкаОтчета** (структуры СтруктураФункций) был установлен в значение Истина.\\
+Вызов процедуры производится при [[кассир5:настройка:дополнительные:настройкарасширенныхотчетов|настройке расширенного отчёта]].\\
+Параметры:\\
+**СтрокаНастроек** (строка) -- Строка содержащая настройки отчёта. Обработка представляет свои настройки в виде строки, которая сохраняется кассовым ПО в базе данных после вызова процедуры. Параметром передаётся сохраненное ранее значение или пустая строка.\\
-Функция **СформироватьОтчетПриСнятииZОтчета(СтрокаНастроек, лККМДляПечати)**\\
+==== Функция НастройкаПечатиПриZОтчете ====
-**СтрокаНастроек** - Строка - значение типа Соответствие, преобразованное в строку функцией ЗначениеВСтрокуВнутр(). Берётся из сохраненных настроек, установленных процедурой НастройкаПечатиПриZОтчете().\\
+Процедура является обязательной к экспорту, если параметр **НастройкаПечатиПриZОтчете** (структуры СтруктураФункций) был установлен в значение Истина.\\
-**лККМДляПечати** - СтрокаТаблицыЗначений - ККМ для печати. Можно получить функцией Кассир5_DataAccess.
+Вызов процедуры производится при [[кассир5:настройка:дополнительные:настройкарасширенныхотчетов|настройке расширенного отчёта]].\\
+Параметры:\\
+**СтрокаНастроек** (строка) -- Строка сожержащая настройки отчёта. Обработка представляет свои настройки в виде строки, которая сохраняется кассовым ПО в базе данных после вызова процедуры. Парметром передаеётся сохраненное ранее значение или пустая строка.\\
-===== Описание функций =====
+==== Функция СформироватьОтчетПриСнятииZОтчета ====
-Функция **ПолучитьВерсиюПротокола(СтруктураФункций)**\\
+Процедура является обязательной к экспорту, если параметр **СформироватьОтчетПриСнятииZОтчета** (структуры СтруктураФункций) был установлен в значение Истина.\\
-В данную функцию передаётся структура с элементами, определяющими функциональные возможности отчета. По умолчанию значения всех элементов структуры установлен в ложь. Ниже перечислены доступные ключи структуры и их описание.
+Вызов процедуры производится перед снятием Z-отчёта в ККМ.\\
-    * **ВывестиОтчет** - если значение данного элемента структуры установить в истину, то отчет будет отображаться в меню "Расширенные отчеты".
+Параметры:\\
-    * **НастройкаОтчета** - если значение данного элемента структуры установить в истину, то для отчета можно установить настройки в форме настроек расширенных отчетов, иначе кнопка для настройки будет недоступна.
+**СтрокаНастроек** (строка) -- Строка сожержащая настройки отчёта, которая была сохранена в базе данных при вызове процедуры НастройкаПечатиПриZОтчете.\\
-    * **НастройкаПечатиПриZОтчете** - если значение данного элемента структуры установить в истину, то для отчета можно установить настройки при печати Z отчета в форме настроек расширенных отчетов, иначе кнопка для настройки будет недоступна.
+**ККМДляПечати** -- Строка таблицы значений **СписокККМ**. Определяет ККМ на котором будет распечатан отчёт в случае его печати на ККМ.\\
-    * **ПечататьПриZОтчете** - если значение данного элемента структуры установить в истину, то отчет будет иметь возможность формироваться при снятии Z отчета.
-Функция должна возвращать число, отличное от нуля.
-Процедура **ВывестиОтчет(СтрокаНастроек, лККМДляПечати)**\\
-Данная процедура предназначена для интерактивного формирования отчета. Могут использоваться хранимые в базе данных настройки, заданные в форме настроек расширенных отчетов.
-Процедура **НастройкаОтчета(СтрокаНастроек)**\\
-Данная процедура предназначена для установки настроек, используемых при интерактивном формировании отчета. Процедура должна открывать форму с настройками. При закрытии формы с настройками заданные параметры должны быть записаны в соответствие и возвращены во входящий параметр СтрокаНастроек в виде строки, сформированной функцией ЗначениеВСтрокуВнутр().
-Процедура **НастройкаПечатиПриZОтчете(СтрокаНастроек)**\\
-Данная процедура предназначена для установки настроек, используемых при формировании отчета при снятии Z отчета. Процедура должна открывать форму с настройками. При закрытии формы с настройками заданные параметры должны быть записаны в соответствие и возвращены во входящий параметр СтрокаНастроек в виде строки, сформированной функцией ЗначениеВСтрокуВнутр().
-Функция **СформироватьОтчетПриСнятииZОтчета(СтрокаНастроек, лККМДляПечати)**\\
-Данная процедура предназначена для формирования отчета при снятии Z отчета. Могут использоваться хранимые в базе данных настройки, заданные в форме настроек расширенных отчетов.
-Функция должна возвращать значение "Истина".