Пример технического задания 1С

Грамотно составленное техническое задание — половина успеха любой доработки 1С. Оно защищает и заказчика (понятно, что и когда будет сделано, по каким критериям принимать работу), и исполнителя (нет «бесконечных хотелок» сверх согласованного объема). Ниже — развернутый пример ТЗ на типовую задачу: хранение копий кассовых чеков в формате PDF в программе 1С. Шаблон можно адаптировать под любую конфигурацию — достаточно заменить объекты доработки и конкретику.

Задача: добавление возможности хранения в программе 1С копий кассовых чеков в формате PDF

ТЕХНИЧЕСКОЕ ЗАДАНИЕ

Наименование:
Добавление возможности хранения, просмотра и управления копиями кассовых чеков в формате PDF в программе 1С

Версия документа: 1.0
Дата: «___» ________ 20___ г.
Статус: на согласовании / согласовано

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

Заказчик:
(указать организацию, контактное лицо, должность, телефон, e-mail)

Исполнитель:
(указать: штатный программист 1С / компания-франчайзи / ИП, контактное лицо)

Конфигурация 1С:
(указать: 1С:Бухгалтерия 3.0 / 1С:Розница 2.x (3.0) / 1С:Управление торговлей 11 / отраслевая / кастомная — с указанием точного релиза, например «Управление торговлей, редакция 11.5 (11.5.16.x)»)

Платформа 1С:
1С:Предприятие 8.3 (указать версию платформы, например 8.3.24, и используемые клиенты: тонкий клиент / толстый клиент / веб-клиент)

Режим работы базы:
(указать: файловый / клиент-серверный, СУБД — MS SQL Server / PostgreSQL, количество одновременно работающих пользователей)

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

Ограничения:

• Конфигурация находится / не находится на поддержке фирмы «1С» (снята ли с замка).
• Доработка выполняется преимущественно через механизм расширений конфигурации без снятия базы с поддержки (см. раздел 9).
• Наличие/отсутствие в конфигурации Библиотеки стандартных подсистем (БСП) и подсистемы «Работа с файлами».

2. Термины и определения

3. Текущая ситуация («как есть»)

• Кассовые чеки пробиваются на ККТ, электронные копии (PDF) формируются ОФД / кассовым ПО и сохраняются разрозненно: в почте, на локальных дисках кассиров, в личных папках.
• Поиск копии чека по запросу покупателя или проверяющего занимает значительное время.
• Отсутствует связь «документ в 1С ↔ файл чека», нет контроля прав доступа и истории действий с файлами.

4. Целевая ситуация («как должно быть»)

• PDF-копия чека прикреплена к соответствующему документу в 1С и открывается из его формы в 1–2 клика.
• Файлы хранятся централизованно, попадают в резервные копии, защищены правами доступа.
• Все действия с файлами (загрузка, просмотр, удаление) фиксируются.

5. Цель и задачи доработки

Цель

Обеспечить возможность хранения, просмотра и управления PDF-копиями кассовых чеков непосредственно в информационной базе 1С с разграничением прав доступа и сохранением обновляемости конфигурации.

Задачи

• Добавить механизм прикрепления PDF-файлов к документам кассовых чеков (вручную и автоматически).
• Обеспечить удобный просмотр PDF внутри 1С без выгрузки файла на диск.
• Реализовать надежное хранение файлов (в ИБ или в томах хранения) с попаданием в резервные копии.
• Обеспечить контроль прав доступа и журналирование действий с файлами.
• Предусмотреть массовую первичную загрузку архива уже накопленных чеков.

6. Объекты доработки

Основные объекты конфигурации

• Документ «Чек ККМ» / «Кассовый чек» / аналогичный (уточнить по конфигурации; при необходимости — также «Чек ККМ на возврат»).
• Подсистема «Работа с файлами» / «Присоединенные файлы» БСП (использовать типовую, если она есть в конфигурации — приоритетный вариант).
• Форма документа и, при необходимости, форма РМК (рабочее место кассира) — если чеки прикрепляются/просматриваются в процессе работы кассира.
• Роли и профили групп доступа пользователей.
• Регламентные задания (для автоматической загрузки — см. п. 7.2).

