Требования к разработке внешних обработок обслуживания торгового оборудования для платформы "1С:Предприятие 8.1"

Обновлено: 12.02.2009

В данном разделе содержится описание структуры внешних обработок обслуживания торгового оборудования, используемых в текущих конфигурациях системы "1С:Предприятие 8.1", в которых используется подключение торгового оборудования, и методика их создания. Также раздел содержит внешнюю обработку, которую можно использовать в качестве основы для создания обработок обслуживания конкретных экземпляров торгового оборудования.

ВАЖНО
Данная методика неприменима для более ранних редакций, разработанных для системы "1С:Предприятие 8.0"! 

Общие сведения
Общие требования
Процедуры и функции
    Общие
        Функция "ПолучитьВерсиюAPI"
        Функция "ПолучитьОписание"
        Функция "СоздатьОбъектДрайвера"
        Функция "ПолучитьОписаниеСобытий"
        Функция "Подключить"
        Функция "ТестУстройства"
        Функция "ПолучитьИмяИсточникаВнешнегоСобытия"
        Процедура "Отключить"
        Процедура "НастроитьОборудование"
    Дисплеи покупателя
        Функция "Очистить"
        Функция "Вывод"
        Функция "ВывестиСтрокиНаДисплейПокупателя"
    ККМ в режиме Offline
        Функция "ПолучитьПараметрыВыгрузки"
        Функция "ВыгрузитьТовары"
        Функция "ЗагрузитьОтчет"
        Функция "ОтчетЗагружен"
        Функция "ОчиститьТовар"
        Функция "ПрочитатьФлагЗагрузки"
    ККМ в режиме Online
        Функция "ОбработатьСобытие"
        Функция "ОбработатьРезультатЗапроса"
    Сканеры штрихкода
        Функция "ОбработатьСобытиеСШК"
        Процедура "СобытиеОбработано"
    Терминалы сбора данных
        Функция "НачатьВыгрузку"
        Функция "ВыгрузитьСтроку"
        Функция "ЗавершитьВыгрузку"
        Функция "НачатьЗагрузку"
        Функция "ЗагрузитьСтроку"
        Функция "ЗавершитьЗагрузку"
        Функция "ВыгрузитьТаблицу"
        Функция "ЗагрузитьТаблицу"
    Фискальные регистраторы
        Функция "ПолучитьПараметрыНаличнойОплаты"
        Функция "XОтчет"
        Функция "ZОтчет"
        Функция "Сумма"
        Функция "ОткрытьЧек"
        Функция "ПечататьСтроку"
        Функция "АннулироватьЧек"
        Функция "ОтменитьЧек"
        Функция "ЗакрытьЧек"
        Функция "НапечататьСтроки"
        Функция "ПоддерживаетсяСмешанныйРежимПечати"
    Электронные весы
        Функция "Тарирование"
        Функция "Вес" 
    Считыватели магнитных карт
        Функция "ОбработатьСобытиеСМК"
        Процедура "СобытиеОбработано"
    Электронные весы Offline
        Функция "НачатьВыгрузку"
        Функция "Выгрузить"
        Функция "ЗавершитьВыгрузку"
        Функция "ВыгрузитьТаблицу"
          Функция "ОчиститьТоварыВВесах"
    Считыватели RFID меток
        Функция "ПолучитьКоличествоМетокRFID"
        Функция "ПрочитатьДанныеИзМетокRFID"
        Функция "ЗаписатьДанныеВМеткиRFID"
        Функция "УстановитьРежимДрайвера"
        Функция "ОткрытьСессиюRFID"
        Функция "ЗакрытьСессиюRFID"
        Функция "ОбработатьСобытиеОтRFID"
        Процедура "СобытиеОбработано"
    Эквайринговые системы
        Функция "ОплатитьПлатежнойКартой"
        Функция "ВернутьПлатежПоПлатежнойКарте"
        Функция "ОтменитьПлатежПоПлатежнойКарте"
        Функция "ИтогиДняПоКартам"
        Функция "ПоддерживаетсяСверкаИтогов"
Шаблон обработки обслуживания

Общие сведения

Обработка обслуживания представляет обработку системы "1С:Предприятие", предназначенную для работы с торговым оборудованием. Основным предназначением обработок обслуживания является локализация изменений в конфигурации при необходимости добавления новых моделей торгового оборудования (модели оборудования, не поддерживаемые конфигурацией) или при необходимости модификации существующего кода, осуществляющего взаимодействие с торговым оборудованием. В более ранних редакциях типовых конфигураций в основном разработанные для "1С:Предприятие 8.0" обработки обслуживания были реализованы в виде форм обработки "Торговое оборудования". 

Общая схема взаимодействия с торговым оборудованием при помощи внешних обработок обслуживания приведена на рисунке. Конфигурация взаимодействует с обработками обслуживания посредством стандартизованного их интерфейса (API). Обработки обслуживания с помощью внешних компонент взаимодействуют с драйверами (или любым другим программным обеспечением) конкретного экземпляра подключенного торгового оборудования, таким образом, исполняя роль "посредника". В случае, когда возникает внешнее событие, конфигурация передаёт информацию о нём соответствующей обработке обслуживания, которая и обрабатывает это событие. Таким образом, для подключения новых моделей торгового оборудования нет более необходимости вносить изменения в саму конфигурацию. Настройка параметров работы устройств (порт, к которому подключено устройство, скорость передачи данных и т.д.) также выполняется средствами обработки обслуживания - каждая обработка обслуживания обязана иметь форму настройки параметров работы поддерживаемых ей моделей торгового оборудования (моделей оборудования, для которых эта обработка была создана).

ПРИМЕЧАНИЕ
Обработка обслуживания может поддерживать работу только с одной внешней компонентой торгового оборудования одного вида торгового оборудования (только фискальные регистраторы, только сканеры штрихкода и т.д.). В случае, если необходимо реализовать поддержку нескольких устройств разного вида или разных компонент одного вида, то для каждого из них необходимо будет создать собственную обработку обслуживания.

Общие требования

Настоящие требования определяют интерфейс взаимодействия ОО торгового оборудования с типовыми конфигурациями "1С:Предприятие 8". Интерфейс ОО можно условно разделить на две части. Первая часть - общая, определяет обязательный набор функций и методов входящий во все ОО. Вторая часть - функциональная, определяет обязательный набор функций и методов специфичный для каждого вида торгового оборудования. Также ОО может содержать дополнительные (вспомогательные) функции и/или методы, а также переменные, определяемые разработчиком обработки.

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

К модулю обработки обслуживания предъявляются следующие требования:

Экспортируемые процедуры и функции модуля обработки обслуживания

Процедуры и функции, общие для всех обработок обслуживания

Данные процедуры и функции являются обязательными для обработок обслуживания, поддерживающих версии API 2.ХХ, вне зависимости от вида поддерживаемого обработкой обслуживания торгового оборудования.

