Штрих-М: Документация

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Внешние отложенные чеки ======
В "Кассир 5" предусмотрен механизм работы с отложенными чеками, хранящимися во внешних базах данных. Это позволяет продолжить отложенный чек на другой кассе и для каких-либо других целей. В стандартной поставке имеется возможность хранения отложенных чеков в различных СУБД (dBase, MSSQL, MySQL), список которых можно дополнить пользовательскими без изменения конфигурации.


===== Функциональность =====
Данный класс модулей позволяет:
  * Подключаться к внешней СУБД.
  * Создавать [[кассир5:форматтаблицыотложенныхчеков:start|таблицу с предопределенной структурой]], для хранения отложенных чеков (необязательно, таблицу можно создать внешними средствами).
  * Выполнять манипуляции с данными (запись, выборка, удаление).
  * Выполнять поиск данных и навигацию по данным.

===== Интеграция =====
Для интеграции пользовательского модуля для работы с внешними отложенными чеками в систему необходимо выполнить ряд требований:
  * модуль должен быть внешней обработкой, код которой не приводит к ошибкам в контексте конфигурации "Кассир 5"
  * синоним внешней обработки определяет имя в списке модулей для работы с внешними отложенными чеками в настройках программы "Кассир 5".
  * внешняя обработка помещается в ExtFiles\ExternalDB каталога базы данных.
  * основная форма обработки реализует API внешних отложенных чеков.
  * основная форма должна иметь все реквизиты, соответсвующие [[кассир5:форматтаблицыотложенныхчеков:start|определенной структуре таблицы отложенных чеков]].

===== API внешних отложенных чеков =====
Основная форма обработки экспортирует следующие функции:
<code>
Функция Инициализация(СтрокаНастроек) Экспорт
Функция Деинициализация() Экспорт
Функция Настройка(СтрокаНастроек) Экспорт
Функция ОткрытьФайл() Экспорт
Функция БДОткрыта() Экспорт
Функция ПолучитьКодПоследнейЗаписи() Экспорт
Функция ПолучитьСписокОтложенныхЧеков(Знач Номер) Экспорт
Функция НайтиПоКоду(Знач Код) Экспорт
Функция ЗакрытьФайл() Экспорт
Функция ВКонце() Экспорт
Функция ПометитьНаУдаление() Экспорт
Функция УдалитьПомеченныеЗаписи() Экспорт
Функция СледующаяЗапись() Экспорт
</code>

**Все вышеперечисленные экспортируемые функции являются обязательными**\\

==== Функция Инициализация ====
Функция  Вызывается для инициализации объекта, реализующего взаимодействие с внешней СУБД, и подключения к СУБД.\\
Параметры:\\
 **СтрокаНастроек** (строка) -- Строка содержащая настройки подключения к СУБД, которая была сохранена в базе данных при вызове экспортной
функции //Настройка()//.\\
**Возвращаемое значение** (булево) -- При успешном подключении к СУБД возвращает Истину, иначе Ложь.\\

==== Функция Деинициализация ====
Функция выполняет закрытие открытых соединений с внешними БД.\\

==== Функция Настройка ====
Функция вызов производится при [[кассир5:настройка:дополнительные:параметрыотложенныхчеков|настройке внешних отложенных чеков]].\\
Параметры:\\
**СтрокаНастроек** (строка) -- Строка содержащая настройки подключения к внешней БД. Обработка представляет свои настройки в виде строки, которая сохраняется кассовым ПО в базе данных после вызова процедуры. Параметром передаётся сохраненное ранее значение или пустая строка.\\

==== Функция ОткрытьФайл ====
Функция открывает (динамически) таблицу отложенных чеков.\\
**Возвращаемое значение** (булево) -- При успешном открытии таблицы возвращает Истину, иначе Ложь.\\

==== Функция БДОткрыта ====
Функция проверяет открыта ли таблица отложенных чеков.\\
**Возвращаемое значение** (булево) -- Если таблица открыта, то возвращает Истину, иначе Ложь.\\

==== Функция ПолучитьКодПоследнейЗаписи ====
Функция возвращает максимальное значение поля //CODE//.\\
**Возвращаемое значение** (число) -- Возвращает максимальное значение поля //CODE// в таблице, если записи отсутствуеют, возвращает 0.\\

==== Функция Добавить ====
Функция добавляет и записывает новую запись в БД, поля новой записи заполняются из одноименных реквизитов формы.\\
**Возвращаемое значение** (булево) -- Если запись успешна добавлена, то возвразает Истину, иначе Ложь.\\

==== Функция ПолучитьСписокОтложенныхЧеков ====
Функция возвращает список отложенных чеков. Список составляется из записей с полем **FLAG = 9**\\
Значение элемента списка значений заполняется полем **CODE**, представление заполняется значением поля **NAIM**.
Параметры:\\
**Номер** (число) -- Если параметр равен "неопределено", тогда в список значений добавляются все строки с флагом = 9, иначе в список добавляется только запись с флагом = 9 и значением поля //NOM// равным данному параметру.\\
**Возвращаемое значение** (СписокЗначений) -- Список значений отженных чеков, если отложенные чеки не найдены, возвращает пустой список значений.\\

==== Функция НайтиПоКоду ====
Функция выполняет поиск записи с заданным значением в поле //CODE// и заполняет реквизиты формы одноименными полями найденной записи.\\
Параметры:\\
**Код** (число) -- значение, по которому необходимо найти запись с таким же значение в поле //CODE//.\\
**Возвращаемое значение** (булево) -- Если запись найдена, то возвразает Истину, иначе Ложь.\\

==== Функция ЗакрытьФайл ====
Функция закрывает открытую таблицу отложенных чеков и открытое соединение.\\
**Возвращаемое значение** (булево) -- Истина;\\

==== Функция ВКонце ====
Функция определяет достигнут ли конец набора записей таблицы отложенных чеков.\\
**Возвращаемое значение** (булево) -- Если курсор находится в конце набора записей, то возвращается Истина, иначе Ложь;\\

==== Функция ПометитьНаУдаление ====
Функция устанавливает пометку удаления на текущую запись, помеченные записи удаляются экспортной функцией //УдалитьПомеченныеЗаписи()//.\\
**Возвращаемое значение** (булево) -- Если запись успешно помечена на удаление, то возвращается Истина, иначе Ложь;\\

==== Функция УдалитьПомеченныеЗаписи ====
Функция удаляет записи, помеченные на удаление функцией //ПометитьНаУдаление()//, из БД.\\
**Возвращаемое значение** (булево) -- Если записи успешно удалены, то возвращается Истина, иначе Ложь;\\

==== Функция СледующаяЗапись ====
Функция считывает следующую запись таблицы отложенных чеков, заполняет реквизиты формы значениями одноименных полей считанной записи.\\
**Возвращаемое значение** (булево) -- Если следующая запись успешно прочитана и курсор не находится в конце набора данных, то возвращается Истина, иначе Ложь;\\
Штрих-М: Документация

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

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

Инструменты страницы