Создаваемые объекты (ориентировочно, уточняется на этапе анализа)

• Расширение конфигурации (например, «ХранениеЧековPDF»).
• Обработка «Загрузка PDF-чеков из каталога» (интерактивная + серверная часть для регламентного задания).
• Обработка «Первичная загрузка архива чеков» (разовая, для миграции — п. 7.6).
• При отсутствии БСП: справочник «Присоединенные файлы чеков» + регистр сведений для хранения данных файлов.

7. Функциональные требования

7.1 Хранение PDF-чеков

1. Для каждого документа «Чек ККМ» должна быть возможность хранения одного или нескольких PDF-файлов.
2. Поддерживаемый формат: .pdf. Попытка загрузки файла другого формата должна блокироваться с понятным сообщением пользователю.
3. Максимальный размер одного файла: (указать, например, до 10 МБ). При превышении — отказ в загрузке с сообщением.
4. Для каждого файла хранятся реквизиты: наименование, размер, дата загрузки, автор загрузки, комментарий (необязательный).
5. Дубли: при повторной загрузке файла с тем же именем к тому же документу — запрашивать подтверждение «заменить / добавить как новый / отменить» (поведение согласовать).

7.2 Способы добавления PDF

Реализовать следующие варианты (состав — по согласованию):

Ручное прикрепление:

• кнопка «Добавить PDF-чек» в форме документа;
• поддержка перетаскивания файла (drag-and-drop) в область файлов — при технической возможности используемого клиента.

Автоматическая загрузка из каталога:

• путь к каталогу-источнику задается в настройках;
• сопоставление файла с документом выполняется по имени файла (согласовать маску, например ЧЕК_<номер ФД>_<дата>.pdf или <номер смены>_<номер чека>.pdf);
• загрузка выполняется регламентным заданием с настраиваемым расписанием (например, каждые 10 минут);
• успешно загруженные файлы перемещаются в каталог «Обработано», нераспознанные — в каталог «Ошибки» с записью в журнал (раздел 11);
• повторная обработка одного и того же файла исключается.

Загрузка из внешнего сервиса / драйвера ККТ / личного кабинета ОФД (опционально, при наличии API):

• состав и протокол интеграции описываются отдельным приложением к ТЗ после обследования.

7.3 Пользовательский интерфейс

1. В форме документа «Чек ККМ» добавить:
   • область (закладку) «PDF-копии чеков»;
   • список прикрепленных файлов с колонками: наименование, размер, дата загрузки, автор.
2. Для каждого файла должны быть доступны действия:
   • Просмотр;
   • Скачивание (при наличии права);
   • Удаление (при наличии права, с подтверждением);
   • Изменение комментария.
3. В списке документов «Чеки ККМ» добавить колонку-признак наличия прикрепленного PDF (пиктограмма) и отбор «Есть PDF / Нет PDF» — для контроля полноты загрузки.
4. При работе через РМК (если применимо): предусмотреть возможность открыть PDF последнего чека / чека по выбранной продаже без выхода из режима РМК.

7.4 Просмотр PDF

• Просмотр PDF во встроенном средстве просмотра 1С (поле HTML-документа / штатный просмотр присоединенных файлов БСП) или через приложение ОС, назначенное для PDF, — режим задается настройкой.
• Просмотр должен быть доступен без явного сохранения файла пользователем на диск (временные файлы удаляются автоматически).
• Работа просмотра проверяется во всех используемых клиентах (тонкий / веб-клиент), особенности веб-клиента фиксируются в документации.

7.5 Печать и отправка

• Возможность распечатать PDF-копию чека стандартными средствами.
• (Опционально, раздел 16) Отправка PDF-чека покупателю по e-mail из формы документа с использованием типового механизма отправки почты.

7.6 Первичная (историческая) загрузка