Функция "ПолучитьВерсиюAPI"

Данная функция предназначена для получения информации о номере версии интерфейса (API) обработок обслуживания, поддерживаемого данной обработкой. Текущая версия API - "2.4". Функция используется конфигурацией в момент загрузки обработки обслуживания в информационную базу.

ВАЖНО
Допускается изменение набора экспортируемых модулем обработки обслуживания процедур и функций (фактически, обязательной для всех обработок обслуживания является только эта функция), но с одним ограничением: конфигурация определяет состав экспортируемых процедур и функций по номеру версии API по следующему правилу - целая часть номера версии API определяет базовый набор процедур и функций, дробная часть - дополнения к базовому набору. Таким образом, в случае, если конфигурация поддерживает API версии X.0 она также будет работать со всеми обработками обслуживания с API версий X.YZ. 

Копировать в буфер обмена

    // Функция возвращает номер версии API, поддерживаемой обработкой обслуживания.
    //
    // Номер версии задаётся следующим образом: Ver = Vmajor + Vminor / 100.0.
    // Например, в случае, если данная функция возвращает значение "2.01", это   
    // означает, что данная обработка  имеет версию "2.1", полностью поддерживает
    // версию "2.0" и содержит некоторые дополнительные элементы.
    // В случае, если отличается целая часть версии (например, "1.1"), то это
    // означает, что данная обработка несовместима с версией API "2.1".
    //
    // Функция является обязательной для любой версии API.
    //
    // Параметры:
    //  Нет
    //
    // Возвращаемое значение:
    //  <Число> - Версия API обработки обслуживания.
    //

    Функция ПолучитьВерсиюAPI() Экспорт

Функция "ПолучитьОписание"

Данная функция предназначена для получения информации о параметрах обработки обслуживания таких, как: вид торгового оборудования, список моделей оборудования, поддерживаемых обработкой, наименование обработки обслуживания (для представления в пользовательском интерфейсе), аннотацию (описание), позволяющую пользователю понять, для чего предназначена данная обработка обслуживания, версию обработки и её идентификатор. Функция используется при загрузке обработки обслуживания в информационную базу.

ВАЖНО
Следует отличать номер версии API от номера версии обработки обслуживания. В то время, как версия API определяет версию интерфейса взаимодействия обработки обслуживания, версия обработки определяет реализацию этого интерфейса. Пояснить сказанное можно на следующем примере: в опубликованной обработке обслуживания была обнаружена ошибка, которая впоследствии была исправлена. Для публикации исправленной обработки необходимо изменить номер её версии. Номер версии API при этом не изменяется. Также следует пояснить роль идентификатора: идентификатор позволяет конфигурации отличать одну обработку обслуживания от другой. Идентификатор не зависит от номера версии обработки: две обработки обслуживания с одинаковыми идентификаторами но разными версиями считаются одной и той же обработкой обслуживания. В качестве идентификатора необходимо использовать текстовое представление глобального уникального идентификатора (GUID).  

Копировать в буфер обмена

    // Функция возвращает описание текущей обработки обслуживания
    // (API v2.0).
    //
    // Данная функция позволяет серверу получить информацию об обработке
    // обслуживания. Функция является обязательной для версий 2.X API.
    //
    // Параметры:
    //  Нет
    //
    // Возвращаемое значение:
    //  <Структура> - Структура, содержащая описание текущей обработки.
    //       Структура имеет следующие поля:
    //
    //                Вид              - <ПеречислениеСсылка.ВидыТорговогоОборудования>
    //                                 - Вид торгового оборудования, поддерживаемый   
    //                                   данной обработкой обслуживания.
    //
    //                СписокМоделей    - <Массив>
    //                                 - Список поддерживаемых обработкой моделей
    //                                   торгового оборудования.
    //
    //                Наименование     - <Строка>
    //                                 - Наименование обработки обслуживания.
    //
    //                Описание         - <Строка>
    //                                 - Описание обработки обслуживания.
    //
    //                ВерсияОбработки  - <Число>
    //                                 - Номер версии обработки обслуживания   
    //                                   (не версии API!!!).
    //                                   Данный параметр используется при
    //                                   обновлении.
    //                                   Номер версии задаётся следующим образом:
    //                                   Ver = Vmajor + Vminor / 100.0.
    //
    //                Идентификатор    - <Строка>
    //                                 - Строковое представление уникального
    //                                   идентификатора, соответствующего данной
    //                                   обработке обслуживания.
    //
    //

    Функция ПолучитьОписание() Экспорт

Функция "СоздатьОбъектДрайвера"

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

ВАЖНО
Следует отметить, что в обязанности данной функции не входит подключение оборудования, она создаёт лишь объект, необходимый для последующего с ним взаимодействия. Подключение оборудования осуществляется при помощи функции "Подключить"

Копировать в буфер обмена

    // Функция создаёт объект драйвера.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Выходной параметр; объект драйвера торгового
    //                                   оборудования.
    //
    //  Модель                         - <Строка>
    //                                 - Модель торгового оборудования, для которой
    //                                   создаётся экземпляр драйвера.
    //
    //  Параметры                      - <Строка>
    //                                 - Параметры подключаемого торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
   

    Функция СоздатьОбъектДрайвера(Объект, Модель, Параметры) Экспорт

Функция "ПолучитьОписаниеСобытий"

Данная функция возвращает таблицу имён внешних событий, которые может генерировать драйвер поддерживаемых обработкой обслуживания устройств. Функция используется в момент инициализации работы с оборудованием.

ВАЖНО
В том случае, если при работе с оборудованием не возникают внешние события, функция обязана вернуть пустую таблицу.

Копировать в буфер обмена

    // Функция возвращает набор событий драйвера и параметры их обработки для
    // заданной модели торгового оборудования.
    // (API v2.0)
    //
    // Параметры:
    //  Объект            - <*>
    //                    - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ТаблицаЗначений> - Таблица значений, содержащая информацию о внешних
    //                      событиях, генерируемых драйвером.
    //                      Таблица имеет следующие колонки:
    //                       "ИмяСобытия" - <Строка> - Имя внешнего события.
    //

   Функция ПолучитьОписаниеСобытий(Объект) Экспорт

Функция "Подключить"

Данная функция осуществляет подключение устройства: установку соединения, проверку состояния и т.д.

Копировать в буфер обмена

    // Функция осуществляет подключение устройства.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

   
    Функция Подключить(Объект) Экспорт

Функция "ТестУстройства"

Данная функция осуществляет проверку корректности настройки подключаемого оборудования.

ВАЖНО
В обязанности данной функции входит проверка корректности подключения оборудования. В ходе её выполнения, безусловно, допускается его подключение, но до завершения работы функции оборудование необходимо отключить. Следует также отметить, что, в случае обнаружения ошибок, функция обязана записать описание ошибки и осмысленную рекомендацию для пользователя, как ему следует действовать дальше, параметр Объект.ОписаниеОшибки.

