Настройка переменной REPORT_INFO_MESSAGE#
- Описание
- Поддерживаемые переменные
- Поддерживаемые директивы выравнивания
- Поддерживаемые директивы отступов
- Разделитель для одной строки
- Примеры использования
- Приоритет замены
- HTML-поддержка
- Комбинирование выравнивания и HTML
- Комбинирование отступов, выравнивания и HTML
Описание#
В переменной окружения REPORT_INFO_MESSAGE поддерживается замена переменных в формате {VARIABLE_NAME} и выравнивание текста с помощью директив {align:direction}.
Поддерживаемые переменные#
Специальные переменные#
{pageNumber}- номер текущей страницы{totalPages}- общее количество страниц
Переменные окружения#
Любая переменная окружения может быть использована в формате {VARIABLE_NAME}.
Предустановленные переменные:#
{COMPANY_NAME}- название компании (по умолчанию: "ООО Цифровые технологии"){WEBSITE_URL}- URL сайта компании (по умолчанию: "www.cryptoarm.ru")
Переменные для настройки PDF-отчетов:#
REPORT_TITLE- заголовок PDF-отчета (по умолчанию: "Отчет о проверке электронной подписи")DATA_STAMP_TITLE- заголовок штампа на подписанном документе (по умолчанию: "Документ подписан электронной подписью")STAMP_COLOR- цвет штампа в формате HEX (по умолчанию: "#4c40d2")
Переменные для настройки TSP-сервиса:#
TSP_SERVICE_ADDRESS- адрес сервиса штампов времени (по умолчанию: "http://qs.cryptopro.ru/tsp/tsp.srf")
Поддерживаемые директивы выравнивания#
{align:left}- выравнивание по левому краю (по умолчанию){align:center}- выравнивание по центру{align:right}- выравнивание по правому краю{align:justify}- выравнивание по ширине (пока работает как left)
Поддерживаемые директивы отступов#
{left-margin:N}- отступ слева в пикселях (N - число){right-margin:N}- отступ справа в пикселях (N - число)
Директивы отступов можно комбинировать с директивами выравнивания на одной строке.
Разделитель для одной строки#
Используйте || для разделения строки на левую и правую части:
REPORT_INFO_MESSAGE="{left-margin:50}{align:left}Текст слева || {right-margin:50}{align:right}Текст справа"
Это создаст эффект: Текст слева Текст справа
Примеры использования#
Базовый пример#
С использованием переменных окружения#
# Установка переменных окружения (опционально)
COMPANY_NAME="ООО Цифровые технологии"
WEBSITE_URL="www.cryptoarm.ru"
# Использование в REPORT_INFO_MESSAGE
REPORT_INFO_MESSAGE="© {COMPANY_NAME}
Страница {pageNumber} из {totalPages}
{WEBSITE_URL}"
Примечание: Переменные COMPANY_NAME и WEBSITE_URL имеют значения по умолчанию, поэтому их установка необязательна.
Настройка PDF-отчетов#
# Настройка заголовков и цветов
REPORT_TITLE="Отчет о проверке подписи"
DATA_STAMP_TITLE="Документ подписан"
STAMP_COLOR="#0066cc"
# Использование в REPORT_INFO_MESSAGE
REPORT_INFO_MESSAGE="© {COMPANY_NAME}\nСтраница {pageNumber} из {totalPages}\n{WEBSITE_URL}"
# Настройка TSP-сервиса
TSP_SERVICE_ADDRESS="http://your-tsp-server.com/tsp/tsp.srf"
Описание переменных PDF-отчетов:
REPORT_TITLE- отображается в верхней части PDF-отчета как главный заголовокDATA_STAMP_TITLE- отображается в штампе на подписанном документеSTAMP_COLOR- используется для цвета рамки и текста штампа (формат HEX: #RRGGBB)
Описание переменных TSP-сервиса:
TSP_SERVICE_ADDRESS- используется для подключения к сервису штампов времени при создании расширенных подписей (CAdES-BES, CAdES-T, CAdES-C, CAdES-X-Long)
С выравниванием текста#
REPORT_INFO_MESSAGE="{align:center}© Цифровые технологии
{align:left}Страница {pageNumber} из {totalPages}
{align:right}www.cryptoarm.ru"
С отступами и выравниванием#
# Разделенные строки
REPORT_INFO_MESSAGE="{align:center}© Цифровые технологии
{left-margin:50}{align:left}© ООО Цифровые технологии
{right-margin:50}{align:right}Страница {pageNumber} из {totalPages}"
# Одна строка с разделителем ||
REPORT_INFO_MESSAGE="{left-margin:50}{align:left}© ООО Цифровые технологии || {right-margin:50}{align:right}Страница {pageNumber} из {totalPages}"
Примечание: Директивы должны быть в начале строки. Для создания эффекта "текст слева, текст справа" используйте разделитель || в одной строке.
С дополнительной информацией и выравниванием#
# Дополнительные переменные окружения
VERSION="1.0.0"
BUILD_DATE="2024-01-01"
# Использование в REPORT_INFO_MESSAGE
REPORT_INFO_MESSAGE="{align:center}© {COMPANY_NAME}
{align:left}Страница {pageNumber} из {totalPages}
Версия: {VERSION} | Сборка: {BUILD_DATE}
{align:right}{WEBSITE_URL}"
Приоритет замены#
- Специальные переменные (
pageNumber,totalPages) - Переменные окружения
- Если переменная не найдена, текст остается без изменений
HTML-поддержка#
Переменные поддерживаются внутри HTML-тегов:
REPORT_INFO_MESSAGE="© {COMPANY_NAME}
Страница {pageNumber} из {totalPages}
<a href='{WEBSITE_URL}'>Сайт компании</a>"
Комбинирование выравнивания и HTML#
Директивы выравнивания можно комбинировать с HTML-тегами:
REPORT_INFO_MESSAGE="{align:center}© {COMPANY_NAME}
{align:left}Страница {pageNumber} из {totalPages}
{align:right}<a href='{WEBSITE_URL}'>Сайт компании</a>"
Комбинирование отступов, выравнивания и HTML#
Все директивы можно комбинировать: