Установка и настройка КриптоАРМ Документы для 1С-Битрикс#

В этом руководстве вы узнаете, как установить и настроить решения КриптоАРМ Документы для CMS 1С-Битрикс, включая подключение и конфигурацию дополнительных модулей:

• КриптоАРМ Документы: заказы — интеграция электронных документов с заказами интернет-магазина;
• КриптоАРМ Документы: формы — формирование и отправка комплектов документов по формам;
• пользовательских компонентов для загрузки, подписи и управления документами на сайте.

Руководство ориентировано на администраторов сайтов и специалистов, выполняющих внедрение КриптоАРМ Документы.

Содержание:

• Установка базового модуля КриптоАРМ Документы
• Настройка базового модуля КриптоАРМ Документы
• Дополнительные модули и расширения
• Компоненты

⚠️ Важно:

• Функции Подпись и Проверка подписи выполняются через программное обеспечение КриптоАРМ версии 6.2 и выше, установленное на рабочем месте пользователя.
• Для работы с алгоритмами ГОСТ требуется установленный криптопровайдер КриптоПРО CSP.
• Сайт должен работать по защищённому протоколу HTTPS.

Установка базового модуля КриптоАРМ Документы#

Установка через Marketplace#

Модуль устанавливается стандартными средствами Marketplace 1С-Битрикс.

Чтобы выполнить установку:

1. Откройте ваш сайт и войдите в административную часть → вкладка Администрирование.

2. В главном меню административной панели наведите курсор на раздел Marketplace и выберите пункт Каталог решений.

   

3. В форме поиска наберите название модуля КриптоАРМ Документы.

   

4. Выберите режим:

   • Тестировать — установка в демо-режиме на 30 дней.
   • Купить — установка полной версии.

   

   Система предложит ознакомиться с информацией — нажмите Загрузить. После загрузки примите лицензионное соглашение, нажав Применить.

5. После загрузки модуля откройте Marketplace → Установленные решения

   

6. Вызовите контекстное меню в строке с модулем и выберите пункт контекстного меню Установить.

   

Повторная установка#

Если ранее модуль удалялся без удаления таблиц, система обнаружит существующие данные.

Администратору будет предложено:

• Использовать старые данные — продолжить работу с ранее загруженными документами.
• Перезаписать таблицы — удалить все данные и создать таблицы заново.

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

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

Удаление модуля КриптоАРМ Документы#

Для удаления модуля КриптоАРМ Документы:

1. Перейдите на вкладку Администрирование.
2. Выберите пункт Marketplace.
3. Выберите подпункт Установленные решения.
4. Найдите в списке установленных решений модуль КриптоАРМ Документы для 1С-Битрикс.

5. Вызовите контекстное меню в строке с модулем.

   

6. Выберите действие Удалить. Будет выведено предупреждение и запрос на подтверждение удаления.

7. В открывшемся диалоговом окне нажмите кнопку Удалить модуль.
8. При необходимости установите флаг Удалить таблицы для удаления всех пользовательских данных, связанных с загруженными и подписанными документами всеми пользователями данного решения. После удаления таблиц восстановить эти данные будет невозможно.

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

После этого удаление модуля будет завершено.

Настройка базового модуля КриптоАРМ Документы#

Настройка модуля КриптоАРМ Документы осуществляется в разделе настроек административной части интерфейса сайта.

Как открыть настройки модуля#

Чтобы попасть на страницу настроек модуля КриптоАРМ Документы:

1. Войдите в административную часть → вкладка Администрирование.
2. Зайдите в раздел Настройки.
3. Выберите Настройки продукта → Настройки модулей.
4. В выпадающем меню перейдите в Настройки продукта, а затем выберите Настройки модулей.
5. Выберите модуль КриптоАРМ Документы из списка.

Общие настройки#

1. Откройте настройки модуля (см. Как открыть настройки модуля).