Копировать в буфер обмена

    // Функция осуществляет проверку правильности настройки и подключения
    // торгового оборудования.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера устройства, проверка
    //                                   которого предполагается.
    //
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

   
    Функция ТестУстройства(Объект) Экспорт

Функция "ПолучитьИмяИсточникаВнешнегоСобытия"

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

Копировать в буфер обмена

    // Возвращает имя источника внешнего события
    // (API v2.1)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера устройства.
    //
    // Возвращаемое значение:
    //  <Строка> - Имя внешнего источника события.
    //
   
    Функция ПолучитьИмяИсточникаВнешнегоСобытия(Объект) Экспорт

Процедура "Отключить"

Данная процедура осуществляет отключение устройства: завершение соединения, удаление временных файлов и так далее.

ВАЖНО
Данная процедура не должна удалять объект драйвера. В её обязанности входит только разрыв соединения с устройством.

Копировать в буфер обмена

   // Процедура осуществляет отключение устройства.
    // (API v2.0)
    //
    // Параметры:
    //  Объект - <*>
    //         - Объект драйвера торгового оборудования.
    //
   
    Процедура Отключить(Объект) Экспорт

Процедура "НастроитьОборудование"

Данная процедура осуществляет вызов диалога настройки оборудования.

Копировать в буфер обмена

    // Процедура осуществляет вызов формы настройки торгового оборудования.
    // (API v2.0)
    //
    // Параметры:
    //  Модель    - <Строка>
    //            - Модель настраиваемого оборудования.
    //
    //  Параметры - <Структура>
    //            - Входной/выходной параметр; структура параметров.
    //
   
    Процедура НастроитьОборудование(Модель, Параметры) Экспорт

Функции, обязательные для модулей обработок обслуживания дисплеев покупателя

Данные функции являются обязательными только для модулей обработок обслуживания дисплеев покупателя. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "Очистить"

Данная функция осуществляет очистку дисплея покупателя.

Копировать в буфер обмена

    // Функция осуществляет очистку дисплея покупателя.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера дисплея покупателя, очистка
    //                                   которого предполагается.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
   
    Функция Очистить(Объект) Экспорт

Функция "Вывод"

Данная функция осуществляет вывод текста на дисплей покупателя.

ПРИМЕЧАНИЕ
Передаваемая строка может содержать символы перевода строки.

Копировать в буфер обмена

    // Функция осуществляет вывод строк на дисплей покупателя.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера дисплея покупателя, очистка
    //                                   которого предполагается.
    //
    //  Данные                         - <Массив>
    //                                 - Массив строк, выводимые на дисплей.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

    Функция Вывод(Объект, Данные) Экспорт

Функция "ВывестиСтрокиНаДисплейПокупателя"

Данная функция осуществляет вывод списка строк на дисплей покупателя.

Копировать в буфер обмена

    // Функция осуществляет вывод списка строк на дисплей покупателя.
    // (API v2.3)
    //
    // Параметры:
    // Дисплей - <*>
    // - Объект драйвера дисплея покупателя.
    //
    // ТаблицаСтрок - <ТаблицаЗначений>
    // - Таблица строк, выводимых на дисплей.
    //
    // Возвращаемое значение:
    // <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

    Функция
ВывестиСтрокиНаДисплейПокупателя(Объект, ТаблицаСтрок) Экспорт

Функции, обязательные для модулей обработок обслуживания ККМ, подключаемых в режиме Offline

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

Функция "ПолучитьПараметрыВыгрузки"

Данная функция возвращает параметры обмена данными с текущей моделью ККМ.

Копировать в буфер обмена

    // Функция возвращает параметры выгрузки товаров в ККМ Offline.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Штрихкоды                      - <Булево>
    //                                 - Выходной параметр; данная модель
    //                                   ККМ позволяет выгружать только те товары,
    //                                   для которых назначены штрихкоды.
    //
    //  ВесовойТовар                   - <Булево>
    //                                 - Данная модель ККМ поддерживает работу с
    //                                   весовыми товарами.
    //
    //  ТипыШтрихкодов                 - <Массив>
    //                                 - Массив типов штрихкодов, поддерживаемых ККМ.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //   
    Функция ПолучитьПараметрыВыгрузки(Объект, Штрихкоды, ВесовойТовар, ТипыШтрихкодов) Экспорт

Функция "ВыгрузитьТовары"

Данная функция осуществляет выгрузку таблицы товаров в ККМ.

Копировать в буфер обмена

    // Функция осуществляет выгрузку таблицы товаров в ККМ, подключенную в режиме Offline.
    // (API v2.3)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Товары                         - <ТаблицаЗначений>
    //                                 - Таблица товаров, подлежащих загрузке в ККМ.
    //                                   Таблица имеет следующие колонки:
    //                                     ПЛУ                        - <Число>
    //                                                                - Идентификатор товара на кассе.
    //                                     Номенклатура               - <СправочникСсылка.Номенклатура>
    //                                                                - Номенклатура.
    //                                     ВесовойТовар               - <Булево>
    //                                                                - Товар является весовым.
    //                                     ЕдиницаИзмерения           - <СправочникСсылка.ЕдиницыИзмерения>
    //                                                                - Единица измерения номенклатуры.
    //                                     ХарактеристикаНоменклатуры - <СправочникСсылка.ХарактеристикиНоменклатуры>
    //                                                                - Характеристика номенклатуры.
    //                                     СерияНоменклатуры          - <СправочникСсылка.СерииНоменклатуры>
    //                                                                - Серия номенклатуры.
    //                                     Цена                       - <Число>
    //                                                                - Цена номенклатуры.
    //                                     КодТовара                  - <Число>, <Строка>
    //                                                                - Код весового товара (для весовых товаров),
    //                                                                  или штрихкод (для штучного товара).
    //
    // ЧастичнаяВыгрузка               - <Булево>
    //                                 - Признак частичной выгрузки товара
    //
    // Возвращаемое значение:   
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ВыгрузитьТовары(Объект, Товары, ЧастичнаяВыгрузка = Неопределено) Экспорт

Функция "ЗагрузитьОтчет"

Данная функция осуществляет загрузку отчёта о продажах за смену из ККМ.

Копировать в буфер обмена

    // Функция осуществляет загрузку отчёта о продажах из ККМ, подключаемой в режиме Offline.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Отчет                          - <ТаблицаЗначений>
    //                                 - Выходной параметр; таблица, содержащая данные   
    //                                   о продажах за смену. Таблица содержит
    //                                   следующие колонки:
    //                                     ПЛУ        - <Число>
    //                                                - Идентификатор проданного (возвращённого)
    //                                                  товара.
    //                                     Количество - <Число>
    //                                                - Количество проданного (>0) или
    //                                                  возвращённого (<0) товара.
    //                                     Цена       - <Число>                 
    //                                                - Цена за единицу товара.
    //                                     Сумма      - <Число>
    //                                                - Сумма позиции: >0 - продажа, <0 - возврат.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ЗагрузитьОтчет(Объект, Отчет) Экспорт

