Различия

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

--- кассир5:внешниемодули:доработкаконфигурации [2020/04/15 16:07]
dzayonchkovskiy создано
+++ кассир5:внешниемодули:доработкаконфигурации [2024/12/24 09:50] (текущий)
dzayonchkovskiy
@@ Строка 1: / Строка 1: @@
-===== Инструкции по доработке конфигурации =====
-==== Возможные способы доработки конфигурации: ====
+====== Инструкции по доработке конфигурации ======
+===== Отладка через конфигуратор 1С =====
+Для запуска отладки конфигурации из конфигуратора 1С нужно указать параметры сеанса 1С (указать используемый номер ПОС):\\
+<code>STARTER+POSNUMBER="1"+ROCKEY</code>
+Если используется ключ катран, тогда вместо ROCKEY нужно написать KATRAN.\\
+===== Возможные способы доработки конфигурации: =====
+Рекомендуем ознакомиться с вебинаром [[https://www.youtube.com/watch?v=6B2C0I5MIN0|Вебинар - доработки конфигурации Кассир 5]]
   - пользовательские раскладки клавиатуры
   - [[кассир5:стартер:пользовательскиекнопкисупервизора|пользовательские кнопки в форме супервизор]]
@@ Строка 11: / Строка 21: @@
 Способ №2 используется когда нужно добавить дополнительную кнопку в супервизор.\\
-Способ №5: Расширенные отчеты используются для вывода какой-то информации на экран или принтер, могут вызываться пользователем в произвольный момент времени и, опционально, автоматически при снятии отчета с гашением
+Способ №3: Расширенные отчеты используются для вывода какой-то информации на экран или принтер, могут вызываться пользователем в произвольный момент времени и, опционально, автоматически при снятии отчета с гашением
 Способ №4 решает большинство задач без необходимости доработок конфигурации и типовых обработок с максимальной совместимостью при обновлении конфигурации.\\
+[[кассир5:внешниемодули:apiлогическихмодулей|API логических модулей]]\\
+[[кассир5:внешниемодули:обработчикивзк|Список обработчиков в защищенной компоненте]]\\
+Ниже можно скачать архивы с заготовкой модуля логики. В конце модуля основной формы каждой заготовки есть краткая пошаговая инструкция.\\
+{{ :кассир5:внешниемодули:lm_empty.zip |ПустаяЗаготовка}} - пустой модуль логики, обработчики для добавления закладки подключатся автоматически при заполнении переменных ИмяМодуля и ЗаголовокЗакладкиНастроек.\\
+{{ :кассир5:внешниемодули:lm_print.zip |ЗаготовкаМакетЧека}} - заготовка модуля логики, который позволяет добавить дополнительные поля в макет чека.\\
+{{ :кассир5:внешниемодули:lm_main.zip |ЗаготовкаОсновныеОбработчики}} - заготовка модуля с наиболее часто используемыми обработчиками. Каждый обработчик прокомментирован.\\
+{{ :кассир5:внешниемодули:lm_discount.zip |Переопределение активности автоскидок}} - модуль логики позволяет программно переопределять активность автоматических скидок.
+{{ :кассир5:внешниемодули:settings_example.zip |Пример работы с элементами формы настроек модуля}} - модуль логики с примером работы с элементами формы настроек модуля.
 Вариант №5 крайне не рекомендуется использовать по следующим причинам:\\
   * Изменение базовой версии конфигурации невозможно.
+  * Обновление через дистрибутив невозможно, т.к. дистрибутив выполняет загрузку оригинальной конфигурации.
   * При каждом обновлении конфигурации потребуется переносить изменения вручную.
   * В новой версии конфигурации возможно изменение кода, которое потребует дополнительное время на актуализацию доработок.
-==== Основные функции ====
+===== Основные реквизиты, функции, процедуры,  =====
-При доработке конфигурации наиболее часто используются функции:\\
+При доработке конфигурации рекомендуется использовать типовые методы, которые можно найти в коде конфигурации.\\
-=== Работа с составом чека ===
+Список методов в защищенной компоненте описан в статье [[[кассир5:интерфейсзк|API компоненты AddIn.CashContext]]\\
+Наиболее часто используемые методы описаны ниже.\\
+Формат описания методов:\\
+\\
+Имя метода - описание метода.\\
+Параметры:\\
+Номер параметра: Тип параметра (значение по-умолчанию) - описание параметра.\\
+Пример кода.\\
+==== Диалоги ====
+**ИнтерфОшибка** - процедура выводит сообщение пользователю.\\
+Параметры:\\
+: Строка - строка с текстом сообщения\\
+: Строка ("Ошибка") - заголовок формы\\
+<code>ИнтерфОшибка("Текст сообщения", "Внимание!");</code>
+\\
+**ИнтерфВопросДаНет** - глобальная функция открывает окно с переданным текстом и двумя кнопками "Да" и "Нет", возвращает нажатую кнопку ("Да" или "Нет").\\
+Параметры:\\
+: Строка - строка с текстом вопроса\\
+: Строка ("Нет") - кнопка по-умолчанию ("Да" или "Нет")\\
+<code>
+Если ИнтерфВопросДаНет("Текст вопроса") = "Да" Тогда
+	// обработка ответа на вопрос
+КонецЕсли;
+</code>
+**ИнтерфВопросДаНетОтмена** - глобальная функция открывает окно с переданным текстом и кнопками "Да", "Нет", "Отмена", при нажатии кнопки возвращает строку ("Да", "Нет", "Отмена").\\
+Параметры:\\
+: Строка - строка с текстом вопроса\\
+<code>
+Если ИнтерфВопросДаНетОтмена("Текст вопроса") = "Да" Тогда
+	// обработка ответа на вопрос
+КонецЕсли;
+</code>
+**ПолучитьКоличество, ПолучитьСекцию, ПолучитьСумму и др.** - функции формы Регистрация.ФормаЗапросКоличества открывают окно для ввода числового значения (все возможные функции и их параметры см. в модуле Регистрация.ФормаЗапросКоличества).\\
+<code>
+ФормаЗапросКоличества = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.ФормаЗапросКоличества");
+Если ФормаЗапросКоличества = Неопределено Тогда
+	ФормаЗапросКоличества = МенеджерОбъектов.СоздатьОбщуюФорму("Регистрация.ФормаЗапросКоличества", "MAIN");
+КонецЕсли;
+НеДробноеЧисло = ФормаЗапросКоличества.ПолучитьЧисло(10, 0, 2); // ввод недробного двузначного числа, значение по-умолчанию 10
+</code>
+**ВыбратьДату, ВыбратьВремя, ВыбратьДатуИВремя**  - функции общей формы ВыборДаты открывает форму для ввода даты/времени/даты и времени, тип возвращаемого значения Булево.\\
+: Произвольный - в эту переменную запишится дата, которую указал пользователь.\\
+: Дата (Неопределено) - значение по-умолчанию.\\
+<code>
+УИД_Формы = Новый УникальныйИдентификатор();
+ФормаВыбораДаты = МенеджерОбъектов.СоздатьОбщуюФорму("ОбщаяФорма.ВыборДаты", УИД_Формы);
+Результат = Неопределено;
+ДатаРождения = Дата(2000, 1, 1);
+Если ФормаВыбораДаты.ВыбратьДату(Результат, ДатаРождения) Тогда
+	ДатаРождения = Результат;
+КонецЕсли;
+МенеджерОбъектов.ВыгрузитьОбщийОбъект("ОбщаяФорма.ВыборДаты", УИД_Формы);
+</code>
+==== Работа с составом чека ====
+Как получить форму регистрации в коде:\\
+<code>ФормаРегистрации = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.Форма");</code>
+\\
+Как получить состав чека формы регистрации:\\
+<code>
+ФормаРегистрации = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.Форма");
+КоличествоСтрок = ФормаРегистрации.СоставЧека.Количество();
+</code>
+Как получить выделенную строку состава чека:\\
+<code>
+ФормаРегистрации = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.Форма");
+ТекущаяСтрокаСоставаЧека = ФормаРегистрации.элтСоставЧека.ТекущаяСтрока;
+</code>
+Как добавить товар в состав чека по коду или артикулу (для добавления по артикулу нужно в 2-й параметр передать "Артикул"):\\
+<code>
+ФормаРегистрации = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.Форма");
+ЗК = МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.CashContext");
+ЗК.ДобавитьПозициюПоКодуАртикулу(100, "Код", "", -1, ФормаРегистрации);// добавить товар с кодом 100, цена цена по-умолчанию (из БД)
+ЗК.ДобавитьПозициюПоКодуАртикулу(200, "Код", "", 500, ФормаРегистрации);// добавить товар с кодом 200 с ценой 500
+ЗК.ДобавитьПозициюПоКодуАртикулу(300, "Код", "12345", -1, ФормаРегистрации);// добавить единицу с кодом "12345" товара с кодом 300, цена по-умолчанию
+</code>
+Как добавить товар в состав чека по штрихкоду:\\
+<code>
+ФормаРегистрации = МенеджерОбъектов.ПолучитьОбщийОбъект("Регистрация.Форма");
+ЗК = МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.CashContext");
+ЗК.ДобавитьПозициюПоШтрихкоду("12345", -1, ФормаРегистрации, Ложь, Ложь);
+ЗК.ДобавитьПозициюПоШтрихкоду("12345",// штрихкод
+								-1, // цена (-1 = цена из БД)
+								ФормаРегистрации,
+								Ложь,// Истина - штрихкод считан сканером, Ложь - вручную
+								Ложь);// Истина - проверять право для регистрации по штрихкоду, Ложь - не проверять
+</code>
+==== Работа с главным полем ввода ====
+Для установки значения главного поля ввода (ГПВ) используется процедура модуля формы регистрации **УстановитьГлавноеПолеВвода**.\\
+Для установки нечислового значения в настройках должен быть разрешен строковый ввод.\\
+Параметры:\\
+: строка или число - значение, которое нужно установить в ГПВ.\\
+Пример:
+<code>
+УстановитьГлавноеПолеВвода("");// сбросить ГПВ
+УстановитьГлавноеПолеВвода("Art1");// установить строку Art1
+УстановитьГлавноеПолеВвода(1000.50);// установить строку 1000.5
+</code>
+Для получения текущего значения ГПВ используется функция формы регистрации ПолучитьГлавноеПолеВвода, единственный параметр определяет в каком виде нужно получить результат:
+  * 0 - Строка  - Получаем строковое выражение Главного поля ввода (при вводе числа - точка не будет присутствовать в строке)
+  * 1 - Сумма - Получить значение главного поля ввода, преобразованного к формату суммы
+  * 2 - Количество - Получить значение главного поля ввода, преобразованного к формату количества
+Пример:
+<code>
+УстановитьГлавноеПолеВвода(1.456);// установить значение ГПВ "1.456"
+Значение = ПолучитьГлавноеПолеВвода(0);// вернёт строку "1456"
+Значение = ПолучитьГлавноеПолеВвода(1);// вернёт число 1.46
+Значение = ПолучитьГлавноеПолеВвода(2);// вернёт число 1.456
+</code>
+==== Работа с ККМ ====
+Пример печати произвольного текста на ККМ (из формы регистрации, считаем что ККМ подключен):
+<code>
+//ф-я КонвертироватьВМассивДляПечати принимает на вход макет чека, можно использовать тэги форматирования
+//<CENTER> - выравнивание по центру
+//<LEFT> - выравнивание по левому краю (по-умолчанию)
+//<RIGHT> - выравнивание по правому краю
+//Слева<HR> </HR>Справа - разделить слова пробелами на всю ширину
+//<HR>.</HR> - повторить на всю ширину
+//<s> - штрихкод ean13
+//<s2d> - qr-код
+//<CUT> - отрезка
+ПС = Символ(182);
+Текст = "<CENTER>Строка по центру" + ПС +
+        "Строка слева" + ПС +
+        "<RIGHT>Строка справа" + ПС +
+        "<HR>*</HR>" + ПС +
+        "<s>1234567890123</s>" + ПС +
+        "<s2d>http://host</s2d>" + ПС +
+        " " + ПС +
+        " " + ПС +
+        "<CUT>";
+ЗК = МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.CashContext");
+МассивДляПечати = ЗК.КонвертироватьВМассивДляПечати(Текст);
+СтрокаККМ = Кассир5_DataAccess.ПолучитьККМ();
+РезультатПечати_бул = ЗК.FnKKM_PrintStringBlock(СтрокаККМ, МассивДляПечати);
+</code>
+=== Подключение к ККМ ===
+Если неизвестно подключен ККМ в данный момент или нет, то нужно выполнить следующий код.
+Если ККМ не подключен, то выполнится подключение, а после окончания работы с ККМ - отключение, если он не был подключен.
+<code>
+Функция ВыполнитьЧтоТоНаККМ()
+СтрокаККМ = Кассир5_DataAccess.ПолучитьККМ();
+Если СтрокаККМ = Неопределено Тогда
+  ИнтерфОшибка("Не настроена ККМ");
+  Возврат Ложь;
+КонецЕсли;
+ЗК = МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.CashContext");
+БылПолключен = ЗК.FnKKM_GetParam(СтрокаККМ, "Подключен");
+Если НЕ БылПолключен И НЕ МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.CashContext").FnKKM_Connect(СтрокаККМ, Истина) Тогда
+  Возврат Ложь; // не удалось подключиться к ККМ
+КонецЕсли;
+//работа с ККМ
+Результат = Истина;
+Если НЕ БылПолключен Тогда
+  ЗК.FnKKM_Disconnect(СтрокаККМ, Истина);
+КонецЕсли;
+Возврат Результат;
+КонецФункции
+</code>
+==== Работа со справочниками транзакций ====
+В Кассир 5 есть два типа справочников с транзакциями:\\
+. Справочник Временные транзакции - хранит информацию о текущем чеке, при закрытии (или отмене) чека переносятся в справочник Транзакции и удаляются.\\
+. Справочник Транзакции - хранит информацию об основных действиях кассира, закрытых или отмененных чеках и пр.\\
+Справочник выгружается в файл отчета по [[:таблицатранзакцийкассира|формату Кассир 5]].\\
+Элементы удаляется только автоматически по регламенту.\\
+\\
+=== Работа со справочником Временные транзакции ===
+Перед работой с временными транзакциями рекомендуется ознакомиться со статьей [[:таблицавременныхтранзакцийкассира|Таблица временных транзакций кассира]].\\
+Если нужно записать произвольную транзакцию, которая относится к текущему чеку, тогда нужно записать временную транзакцию.\\
+Все функции для работы с временными транзакциями находятся в модуле обработки Кассир5_DataAccess.\\
+**ПолучитьВремТранзакцию** - ф-я получает информация о временной транзакции по коду. Если врем. транзакция не найдена, тогда в возвращенной структуре в свойство "Пустая" будет установлено значение Истина.\\
+Параметры:\\
+: Число - код временной транзакции для поиска.\\
+<code>
+Транз = Кассир5_DataAccess.ПолучитьВремТранзакцию(100); // получить врем. транзакцию с кодом 100
+</code>
+**ПолучитьВремТранзакцииПоТипу** - ф-я выполняет отбор временных транзакций по типу (поле ТипТранзакции), тип возвращаемого значения Таблица значений.\\
+<code>
+Транзакции11 = Кассир5_DataAccess.ПолучитьВремТранзакцииПоТипу(11);// в переменнную Транзакции11 установится таблица со всеми транзакциями с типом 11
+</code>
+**ПисатьВремТранзакцию** - ф-я создаёт новый элемент справочника Временные транзакции.\\
+Параметры:\\
+: Число - код транзакции (используется для уникальности врем. транзакций и определяет порядок записи в справочник Транзакции). Если передано значение "0", тогда установится текущий максимальный код + 1. \\
+: Число - поле Тип транзакции\\
+: Дата (Неопределено) - поле Дата транзакции (если не указана - подставляется текущая дата)\\
+: Число - поле Секция\\
+: Строка (до 150 символов) - поле Код товара (поле используется для записи строковых данных)\\
+: Число - поле Цена\\
+: Число - поле Количество\\
+: Число - поле Сумма\\
+: Число - номер ККМ (определяет к какому ККМ относится транзакция, если задать несуществующий номер ККМ - транзакция не будет перенесена в справочник Транзакции)\\
+: Строка ("")- поле Скидка, поле используется для оперативной работы с длинными строками, в справочник Транзакции не переносится\\
+Пример записи врем. транзакции с типом 777 на чек, с явным указанием кода:
+<code>
+КодВремТранзакции = 900000;
+// запишем транзакцию на чек, если транзакция с переданным кодом уже существует, тогда будет выполнено изменение транзакции
+// дата транзакции = ТекущаяДата(), секция = 1, код товара = "2", цена = 3, количество = 4, сумма = 5, номер ккм = по-умолчанию
+Кассир5_DataAccess.ПисатьВремТранзакцию(КодВремТранзакции, 777, ТекущаяДата(), 1, "2", 3, 4, 5, Кассир5_DataAccess.ИспользоватьККМ, "");
+</code>
+Пример записи врем. транзакции на чек, без явного указания кода:
+<code>
+ТипТранзакцииДопИнфо = 777;
+// удаляем транзакцию с типом 777, чтобы не было дублей
+Для Каждого Транз Из Кассир5_DataAccess.ПолучитьВремТранзакцииПоТипу(ТипТранзакцииДопИнфо) Цикл
+	Кассир5_DataAccess.УдалитьВремТранзакцию(Транз.Код);
+КонецЦикла;
+// запишем транзакцию на чек, код установится автоматически, дата транзакции = ТекущаяДата(), секция = 1, код товара = "2", цена = 3, количество = 4, сумма = 5, номер ккм = по-умолчанию
+Кассир5_DataAccess.ПисатьВремТранзакцию(0, ТипТранзакцииДопИнфо, ТекущаяДата(), 1, "2", 3, 4, 5, Кассир5_DataAccess.ИспользоватьККМ, "");
+</code>
+См. также в модуле обработки Кассир5_DataAccess: \\
+**ИзменитьВремТранзакциюПоСтруктуре**\\
+**ИзменитьВремТранзакцию**\\
+**УдалитьВремТранзакцию**\\
+**ПолучитьВыборкуСкидок**\\
+**ПолучитьВремТранзакцииЧека**\\
+=== Работа со справочником Транзакции ===
+Для записи транзакции напрямую в справочник Транзакции (транзакции, не относящиеся к конкретному чеку) используется процедура модуля обработки Кассир5_DataAccess **ЗаписатьТранзакции**.\\
+Параметры:\\
+: Таблица значений (неопределено) - таблица значений, получаемая функцией модуля формы регистрациии или модуля обработки Кассир5_DataAccess **ДобавитьТранзакциюВТаблицу**.\\
+Пример записи одной транзакции с типом 777:
+<code>
+Кассир5_DataAccess.ЗаписатьТранзакции(Кассир5_DataAccess.ДобавитьТранзакциюВТаблицу(Неопределено,
+Неопределено,// код кассира
+,// тип транзакции
+Неопределено,// дата транзакции
+,//секция
+"",// код товара
+,//цена
+,//количество
+));//сумма
+</code>
+Пример записи нескольких транзакций:
+<code>
+ТаблицаТранзакций = Неопределено;
+Кассир5_DataAccess.ДобавитьТранзакциюВТаблицу(ТаблицаТранзакций, Неопределено, 777, Неопределено, 0, "", 0, 0, 0);
+Кассир5_DataAccess.ДобавитьТранзакциюВТаблицу(ТаблицаТранзакций, Неопределено, 778, Неопределено, 0, "", 0, 0, 0);
+Кассир5_DataAccess.ЗаписатьТранзакции(ТаблицаТранзакций);
+</code>
+==== Работа с правами пользователя ====
+**ПравоДоступно**  - функции модуля обработки Кассир5_DataAccess, выполняет проверку наличия права у пользователя, тип возвращаемого значения булево.\\
+: Строка - имя права.\\
+: Булево (Истина) - если у текущего пользователя право отсутствует, но существует пользователь с набором прав, в котором это право присутствует - тогда откроется форма для считывания карты пользователя с этим правом.\\
+: Булево (Истина) - выводить сообщение об отсутствии права.\\
+: Число (Неопределено) - если параметр указан, тогда будет проверяться пользователь с кодом, указанным в этом параметре, иначе текущий пользователь.\\
+: Число (Неопределено) - в этот параметр запишится код пользователя, который подтвердил право.\\
+<code>
+Если НЕ Кассир5_DataAccess.ПравоДоступно("Право", Ложь, Ложь) Тогда
+// действие при отсутствии права без запроса карты и без вывода сообщения
+КонецЕсли;
+</code>
+**ПравоОтсутствует**  - функции модуля обработки Кассир5_DataAccess, выполняет проверку отсутствия права у пользователя, тип возвращаемого значения булево.\\
+: Строка - имя права.\\
+: Булево (Истина) - если у текущего пользователя право присутствует, но существует пользователь с набором прав, в котором это право отсутствует - тогда откроется форма для считывания карты пользователя без этого права.\\
+: Булево (Истина) - выводить сообщение при наличии права.\\
+: Число (Неопределено) - если параметр указан, тогда будет проверяться пользователь с кодом, указанным в этом параметре, иначе текущий пользователь.\\
+<code>
+Если НЕ Кассир5_DataAccess.ПравоДоступно("Право", Ложь, Ложь) Тогда
+// действие при отсутствии права без запроса карты и без вывода сообщения
+КонецЕсли;
+</code>
+==== Отладка ====
+Большинство действий пользователя (нажатие клавиш, события сканера и ридера магнитных карт) обрабатывается в конфигурации как внешнее событие.\\
+Иногда нужно проверить - правильно ли отработает программа при определенных входящих данных от оборудования, а возможности использовать реальное оборудования нет.\\
+Для этого можно (в модуле логики или назначить на кнопку) эмулировать внешнее событие методом GenerateEvent компоненты AddIn.ShtrihContext:\\
+Параметры:\\
+: название источника события (для большинства событий не анализируется)\\
+: название события\\
+: данные события\\
+Пример:\\
+эмуляция работы со сканером:
+<code>
+МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.ShtrihContext").GenerateEvent("Scanner", "ScannerEvent", "123");
+</code>
+эмуляция работы с ридером магнитных карт:
+<code>
+МенеджерОбъектов.ПолучитьОбщийОбъект("AddIn.ShtrihContext").GenerateEvent("MSCReaderEvent", "MSCReaderEvent", "123");
+</code>
+Также в настройках сканера можно добавить эмулятор сканера.

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

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

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

Различия

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