2. Перейдите на вкладку Настройки и укажите:

   • Директорию для хранения документов — папку для загрузки новых документов. Директория указывается относительно корня сайта. Стандартное значение — директории /docs/. Данная директория автоматически создается при установке модуля. Для изменения директории хранения документов нажмите на кнопку Выбрать директорию.
   • Тип подписи — вариант подписи, который будет создан с помощью приложения КриптоАРМ. Существует два типа подписи: совмещенная и открепленная. При совмещенной подписи, все изменения будут производиться в оригинальном документе. При открепленной - будет создаваться файл с подписью, оригинальный документ будет без изменений.
   • Выберите Почтовое событие и укажите Почтовый шаблон — для настройки рассылки уведомлений пользователям.

Настройки одноразовых лицензий для подписи#

Модуль поддерживает выдачу пользователям одноразовых лицензий для подписи документов через приложение КриптоАРМ. Это позволяет пользователям подписывать документы в приложении КриптоАРМ без установки лицензии на это приложение.

Чтобы активировать выдачу одноразовых лицензий:

1. Откройте настройки модуля (см. Как открыть настройки модуля).
2. Перейдите на вкладку Предоставление лицензий.
3. Активируйте чекбокс Включить предоставление пользователям одноразовых лицензий на подпись документов.
4. После активации сформируйте номер счета по кнопке Получить.

5. В поле Номер счета появляется сгенерированная последовательность из 16 символов.

   🔍 Номер счета — это цифровой идентификатор состоящий из 16 символов. Идентификатор счета используется для удобства пользования активной лицензией. В случае наличия номера счета в поле, при активации лицензии, происходит привязка лицензии к текущему номеру.

6. Вставьте лицензионный ключ в поле Активировать лицензию на счет и нажмите кнопку Активировать.

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

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

Журнал операций#

Модуль КриптоАРМ Документы осуществляет логирование основных операций с документами.

Журнал операций находится в настройках модуля на вкладке Журнал.

Модуль сохраняет дату и время основных операций над документами, такие как:

• Создание документа
• Подпись документа
• Удаление документа

В интерфейсе настроек модуля отображается 100 последних записей об операциях из журнала. Кнопка Скачать полный журнал операций позволяет получить текстовый файл со всеми записями о произведенных операциях. Там же расположена кнопка Удалить журнал, позволяющая очистить все записи.

Дополнительные модули и расширения#

Модуль «КриптоАРМ Документы: заказы»#

⚠️ Примечание: Доступно в редакциях Бизнес и Корпоративный портал при установленном модуле КриптоАРМ Документы: заказы.

Модуль КриптоАРМ Документы позволяет привязывать документы к заказам в интернет-магазине 1C-Битрикс.

Установка модуля «КриптоАРМ Документы: заказы»#

Модуль КриптоАРМ Документы: заказы входит в версии КриптоАРМ Документы. Бизнес и КриптоАРМ Документы. Корпоративный портал.

Установка модуля происходит автоматически, на этапе инсталляции основного модуля КриптоАРМ Документы.

Чтобы установить модуль КриптоАРМ Документы: заказы вручную:

1. Перейдите на вкладку Администрирование.
2. Выберите пункт Marketplace.
3. Выберите подпункт Установленные решения.
4. Убедитесь, что модуль КриптоАРМ Документы: заказы присутствует в списке модулей, готовых к установке.
5. Вызовите контекстное меню в строке с наименованием модуля и выберите действие Установить.

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

Настройка модуля «КриптоАРМ Документы: заказы»#

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

Заказ, к которому был прикреплен документ, можно автоматически переводить в другой статус при совершении операций с документами.

Напротив каждого события находится поле-список, содержащий все возможные статусы, в которых может находиться заказ в интернет-магазине. На каждое событие можно выбрать свой статус, в который должен будет перейти заказ.

Так как к одному заказу может быть прикреплено несколько документов, у всех событий, связанных с подписью имеется дополнительная настройка Ждать подписи всех прикрепленных документов. Когда она включена, перевод заказа в другой статус произойдет только когда ко всем документам прикрепленным к заказу будет применимо указанное событие.