Функция "ОтчетЗагружен"

Данная функция вызывается после успешной обработки загруженного из ККМ отчёта о продажах.

ВАЖНО
Данная функция обязана закрыть смену на ККМ, или вывести предупреждение для пользователя о необходимости сделать это самостоятельно.

Копировать в буфер обмена

    // Функция вызывается после того, как был загружен и обработан отчёт о продажах.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

    Функция ОтчетЗагружен(Объект) Экспорт

Функция "ОчиститьТовар"

Данная функция осуществляет очистку товаров на ККМ.

Копировать в буфер обмена

    // Функция осуществляет очистку товаров на ККМ, подключаемой в режиме Offline.
    // (API v2.3)
    //
    // Параметры:
    //   Объект - <*>
    //          - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    // <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

    Функция ОчиститьТоварыНаККМ(Объект) Экспорт

Функция "ПрочитатьФлагЗагрузки"

Данная функция возвращает состояние флага загрузки последней выгрузки.

Копировать в буфер обмена

    // Функция возвращает флаг загрузки предыдущей выгрузки
    // (API v2.3)
    //
    // Параметры:
    //   Объект          - <*>
    //                   - Объект драйвера торгового оборудования.
    //
    //   ФлагЗагрузки    - <Булево>
    //                   - Флаг состояния загрузки.
    //
    // Возвращаемое значение:
    // <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

    Функция
ПрочитатьФлагЗагрузки(Объект, ФлагЗагрузки) Экспорт

Функции, обязательные для модулей обработок обслуживания ККМ, подключаемых в режиме Online

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

Функция "ОбработатьСобытие"

Данная функция осуществляет обработку внешнего события от ККМ, подключенной в режиме Online.

Копировать в буфер обмена

    // Функция осуществляет обработку события ККМ, подключаемой в режиме Online.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                     - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Событие                    - <Строка>
    //                                 - Название события.
    //
    //  Данные                     - <Строка>
    //                                 - Данные, связанные с событием.
    //
    //  Параметры                 - <Структура>, <Неопределено>
    //                                 - Выходной параметр; структура, описывающая
    //                                   операцию, инициируемую данным событием.
    //                                   В случае, если событие не инициирует
    //                                   новую операцию, возвращается "Неопределено".
    //                                   Данная структура имеет следующие поля:
    //                                     Операция - <Строка>
    //                                              - Строка, содержащая одно из следующих
    //                                                значений: "ЗапросИнформации", "Чек".
    //                                                Операция "ЗапросИнформации" инициируется,
    //                                                когда ККМ необходимо получить информацию
    //                                                о некотором товаре. Операция "Чек"
    //                                                инициируется после закрытия чека на ККМ.
    //                                     Штрихкод - <Строка>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "ЗапросИнформации".
    //                                                Оно содержит штрихкод запрашиваемого
    //                                                товара.
    //                                     Товары   - <ТаблицаЗначений>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "Чек".
    //                                                Оно содержит таблицу позиций чека.
    //                                                Таблица имеет следующие колонки:
    //                                                  Штрихкод   - <Строка>
    //                                                             - Штрихкод продаваемого товара.
    //                                                  Количество - <Число>
    //                                                             - Количество товара.
    //                                                  Цена       - <Число>
    //                                                             - Цена товара.
    //                                                  Сумма      - <Число>
    //                                                             - Сумма позиции чека.
    //                                     Возврат  - <Булево>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "Чек".
    //                                                Оно содержит признак того, что
    //                                                сформированный чек является чеком
    //                                                на возврат.
    //
    //                                     Наличные - <Число>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "Чек".
    //                                                Оно содержит сумму оплаты наличными.
    //
    //                                     Безнал   - <Число>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "Чек".
    //                                                Оно содержит сумму оплаты безнал.
    //
    //                                     НомЧека  - <Число>
    //                                              - Данное поле существует в случае,
    //                                                    если Операция = "Чек".
    //                                                Оно содержит номер текущего чека.
    //
    //                                     НомСмены - <Число>
    //                                              - Данное поле существует в случае,
    //                                                если Операция = "Чек".
    //                                                Оно содержит номер текущей смены.
    //   
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ОбработатьСобытие(Объект, Событие, Данные, Параметры) Экспорт

Функция "ОбработатьРезультатЗапроса"

Данная функция осуществляет обработку результата запроса информации о товаре, запрошенной ККМ.

Копировать в буфер обмена

    // Функция осуществляет обработку запроса ККМ о товаре.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Данные                         - <Структура>, <Неопределено>
    //                                 - В случае, если товар не был найден,
    //                                   или его добавление в чек невозможно,
    //                                   данный параметр принимает значение
    //                                   Неопределено. Иначе данный параметр
    //                                   содержит структуру, описывающую товар,
    //                                   информация о котором запрашивается.
    //                                   Данная структура имеет следующие поля:
    //                                     Номенклатура               - <СправочникСсылка.Номенклатура>
    //                                                                - Номенклатура, которой соответствует
    //                                                                      отсканированный штрихкод.
    //                                     ЕдиницаИзмерения           - <СправочникСсылка.ЕдиницыИзмерения>
    //                                                                - Единица измерения номенклатуры.
    //                                     ХарактеристикаНоменклатуры - <СправочникСсылка.ХарактеристикиНоменклатуры>
    //                                                                - Характеристика  номенклатуры.
    //                                     СерияНоменклатуры          - <СправочникСсылка.СерииНоменклатуры>
    //                                                                - Серия  номенклатуры.
    //                                     Качество                   - <СправочникСсылка.Качество>
    //                                                                - Качество номенклатуры.
    //                                     Количество                 - <СправочникСсылка.Количество>
    //                                                                - Количество номенклатуры.
    //                                     Цена                       - <Число>
    //                                                                - Цена за единицу номенклатуры.
    //                                     Скидка                     - <Число>
    //                                                                - Процент скидки (>0) или наценки (<0).
    //                                     НомерСекции                - <Число>
    //                                                                - Номер секции, которой соответствует
    //                                                                  данная продажа.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
      Функция ОбработатьРезультатЗапроса(Объект, Данные) Экспорт

Функции, обязательные для модулей обработок обслуживания сканеров штрихкода

Данные функции являются обязательными только для модулей обработок обслуживания сканеров штрихкода. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "ОбработатьСобытиеСШК"

Данная функция осуществляет обработку внешнего события, связанного со сканированием штрихкода.

ПРИМЕЧАНИЕ
Перед завершением работы функции желательно отключить генерацию внешних событий сканером.