• Разовая обработка для массовой загрузки уже накопленного архива PDF-чеков (указать ориентировочный объем: количество файлов, суммарный размер).
• Правила сопоставления «файл ↔ документ» — те же, что в п. 7.2; по итогам формируется протокол: загружено / не сопоставлено / ошибки.

8. Хранение файлов

Варианты хранения (выбрать один)

Вариант 1. Хранение в информационной базе (реквизит типа ХранилищеЗначения / типовое хранение БСП «в базе»):

• плюсы: файлы гарантированно попадают в бэкап ИБ, не требуется настройка сетевых каталогов;
• минусы: рост размера ИБ (оценить: средний размер чека × количество чеков в день × горизонт хранения), возможное влияние на скорость резервного копирования.

Вариант 2. Хранение в томах хранения файлов (типовой механизм БСП):

• файлы физически размещаются в сетевом каталоге (томе), в ИБ хранятся ссылки и реквизиты;
• плюсы: ИБ не «распухает», удобно масштабировать;
• минусы: том должен быть включен в отдельный контур резервного копирования; требуется контроль доступности каталога с сервера 1С.

Требования независимо от варианта

• Исключить потерю файлов при обновлении конфигурации, реструктуризации, тестировании и исправлении ИБ.
• Файлы (или тома) должны попадать в регламент резервного копирования; порядок бэкапа тома фиксируется в документации.
• Определить срок хранения PDF-чеков (например, не менее 5 лет) и, при необходимости, порядок архивирования старых периодов.
• Оценка объемов (заполняет заказчик): ~____ чеков/день × ____ КБ ≈ ____ ГБ/год.

9. Требования к способу доработки и обновляемости

1. Доработка выполняется через расширение конфигурации; изменение основной конфигурации допускается только по отдельному согласованию, если требуемая функциональность недостижима расширением.
2. Использовать типовые механизмы БСП («Работа с файлами», регламентные задания, роли и группы доступа) везде, где это возможно, — не «изобретать» собственные подсистемы без необходимости.
3. Все добавляемые объекты и код именуются с префиксом (например, абис_ / согласованный префикс заказчика).
4. Решение не должно препятствовать установке типовых обновлений конфигурации; после обновления релиза работоспособность доработки проверяется по чек-листу из раздела 13.
5. Код должен соответствовать «Стандартам разработки 1С» (система стандартов и методик разработки конфигураций фирмы «1С»), включая проверку сервера/клиента, обработку исключений и отсутствие обращений к БД в цикле без необходимости.

10. Права доступа

1. Настроить права (роли в составе расширения):
   • Просмотр PDF-чеков;
   • Добавление PDF;
   • Удаление PDF;
   • Настройка загрузки (каталоги, расписание, маски имен) — только для администратора.
2. Права привязываются к ролям 1С и включаются в профили групп доступа (при использовании БСП).
3. Пользователи без прав не должны видеть файлы, открывать их, выгружать или удалять; кнопки/команды для них скрываются или блокируются.
4. Согласовать матрицу доступа по ролям, например:

11. Логирование и контроль

• Фиксировать: дату/время и пользователя загрузки PDF, факт удаления файла (кто, когда, какой файл, к какому документу), результат работы регламентного задания автозагрузки (успех/ошибки, количество файлов).
• Записи ведутся в журнал регистрации (с понятным представлением событий) и/или в отдельный регистр сведений — согласовать.
• Ошибки автозагрузки должны быть доступны для просмотра ответственному пользователю (отчет или список «Ошибки загрузки чеков»); опционально — уведомление на e-mail администратору.

12. Нефункциональные требования

• Доработка не должна заметно снижать производительность проведения и открытия кассовых чеков; открытие формы документа без обращения к содержимому файлов (содержимое читается только при просмотре/скачивании).
• Поддержка многопользовательского режима и клиент-серверного варианта работы.
• Автозагрузка выполняется на сервере и не блокирует работу пользователей.
• Корректная работа при недоступности каталога тома/источника: понятная диагностика, отсутствие «падений» и зависших фоновых заданий.
• Совместимость с используемой версией платформы и режимом совместимости конфигурации.