Настройки модуля позволяют менять статус заказа не только в зависимости от наличия подписи у документа продавца и (или) покупателя, но и от событий связанных с отправкой и прочтением письма с приложенными документами покупателем.

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

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

Удаление модуля «КриптоАРМ Документы: заказы»#

Модуль КриптоАРМ Документы: заказы удаляется стандартными средствами 1С-Битрикс.

Чтобы удалить модуль:

1. Перейдите на вкладку Администрирование.
2. Выберите пункт Marketplace.
3. Выберите подпункт Установленные решения.
4. Убедитесь, что модуль КриптоАРМ Документы: заказы присутствует в списке модулей, готовых к установке.
5. Вызовите контекстное меню в строке с наименованием модуля и выберите действие Удалить.
6. Подтвердите действие в модальном окне.

Модуль КриптоАРМ Документы: формы#

⚠️ Примечание: Доступно при установленном модуле «КриптоАРМ Документы: формы».

Установка модуля «КриптоАРМ Документы: формы»#

Установка модуля происходит автоматически на этапе инсталляции основного модуля КриптоАРМ Документы.

Чтобы установить модуль КриптоАРМ Документы: формы вручную:

1. Перейдите на вкладку Администрирование.
2. Выберите пункт Marketplace.
3. Выберите подпункт Установленные решения.
4. Убедитесь, что модуль КриптоАРМ Документы: формы присутствует в списке модулей, готовых к установке.
5. Вызовите контекстное меню в строке с наименованием модуля и выберите действие Установить.

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

Настройки модуля «КриптоАРМ Документы: формы»#

На вкладке Формы расположены настройки связанные с формированием и отправкой форм на электронные почтовые ящики, а также настройки для reCAPTCHA, используемой в формах.

В верхней части представлены поля для выбора почтовых событий и соответствующих им шаблонов, служащие для настройки рассылки писем и уведомлений с документами по формам.

Данные настройки имеют подсказки на случай корректировки шаблонов отправки писем при наличии такой необходимости.

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

Удаление модуля «КриптоАРМ Документы: формы»#

Модуль КриптоАРМ Документы: формы удаляется стандартными средствами 1С-Битрикс. Для удаления модуля следует:

Чтобы удалить модуль:

1. Перейдите на вкладку Администрирование.
2. Выберите пункт Marketplace.
3. Выберите подпункт Установленные решения.
4. Убедитесь, что модуль КриптоАРМ Документы: формы присутствует в списке модулей, готовых к установке.
5. Вызовите контекстное меню в строке с наименованием модуля и выберите действие Удалить.
6. В окне подтверждения при необходимости установите флаг **Удалить инфоблоки**для удаления пользовательских данных, включая созданные или импортированные инфоблоки и сформированные на их основе формы.

Компоненты#

Компонент «Документы пользователя»#

Компонент Документы пользователя устанавливается стандартными средствами 1С-Битрикс при наличии установленного модуля КриптоАРМ Документы для 1С-Битрикс.

Установка компонента «Документы пользователя»#

Чтобы выполнить установку компонента:

1. В разделе Сайт перейдите на страницу, на которой требуется разместить данный компонент.
2. Выберите пункт меню Изменить страницу.
3. В окне редактирования страницы откройте группу компонентов КриптоАРМ Документы для отображения блока Документы пользователя.
4. Перетащите блок Документы пользователя в область редактирования страницы.
5. Сохраните изменения.

Настройка компонента «Документы пользователя»#

Чтобы настроить компонент Документы пользователя:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя.
4. Выберите пункт контекстного меню Параметры компонента.

5. В результате откроется форма настроек компонента.

   • В группе основных настроек компонента можно указать доступные действия для пользователя: добавление и удаление файлов в компоненте, а также отображение в компоненте документов, имеющие привязку к заказам пользователя.
   • В группе настроек управления режимом AJAX доступна активация режима, позволяющего отслеживать изменения в состоянии компонента без перезагрузки страницы.

6. Для завершения настройки компонента нажмите Сохранить в окне параметров компонента и в окне редактирования страницы.