Копировать в буфер обмена

    // Функция осуществляет обработку внешних событий торгового оборудования.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Событие                        - <Строка>
    //                                 - Строка, идентифицирующая событие.
    //
    //  Данные                         - <Строка>
    //                                 - Данные, связанные с событием.
    //
    //  ШК                             - <Строка>
    //                                 - Выходной параметр; считанный сканером штрихкод.
    //
    //  ТипШК                          - <ПланыВидовХарактеристикСсылка.ТипыШтрихкодов>
    //                                 - Тип штрихкода либо пустая ссылка в случае,
    //                                   если тип определить невозможно.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ОбработатьСобытиеСШК(Объект, Событие, Данные, ШК, ТипШК) Экспорт

Процедура "СобытиеОбработано"

Данная процедура вызывается после обработки сканирования штрихкода.

ВАЖНО
В случае, если в предыдущей функции генерация внешних событий была приостановлена, процедура обязана её возобновить.

Копировать в буфер обмена

    // Процедура вызывается, когда система готова принять следующее событие от устройства.
    // (API v2.0)
    //
    // Параметры:
    //  Объект - <*>
    //         - Объект драйвера торгового оборудования.
    //
    Процедура СобытиеОбработано(Объект) Экспорт

Функции, обязательные для модулей обработок обслуживания терминалов сбора данных

Данные функции являются обязательными только для модулей обработок обслуживания терминалов сбора данных. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "НачатьВыгрузку"

Данная функция вызывается в момент инициализации процесса выгрузки данных в терминал.

Копировать в буфер обмена

    // Функция осуществляет инициализацию процедуры выгрузки данных в терминал
    // сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция НачатьВыгрузку(Объект) Экспорт

Функция "ВыгрузитьСтроку"

Данная функция осуществляет выгрузку строки в терминал сбора данных.

Копировать в буфер обмена

    // Функция осуществляет выгрузку строки в терминал сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Штрихкод                       - <Строка>
    //                                 - Штрихкод товара.
    //
    //  Номенклатура                   - <СправочникСсылка.Номенклатура>
    //                                 - Номенклатура.
    //
    //  ЕдиницаИзмерения               - <СправочникСсылка.ЕдиницыИзмерения>
    //                                 - Единица измерения номенклатуры.
    //
    //  ХарактеристикаНоменклатуры     - <СправочникСсылка.ХарактеристикиНоменклатуры>
    //                                 - Характеристика номенклатуры.
    //
    //  СерияНоменклатуры              - <СправочникСсылка.СерииНоменклатуры>
    //                                 - Серия номенклатуры.
    //
    //  Качество                       - <СправочникСсылка.Качество>
    //                                 - Качество.
    //
    //  Цена                           - <Число>
    //                                 - Цена номенклатуры.
    //
    //  Количество                     - <Число>
    //                                 - Количество номенклатуры.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции
    //
    Функция ВыгрузитьСтроку(Объект, Штрихкод, Номенклатура, ЕдиницаИзмерения,
                           
ХарактеристикаНоменклатуры, СерияНоменклатуры,
                           
Качество, Цена, Количество) Экспорт

Функция "ЗавершитьВыгрузку"

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

Копировать в буфер обмена

    // Функция осуществляет деинициализацию процедуры выгрузки данных в терминал
    // сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ЗавершитьВыгрузку(Объект) Экспорт

Функция "НачатьЗагрузку"

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

Копировать в буфер обмена

    // Функция осуществляет инициализацию процедуры загрузки данных из терминала
    // сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Количество                     - <Число>
    //                                 - Выходной параметр; количество записей в терминале
    //                                   сбора данных.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция НачатьЗагрузку(Объект, Количество) Экспорт

Функция "ЗагрузитьСтроку"

Данная функция вызывается при необходимости загрузить строку данных из терминала.

Копировать в буфер обмена

    // Функция осуществляет загрузку строки из терминала сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Штрихкод                       - <Строка>
    //                                 - Штрихкод, соответствующий данной номенклатуре.
    //
    //  Количество                     - <Число>
    //                                 - Выходной параметр; количество номенклатуры.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ЗагрузитьСтроку(Объект, Штрихкод, Количество) Экспорт

Функция "ЗавершитьЗагрузку"

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

Копировать в буфер обмена

    // Функция осуществляет деинициализацию процедуры загрузки данных из терминала
    // сбора данных.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ЗавершитьЗагрузку(Объект) Экспорт

Функция "ВыгрузитьТаблицу"

Данная функция вызывается при необходимости выгрузить таблицу товаров в терминал.

Копировать в буфер обмена

// Функция осуществляет выгрузку таблицы в терминал сбора данных.
// (API v2.2)
//
// Параметры:
// Идентификатор - <Строка>
// - Идентификатор терминала сбора данных.
//
// ТаблицаВыгрузки - <ТаблицаЗначений>
// - Таблица товаров, выгружаемых в ТСД.
//
// Возвращаемое значение:
// <ПеречислениеСсылка.ТООшибки*> - Результат работы функции
//
Функция ВыгрузитьТаблицу(Объект, ТаблицаВыгрузки) Экспорт

Функция "ЗагрузитьТаблицу"

Данная функция вызывается при необходимости загрузить таблицу товаров из терминала.

Копировать в буфер обмена

// Функция осуществляет загрузку таблицы из терминала сбора данных.
// (API v2.2)
//
// Параметры:
// Идентификатор - <Строка>
// - Идентификатор терминала сбора данных.
//
// ТаблицаЗагрузки - <ТаблицаЗначений>
// - Таблица товаров, загруженных из ТСД.
//
// Возвращаемое значение:
// <ПеречислениеСсылка.ТООшибки*> - Результат работы функции
//
Функция ЗагрузитьТаблицу(Объект, ТаблицаЗагрузки)Экспорт

Функции, обязательные для модулей обработок обслуживания фискальных регистраторов

Данные функции являются обязательными только для модулей обработок обслуживания фискальных регистраторов. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "ПолучитьПараметрыНаличнойОплаты"

Данная функция используется для определения возможности регистрации наличной оплаты от юридических лиц и ПБОЮЛ.

Копировать в буфер обмена

    // Функция возвращает параметры отражения в чеке наличной оплаты от юридических
    // лиц.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  НомерОтдела                    - <Число>
    //                                 - Выходной параметр; номер отдела, используемый
    //                                   для вывода чека.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция ПолучитьПараметрыНаличнойОплаты(Объект, НомерОтдела) Экспорт

Функция "XОтчет"

Данная функция вызывается при необходимости снять отчёт за смену без гашения.

