Настройка переменной REPORT_INFO_MESSAGE#

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

Содержание:

Описание
Синтаксис
Поддерживаемые переменные
Разделение текста на одной строке
Приоритет замены переменных

Описание#

Переменная окружения REPORT_INFO_MESSAGE позволяет настроить текст служебной информации, отображаемой в PDF-отчётах.

В строке поддерживаются:

подстановка переменных
выравнивание текста
отступы
HTML-разметка

Синтаксис#

Переменные подставляются в формате:

{VARIABLE_NAME}

Например:

Страница {pageNumber} из {totalPages}

Каждая строка может содержать директивы форматирования.

Поддерживаемые переменные#

Специальные переменные#

Переменная	Описание
`{pageNumber}`	номер текущей страницы
`{totalPages}`	общее количество страниц

Переменные окружения#

Любая переменная окружения может быть использована в формате {VARIABLE_NAME}.

Предустановленные переменные#

Переменная	Значение по умолчанию
`COMPANY_NAME`	ООО Цифровые технологии
`WEBSITE_URL`	www.cryptoarm.ru

Переменные для настройки PDF-отчетов#

Переменная	Описание	Значение по умолчанию
`REPORT_TITLE`	заголовок PDF-отчёта	`Отчет о проверке электронной подписи`
`DATA_STAMP_TITLE`	текст штампа на подписанном документе	`Документ подписан электронной подписью`
`STAMP_COLOR`	цвет штампа (HEX)	`#4c40d2`

Переменные для настройки TSP-сервиса#

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

Переменная	Описание	Значение по умолчанию
`TSP_SERVICE_ADDRESS`	адрес сервиса TSP	`http://qs.cryptopro.ru/tsp/tsp.srf`

Директивы форматирования#

Выравнивание#

Директива	Описание
`{align:left}`	выравнивание по левому краю (по умолчанию)
`{align:center}`	выравнивание по центру
`{align:right}`	выравнивание по правому краю
`{align:justify}`	выравнивание по ширине (пока работает как `left`)

Директива должна располагаться в начале строки.

Отступы#

Можно задавать отступы от краёв страницы.

Директива	Описание
`{left-margin:N}`	отступ слева (в пикселях)
`{right-margin:N}`	отступ справа (в пикселях)

Директивы отступов можно комбинировать с директивами выравнивания на одной строке.

Разделение текста на одной строке#

Для размещения текста слева и справа в одной строке используется разделитель:

||

Пример:

REPORT_INFO_MESSAGE="{left-margin:50}{align:left}Текст слева || {right-margin:50}{align:right}Текст справа"

Это создаст эффект: Текст слева Текст справа

Примеры использования#

Базовый пример#

REPORT_INFO_MESSAGE="© Цифровые технологии 
Страница {pageNumber} из {totalPages} 
www.cryptoarm.ru"

С использованием переменных окружения#

# Установка переменных окружения (опционально)
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"

С выравниванием текста#

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}"

Приоритет замены переменных#

Подстановка выполняется в следующем порядке:

Специальные переменные
Переменные окружения

Если переменная не найдена, текст остаётся без изменений.

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#

Все директивы можно комбинировать:

REPORT_INFO_MESSAGE="{align:center}© {COMPANY_NAME}
{left-margin:50}{align:left}© {COMPANY_NAME}
{right-margin:50}{align:right}Страница {pageNumber} из {totalPages}
{align:center}<a href='{WEBSITE_URL}'>Сайт компании</a>"