Удаление компонента «Документы пользователя»#

Чтобы удалить компонент Документы пользователя:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя.
4. Выберите пункт контекстного меню Удалить компонент.
5. Нажмите Сохранить в окне параметров компонента и в окне редактирования страницы.

Компонент «Документы пользователя по заказам»#

Установка компонента «Документы пользователя по заказам»#

Компонент Документы пользователя по заказам устанавливается стандартными средствами 1С-Битрикс при условии наличия модуля КриптоАРМ Документы: заказы.

Чтобы выполнить установку компонента:

1. В разделе Сайт перейдите на страницу, на которой требуется разместить данный компонент.
2. Выберите пункт меню Изменить страницу.
3. В окне редактирования страницы откройте группу компонентов КриптоАРМ Документы для отображения блока Документы пользователя.
4. Перетащите блок Документы пользователя по заказам в область редактирования страницы.
5. Сохраните изменения.

Настройка компонента «Документы пользователя по заказам»#

Включение режима AJAX#

💡 Режим AJAX активируйте режим позволяет отслеживать изменения в состоянии компонента без перезагрузки страницы.

Для настройки режима AJAX в компоненте необходимо:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя по заказам.
4. Выберите пункт контекстного меню Параметры компонента.
5. В результате откроется форма настроек компонента.
6. Активируйте режим в группе настроек управления режимом AJAX.
7. Сохраните изменения.

Добавление номера заказа#

Чтобы указать номера заказа в компоненте:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя по заказам.
4. Выберите пункт контекстного меню Параметры компонента.
5. В результате откроется форма настроек компонента.
6. Нажмите на кнопку выбора визуального режима отображения страницы → Совмещенный режим.
7. Добавьте в коде компонента в массив строку вида "ORDER"=>"N", где N-цифровое обозначение номера заказа, документы которого будут отображаться в компоненте.
8. Сохраните изменения.

Установка на страницу подробной информации о заказе#

1. Перейдите на страницу подробной информации о любом заказе:

   • Нажмите на имя пользователя в правом верхнем углу,
   • Выберите пункт меню Текущие заказы,
   • Нажмите на ссылку Подробнее о заказе.

2. Активируйте опцию на панели администратора Режим правки включен.

3. Наведите курсор на область заказа и вызовите меню действий.
4. Выберите пункт Подробная информация о заказе → Редактировать шаблон компонента.

5. В окне Редактирование файла внутри компонента Подробная информация о заказе вставьте код вызова компонента, где $arResult["ACCOUNT_NUMBER"] — переменная, хранящая номер заказа.

   # Пример вызова компонента «Документы по заказу»
   <?$APPLICATION->IncludeComponent(
   "trusted:cryptoarm_docs_by_order",
   "",
   Array(
   "ORDER" => $arResult["ACCOUNT_NUMBER"]
   )
   );?>
   

   Данный код вставляется в конце последнего закрывающего div перед div классом row sale-order-detail-total-payment.

6. Сохраните изменения.

Теперь компонент Документы пользователя по заказам будет представлен в любом заказе пользователя.

⚠️ Примечание: при первом вызове окна редактирования файла откроется диалог копирования шаблона компонента. В этом случае, для открытия окна редактирования файла, будет достаточно нажать кнопку Сохранить в открывшемся окне диалога.

Удаление компонента «Документы пользователя по заказам»#

Чтобы выполнить удаление компонента:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя по заказам.
4. Выберите пункт контекстного меню Удалить компонент.
5. Сохраните изменения.

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

1. Перейдите на страницу подробной информации о любом заказе:

   • Нажмите на имя пользователя в правом верхнем углу,
   • Выберите пункт меню Текущие заказы,
   • Нажмите на ссылку Подробнее о заказе.

2. Активируйте опцию на панели администратора Режим правки включен.

3. Наведите курсор на область заказа и вызовите меню действий.
4. Выберите пункт Подробная информация о заказе → Редактировать шаблон компонента.