Копировать в буфер обмена

    // Функция осуществляет снятие X-отчёта на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  Пароль                         - <Число>
    //                                 - Пароль пользователя ФР.
    //
    //  НомерЧека                      - <Число>
    //                                 - Выходной параметр; номер чека ФР.
    //
    //  НомерСмены                     – <Число>
    //                                 - Выходной параметр; номер текущей смены ФР.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция XОтчет(Объект, Пароль, НомерЧека, НомерСмены) Экспорт

Функция "ZОтчет"

Данная функция вызывается при необходимости снять отчёт за смену с гашением (требует административные права).

Копировать в буфер обмена

    // Функция осуществляет снятие Z-отчёта на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  Пароль                         - <Число>
    //                                 - Пароль пользователя ФР.
    //
    //  НомерЧека                      - <Число>
    //                                 - Выходной параметр; номер чека ФР.
    //
    //  НомерСмены                     – <Число>
    //                                 - Выходной параметр; номер текущей смены ФР.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция ZОтчет(Объект, Пароль, НомерЧека, НомерСмены) Экспорт

Функция "Сумма"

Данная функция вызывается при необходимости внесения или изъятия суммы в кассу.

Копировать в буфер обмена

    // Функция осуществляет внесение (сумма > 0) или изъятие (сумма < 0) суммы на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  Пароль                         - <Число>
    //                                 - Пароль пользователя ФР.
    //
    //  Сумма                          - <Число>
    //                                 - Вносимая сумма.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция Сумма(Объект, Пароль, Сумма) Экспорт

Функция "ОткрытьЧек"

Данная функция вызывается при необходимости открыть новый чек.

Копировать в буфер обмена

    // Функция осуществляет открытие чека на ФР.
    // (API v2.4)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  Пароль                         - <Число>
    //                                 - Пароль пользователя ФР.
    //
    //  ЭтоВозврат                     - <Булево>
    //                                 - Истина в случае, если открывается чек на возврат.
    //
    //  НомерЧека                      - <Число>
    //                                 - Выходной параметр; номер чека ФР.
    //
    //  НомерСмены                     – <Число>
    //                                 - Выходной параметр; номер текущей смены ФР.
    //
    //  ФискальныйЧек                  – <Булево>
    //                                 - Устанавливает признак фискального чека.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция ОткрытьЧек(Объект, Пароль, ЭтоВозврат, НомерЧека, НомерСмены, ФискальныйЧек = Истина) Экспорт

Функция "ПечататьСтроку"

Данная функция вызывается при необходимости печати строки чека.

Копировать в буфер обмена

    // Функция осуществляет печать строки чека на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  Наименование                   - <Строка>
    //                                 - Описание товара, отображаемое в чеке.
    //
    //  Количество                     - <Число>
    //                                 - Количество выводимой номенклатуры.
    //
    //  Цена                           - <Число>
    //                                 - Цена выводимой номенклатуры за единицу.
    //
    //  Скидка                         - <Число>
    //                                 - Скидка в % на выводимую номенклатуру.
    //                                   В случае, если это значение < 0, абсолютное
    //                                   значение данного параметра считается наценкой.
    //
    //  Отдел                          - <Число>
    //                                 - Номер отдела (секции), которой соответствует данная строка.
    //
    //  НДС                            - <Число>
    //                                 - Ставка НДС в %
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция ПечататьСтроку(Объект, Наименование, Количество, Цена,
                                       
Скидка, Отдел, НДС) Экспорт

Функция "АннулироватьЧек"

Данная функция вызывается при необходимости аннулировать чек.

Копировать в буфер обмена

    // Функция осуществляет аннулирование чека на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция АннулироватьЧек(Объект) Экспорт

Функция "ОтменитьЧек"

Данная функция вызывается при необходимости отменить открытый чек (требует административные права).

Копировать в буфер обмена

// Функция осуществляет отмену текущего открытого чека на ФР.
// (API v2.2)
//
// Параметры:
// Объект - <*>
// - Объект драйвера ФР.
//
// Возвращаемое значение:
// <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
//
Функция ОтменитьЧек(Объект) Экспорт

Функция "ЗакрытьЧек"

Данная функция вызывается при необходимости закрыть открытый чек.

Копировать в буфер обмена

    // Функция осуществляет закрытие текущего открытого чека на ФР.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  СуммаНал                       - <Число>
    //                                 - Сумма, внесённая наличными.
    //
    //  СуммаБезнал                    - <Число>
    //                                 - Сумма, внесённая при помощи карты.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция ЗакрытьЧек(Объект, СуммаНал, СуммаБезнал) Экспорт

Функция "НапечататьСтроки"

Данная функция осуществляет построчную печать произвольного нефискального чека. Применяется, например, для печати слип-чеков на ФР.

Копировать в буфер обмена

    // Функция осуществляет построчную печать нефискального чека из переданного массива строк.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера ФР.
    //
    //  МассивСтрок                    - <Массив>
    //                                 - Массив строк для печати.
    //
    //  Ширина                         - <Число>
    //                                 - Ширина чековой ленты.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат выполнения операции.
    //
    Функция НапечататьСтроки(Объект, МассивСтрок, Ширина) Экспорт

Функция "ПоддерживаетсяСмешанныйРежимПечати"

Данная функция осуществляет проверку поддержки смешанного режима печати.

Копировать в буфер обмена

// Функция возвращает Истину, если поддерживается смешанный режим печати чека
// (одновременно фискальные и нефискальные строки).
// (API v2.4)
//
// Параметры:
//
// Возвращаемое значение:
// <Булево>
//
Функция ПоддерживаетсяСмешанныйРежимПечати() Экспорт

Функции, обязательные для модулей обработок обслуживания электронных весов

Данные функции являются обязательными только для модулей обработок обслуживания электронных весов. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "Тарирование"

Данная функция вызывается при необходимости установить вес тары.

Копировать в буфер обмена

    // Функция задаёт вес тары на электронных весах.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  ВесТары                        - <Число>
    //                                 - Вес тары.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция Тарирование(Объект, ВесТары) Экспорт

Функция "Вес"

Данная функция вызывается при необходимости получить вес.

Копировать в буфер обмена

    // Функция получает текущий вес.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Вес                            - <Число>
    //                                 - Выходной параметр; текущий вес.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция Вес(Объект, Вес) Экспорт

Функции, обязательные для модулей обработок обслуживания считывателей магнитных карт

Данные функции являются обязательными только для модулей обработок обслуживания считывателей магнитных карт. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "ОбработатьСобытиеСМК"

Данная функция вызывается при необходимости обработать внешнее событие считывателя магнитных карт.

ПРИМЕЧАНИЕ
Перед завершением работы функции желательно отключить генерацию внешних событий устройством.

Копировать в буфер обмена

    // Функция осуществляет обработку внешних событий торгового оборудования.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  Событие                        - <Строка>
    //                                 - Строка, идентифицирующая событие.
    //
    //  Данные                         - <Строка>
    //                                 - Данные, связанные с событием.
    //
    //  КодКарты                       - <Строка>
    //                                 - Выходной параметр; код считанной карты.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ОбработатьСобытиеСМК(Объект, Событие, Данные, КодКарты) Экспорт