13. Тестирование и приемка

Сценарии тестирования (минимальный набор)

1. Ручное прикрепление PDF к чеку, просмотр, скачивание, удаление — под ролью с полными правами.
2. Попытка загрузки файла не-PDF и файла сверх лимита размера — корректный отказ.
3. Проверка ограничений: под ролью «Бухгалтер» удаление недоступно; под ролью без прав файлы не видны.
4. Автозагрузка из каталога: корректный файл сопоставлен и прикреплен; файл с «неправильным» именем ушел в «Ошибки» с записью в журнал; повторная обработка не создает дублей.
5. Одновременная работа нескольких пользователей с одним документом — отсутствие блокировок и потери файлов.
6. Перезапуск сервера 1С / рабочего процесса — файлы доступны, ничего не потеряно.
7. Резервное копирование и восстановление тестовой копии — файлы на месте (для варианта с томами — включая том).
8. Установка типового обновления конфигурации на тестовой базе — доработка работоспособна (чек-лист пунктов 1–4).

Критерии приемки

• Все сценарии из перечня выполняются без ошибок на копии рабочей базы.
• Замечания, выявленные при приемке, устранены.
• Передана документация (раздел 14).
• Подписан акт сдачи-приемки.

Порядок приемки

1. Исполнитель разворачивает доработку на тестовой копии рабочей базы.
2. Заказчик проводит приемочное тестирование в течение ___ рабочих дней.
3. После устранения замечаний доработка переносится в рабочую базу в согласованное время (вне часов пиковой нагрузки), выполняется контрольная проверка.

14. Документация

Исполнитель обязан передать:

• описание внесенных изменений (перечень объектов расширения, назначение, схема сопоставления файлов при автозагрузке);
• инструкцию администратора: настройка каталогов/томов, расписания регламентного задания, назначение прав, порядок действий при обновлении конфигурации, порядок резервного копирования;
• краткую инструкцию пользователя (1–2 страницы со скриншотами): как прикрепить, посмотреть, найти чеки без PDF;
• исходный код (файл расширения .cfe) и, при наличии, выгрузку в хранилище/репозиторий заказчика.

15. Сроки, этапы и стоимость

Стоимость и порядок оплаты: (фиксированная / по часам, ставка ___ руб./час, порядок оплаты этапов).

Гарантийные обязательства: исправление ошибок, выявленных в течение ___ (например, 30) календарных дней после подписания акта, — без дополнительной оплаты. Доработки сверх настоящего ТЗ оформляются дополнительным соглашением.

16. Возможные расширения (вне объема настоящего ТЗ, по желанию)

• Автоматическое формирование PDF-чека из данных документа (печатная форма → PDF) при отсутствии файла от ККТ/ОФД.
• Отправка PDF-чека клиенту по e-mail или в мессенджер.
• Интеграция с личным кабинетом ОФД для автоматического получения чеков по API.
• Полнотекстовый поиск по реквизитам чеков и быстрый поиск файла по номеру фискального документа.
• Автоматическая очистка/архивирование PDF старше заданного срока.

17. Порядок согласования ТЗ

Настоящее ТЗ считается согласованным после подписания обеими сторонами (или подтверждения по e-mail уполномоченными лицами). Изменения в согласованное ТЗ оформляются в письменном виде и могут влиять на сроки и стоимость.

От Заказчика: ____________ /____________/
От Исполнителя: ____________ /____________/

Как пользоваться этим шаблоном

1. Удалите неприменимые варианты (например, оставьте один способ хранения файлов из раздела 8).
2. Заполните конкретику: конфигурацию и релиз, объемы, маску имен файлов, матрицу прав, сроки.
3. Чем точнее описаны критерии приемки (раздел 13), тем меньше споров при сдаче работы.
4. Если конфигурация нетиповая — обязательно оставляйте этап обследования: он экономит и время, и деньги.

Нужна помощь с составлением ТЗ или самой доработкой 1С? Обращайтесь — подготовим задание, оценим сроки и выполним работу «под ключ».