5. В окне Редактирование файла внутри компонента Подробная информация о заказе удалите ранее размещенный код вызова компонента.

   ⚠️ Данный код размещен в конце последнего закрывающего div перед div классом row sale-order-detail-total-payment.

6. Сохраните изменения.

Компонент «Создание комплекта документов по форме»#

Установка компонента «Создание комплекта документов по форме»#

Компонент Создание комплекта документов по форме устанавливается стандартными средствами 1С-Битрикс при условии наличия модуля КриптоАРМ Документы: формы.

Чтобы выполнить установку компонента:

1. В разделе Сайт перейдите на страницу, на которой требуется разместить данный компонент.
2. Выберите пункт меню Изменить страницу.
3. В окне редактирования страницы откройте группу компонентов КриптоАРМ Документы для отображения блока Документы пользователя.
4. Перетащите блок Создание комплекта документов по форме в область редактирования страницы.
5. Сохраните изменения.

Настройка компонента «Создание комплекта документов по форме»#

Чтобы настроить компонент Создание комплекта документов по форме:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя.
4. Выберите пункт контекстного меню Параметры компонента.

5. В результате откроется форма настроек компонента:

   • в поле Выберите правильный инфоблок eукжите наименование ранее созданного/импортированного инфоблока для отображения формы на странице. В противном случае на странице будет выдана ошибка: "ERROR iblock not specified".
   • установите флаг Отправлять пользователю заполненную форму и прикрепленные документы для отправки формы и прикрепленных к ней документов на адрес электронной почты пользователя, указанный в его профиле на сайте.
   • укажите Дополнительный адрес для отправки заполненной формы и прикрепленных документов для отправки письма с заполненной формой и прикрепленными документами на указанный ящик электронной почты.
   • установите флаг Включить reCAPTCHA для защиты от ботов. Для корректного функционирования формы в данном случае потребуется заполнить соответствующие поля в настройках модуля.

   💡 В поле Формат сохранения документа по умолчанию выбрано значение PDF. В данном формате формируется заполненная пользователем форма. В данный момент иные форматы вывода заполненной формы не предусмотрены.

6. Сохраните изменения.

Удаление компонента «Создание комплекта документов по форме»#

Чтобы удалить компонент Создание комплекта документов по форме:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Создание комплекта документов по форме.
4. Выберите пункт контекстного меню Удалить компонент.
5. Нажмите Сохранить в окне параметров компонента и в окне редактирования страницы.

Компонент «Документы пользователя по формам»#

Установка компонента «Документы пользователя по формам»#

Компонент Документы пользователя по формам устанавливается стандартными средствами 1С-Битрикс при условии наличия модуля КриптоАРМ Документы: формы.

Чтобы выполнить установку компонента:

1. В разделе Сайт перейдите на страницу, на которой требуется разместить данный компонент.
2. Выберите пункт меню Изменить страницу.
3. В окне редактирования страницы откройте группу компонентов КриптоАРМ Документы для отображения блока Документы пользователя.
4. Перетащите блок Документы пользователя по формам в область редактирования страницы.
5. Сохраните изменения.

Настройка компонента «Документы пользователя по формам»#

Чтобы настроить компонент Создание комплекта документов по форме:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя по формам.
4. Выберите пункт контекстного меню Параметры компонента.

5. В результате откроется форма настроек компонента:

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

6. Сохраните изменения.

Удаление компонента «Документы пользователя по формам»#

Чтобы удалить компонент Создание комплекта документов по форме:

1. В разделе Сайт перейдите на страницу, на которой размещен компонент.
2. Выберите пункт меню Изменить страницу.
3. Кликните правой кнопкой мыши по блоку Документы пользователя по формам.
4. Выберите пункт контекстного меню Удалить компонент.
5. Нажмите Сохранить в окне параметров компонента и в окне редактирования страницы.

Смотрите также#

• Руководство администратора модуля КриптоАРМ Документы
• Руководство пользователя модуля КриптоАРМ Документы
• Руководство разработчика модуля КриптоАРМ Документы