Процедура "СобытиеОбработано"

Данная процедура вызывается после обработки считанного кода карты.

ВАЖНО
В случае, если в предыдущей функции генерация внешних событий была приостановлена, процедура обязана её возобновить.

Копировать в буфер обмена

    // Процедура вызывается, когда система готова принять следующее событие от устройства.
    // (API v2.0)
    //
    // Параметры:
    //  Объект - <*>
    //         - Объект драйвера торгового оборудования.
    //
    Процедура СобытиеОбработано(Объект) Экспорт

Функции, обязательные для модулей обработок обслуживания электронных весов, подключаемых в режиме Offline

Данные функции являются обязательными только для модулей обработок обслуживания весов, подключаемых в режиме Offline. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "НачатьВыгрузку"

Данная функция вызывается при необходимости начать выгрузку данных в весы.

Копировать в буфер обмена

    // Функция осуществляет инициализацию процедуры выгрузки данных в весы,
    // подключенные в режиме Offline.
    // (API v2.3)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // ЧастичнаяВыгрузка               - <Булево>
    //                                 - Признак частичной выгрузки товара
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция НачатьВыгрузку(Объект, ЧастичнаяВыгрузка = Ложь) Экспорт

Функция "Выгрузить"

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

Копировать в буфер обмена

    // Функция осуществляет выгрузку позиции в весы, подключенные в режиме Offline.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    //  PLU                            - <Число>
    //                                 - Номер PLU.
    //
    //  КодТовара                      - <Число>
    //                                 - Код товара.
    //
    //  Наименование                   - <Строка>
    //                                 - Наименование номенклатуры.
    //
    //  Цена                           - <Число>
    //                                 - Цена номенклатуры.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция Выгрузить(Объект, PLU, КодТовара, Наименование, Цена) Экспорт

Функция "ЗавершитьВыгрузку"

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

Копировать в буфер обмена

    // Функция осуществляет деинициализацию процедуры выгрузки данных в весы,
    // подключенные в режиме Offline.
    // (API v2.0)
    //
    // Параметры:
    //  Объект                         - <*>
    //                                 - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    //  <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ЗавершитьВыгрузку(Объект) Экспорт

Функция "ВыгрузитьТаблицу"

Данная функция вызывается при необходимости выгрузить таблицу товаров в весы Offline.

Копировать в буфер обмена

    // Функция осуществляет выгрузку таблицы товаров в весы, подключенные в режиме Offline.
    // (API v2.3)
    //
    // Параметры:
    // Объект     - <*>
    //            - Объект драйвера торгового оборудования.
    //
    // Товары     - <ТаблицаЗначений>
    //            - Таблица товаров для выгрузки в весы.
    //
    // Возвращаемое значение:
    // <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //
    Функция ВыгрузитьТаблицу(Объект, Товары) Экспорт

Функция "ОчиститьТоварыВВесах"

Данная функция вызывается при необходимости очистку таблицы товаров в весы Offline.

Копировать в буфер обмена

    // Функция осуществляет очистку таблицы товаров в весах
    // подключенные в режиме Offline.
    // (API v2.3)
    //
    // Параметры:
    // Объект - <*>
    // - Объект драйвера торгового оборудования.
    //
    // Возвращаемое значение:
    // <ПеречислениеСсылка.ТООшибки*> - Результат работы функции.
    //

   
Функция ОчиститьТоварыВВесах(Объект) Экспорт

Функции, обязательные для модулей обработок обслуживания считывателей RFID меток

Данные функции являются обязательными только для модулей обработок обслуживания считывателей RFID меток. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "ПолучитьКоличествоМетокRFID"

Копировать в буфер обмена

    // Производит обнаружение меток в поле считывателя и возвращает в параметре количество обнаруженных меток. 
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера RFID.
    //
    //  КоличествоМеток     – <Число>
    //                      - Возвращается количество меток в поле считывателя
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ПолучитьКоличествоМетокRFID(Объект, КоличествоМеток) Экспорт

Функция "ПрочитатьДанныеИзМетокRFID"

Копировать в буфер обмена

    //Считывает все данные из обнаруженных меток и возвращает в параметре структуру, содержащую идентификаторы меток и данные. 
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера RFID.
    //
    //  КоличествоМеток     – <Число>
    //                      - Передается количество обнаруженных
    //                        меток в поле считывателя
    //
    //  Данные              – <Структура>
    //                      - Возвращаются данные, прочитанные из меток
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ПрочитатьДанныеИзМетокRFID(Объект, КоличествоМеток, Данные) Экспорт

Функция "ЗаписатьДанныеВМеткиRFID"

Копировать в буфер обмена

    // Записывает переданные данные в метки, находящиеся в поле считывателя.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера RFID.
    //
    //  КоличествоМеток     – <Число>
    //                      - Передается количество обнаруженных
    //                        меток в поле считывателя
    //
    //  ДанныеДляЗаписи     – <Строка>
    //                      - Передается строка с данными, которые
    //                        будут записаны во все обнаруженные метки
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ЗаписатьДанныеВМеткиRFID(Объект, КоличествоМеток, ДанныеДляЗаписи) Экспорт

Функция "УстановитьРежимДрайвера"

Копировать в буфер обмена

// Устанавливает режим драйвера (активный/пассивный) в соответствии с описанием на драйвер
// (API v2.2)
//
// Параметры:
// Объект - <*>
// - Объект драйвера RFID.
//
// АктивныйРежим - <Булево>
// - Предписывает установить активный режим (истина) или пассивный (ложь).
//
// Возвращаемое значение:
// <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
// - Результат работы функции.
//
Функция УстановитьРежимДрайвера(Объект, АктивныйРежим) Экспорт

Функция "ОткрытьСессиюRFID"

Копировать в буфер обмена

    // Открывает новую сессию для чтения данных из меток, попадающих в поле считывателя.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера RFID.
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ОткрытьСессиюRFID(Объект) Экспорт

Функция "ЗакрытьСессиюRFID"

Копировать в буфер обмена

    // Закрывает открытую ранее сессию.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект                 - <*>
    //                         - Объект драйвера RFID.
    //
    //  ИгнорироватьМеткиВПоле – <Строка>
    //                         - Признак проверки меток в поле
    //                             "Истина" - если есть метки в поле,
    //                                        то сессия не закрывается 
    //                                        и возвращается ошибка
    //                             "Ложь"   - если есть метки в поле,
    //                                        то сессия закрывается и 
    //                                        возвращается количество 
    //                                        обнаруженных меток в поле
    //
    //  КоличествоМеток        – <Число>
    //                         - Передается количество обнаруженных
    //                           меток в поле считывателя
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ЗакрытьСессиюRFID(Объект, ИгнорироватьМеткиВПоле, КоличествоМеток) Экспорт

Функция "ОбработатьСобытиеОтRFID"

Копировать в буфер обмена

    // Обрабатывает событие, пришедшее от считывателя RFID меток.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект        - <*>
    //                - Объект драйвера RFID.
    //
    //  Событие       – <Строка>
    //                - Имя полученного события
    //
    //  Данные        – <Строка>
    //                - Данные полученные из компоненты
    //
    //  ДанныеИзМеток – <Структура>
    //                - Возвращаются полученные данные, 
    //                  преобразованные во внутреннюю структуру
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ОбработатьСобытиеОтRFID(Объект, Событие, Данные, ДанныеИзМеток) Экспорт

Процедура "СобытиеОбработано"

Копировать в буфер обмена

    // Процедура вызывается, когда система готова принять следующее событие от устройства.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект             - <*>
    //                     - Объект драйвера RFID.
    //
    //  РезультатОбработки – <Булево>
    //                     - Оповещает драйвер о том, что
    //                       событие системой было получено.
    //                       Параметр "ФлагСостояния" указывает 
    //                       на успешность обработки.
    //
    // Возвращаемое значение: 
    //
    Процедура СобытиеОбработано(Объект, РезультатОбработки) Экспорт

Функции, обязательные для модулей обработок обслуживания эквайринговых систем

Данные функции являются обязательными только для модулей обработок обслуживания эквайринговых систем. При создании обработок обслуживания оборудования другого вида на основе содержащегося в данном разделе шаблона эти функции необходимо удалить из обработки обслуживания.

Функция "ОплатитьПлатежнойКартой"

Копировать в буфер обмена

    // Функция осуществляет авторизацию (оплату) по карте.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера ЭС.
    //
    //  Сумма               - <Число>
    //                      - Сумма к оплате по карте
    //
    //  КодRRN              - <Строка>
    //                      - Уникальный код RRN транзакции
    //
    //  КодАвторизации      - <Строка>
    //                      - Возвращается код авторизации транзакции
    //
    //  КодОперации         - <Строка>
    //                      - Последовательный код операции
    //
    //  МассивСтрокСлипЧека - <Структура>
    //                      - Массив строк слип-чека, сформированного
    //                        после успешного выполнения операции
    //
    //  ШиринаЧека          - <Число>
    //                      - Ширина слип-чека, установленная в параметрах настройки
    //
    //  КоличествоКопий     - <Число>
    //                      - Количество печатаемых копий слип-чека
    // 
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ОплатитьПлатежнойКартой(Объект, Сумма, КодRRN,
                                   
КодАвторизации, КодОперации,
                                   
МассивСтрокСлипЧека, ШиринаЧека, КоличествоКопий) Экспорт

Функция "ВернутьПлатежПоПлатежнойКарте"

Копировать в буфер обмена

    // Функция осуществляет возврат платежа по карте.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера ЭС.
    //
    //  Сумма               - <Число>
    //                      - Сумма к оплате по карте
    //
    //  КодRRN              - <Строка>
    //                      - Уникальный код RRN транзакции
    //
    //  КодАвторизации      - <Строка>
    //                      - Возвращается код авторизации транзакции
    //
    //  КодОперации         - <Строка>
    //                      - Последовательный код операции
    //
    //  МассивСтрокСлипЧека - <Структура>
    //                      - Массив строк слип-чека, сформированного
    //                        после успешного выполнения операции
    //
    //  ШиринаЧека          - <Число>
    //                      - Ширина слип-чека, установленная в параметрах настройки
    //
    //  КоличествоКопий     - <Число>
    //                      - Количество печатаемых копий слип-чека
    // 
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ВернутьПлатежПоПлатежнойКарте(Объект, Сумма, КодRRN,
                                         
КодАвторизации, КодОперации,
                                         
МассивСтрокСлипЧека, ШиринаЧека, КоличествоКопий) Экспорт

Функция "ОтменитьПлатежПоПлатежнойКарте"

Копировать в буфер обмена

    // Функция осуществляет отмену платежа по карте.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера ЭС.
    //
    //  Сумма               - <Число>
    //                      - Сумма к оплате по карте
    //
    //  КодRRN              - <Строка>
    //                      - Уникальный код RRN транзакции
    //
    //  КодАвторизации      - <Строка>
    //                      - Возвращается код авторизации транзакции
    //
    //  КодОперации         - <Строка>
    //                      - Последовательный код операции
    //
    //  МассивСтрокСлипЧека - <Структура>
    //                      - Массив строк слип-чека, сформированного
    //                        после успешного выполнения операции
    //
    //  ШиринаЧека          - <Число>
    //                      - Ширина слип-чека, установленная в параметрах настройки
    //
    //  КоличествоКопий     - <Число>
    //                      - Количество печатаемых копий слип-чека
    // 
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ОтменитьПлатежПоПлатежнойКарте(Объект, Сумма, КодRRN,
                                          
КодАвторизации, КодОперации,
                                          
МассивСтрокСлипЧека, ШиринаЧека, КоличествоКопий) Экспорт

Функция "ИтогиДняПоКартам"

Копировать в буфер обмена

    // Функция осуществляет сверку итогов по картам.
    // (API v2.0)
    //
    // Параметры: 
    //  Объект              - <*>
    //                      - Объект драйвера ЭС.
    //
    //  МассивСтрокСлипЧека - <Структура>
    //                      - Массив строк слип-чека, сформированного
    //                        после успешного выполнения операции
    //
    //  ШиринаЧека          - <Число>
    //                      - Ширина слип-чека, установленная в параметрах настройки
    //
    // Возвращаемое значение: 
    //     <ПеречислениеСсылка.ОшибкиПриРаботеСТорговымОборудованием>
    //                 - Результат работы функции.
    //
    Функция ИтогиДняПоКартам(Объект, МассивСтрокСлипЧека, ШиринаЧека) Экспорт

Функция "ПоддерживаетсяСверкаИтогов"

Копировать в буфер обмена

    // Проверяется возможность выполнения операции "Сверка итогов"
    // (API v2.0)
    //
    // Параметры:
    //
    // Возвращаемое значение:
    //     <Булево> - Признак поддержки операции "сверка итогов".
    //
    Функция ПоддерживаетсяСверкаИтогов() Экспорт

Загрузка шаблона обработки обслуживания

Файл шаблона обработки обслуживания Template_v2.epf находятся на CD-ROM в каталоге 1CIts\EXE\Equipmnt\TWEPF\

ВЫ МОЖЕТЕ ПРЯМО СЕЙЧАС СКОПИРОВАТЬ ФАЙЛ ШАБЛОНА
НА ЖЕСТКИЙ ДИСК ВАШЕГО КОМПЬЮТЕРА

Скопировать на жёсткий диск