Приложение 4. Командные строки запуска компонентов системы и описание дополнительных утилит

Утилита предназначена для автономной проверки и исправления файлов базы данных.

Данная утилита предназначена для работы только с файловой базой данных. Утилита доступна только в 32-разрядном варианте. Файловая база данных используется:

● для хранения информационной базы в файловом варианте;

● хранения хранилища конфигурации.

Для запуска утилиты в каталоге установки системы «1С:Предприятие» нужно запустить приложение chdbfl. На экран выводится окно (см. рис. 97).

Рис. 97. Утилита тестирования и исправления информационных баз

В поле Имя файла БД указать или выбрать имя файла информационной базы.

Установить флажок Исправлять обнаруженные ошибки, если требуется исправлять обнаруженные при проверке ошибки. Также этот флажок следует установить, если необходимо выполнить оптимизацию размещения служебной информации, ускоряющей открытие информационной базы (см. здесь).

Для начала работы утилиты нужно нажать кнопку Выполнить. К этому моменту выбранная информационная база не должна быть открыта конфигуратором или в режиме 1С:Предприятие.

Сообщения о найденных ошибках выводятся в текстовое поле.

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

Также эта утилита может использоваться и для проверки хранилища конфигурации.

Рекомендуется использовать следующую последовательность шагов при использовании утилиты:

● Обязательно создать резервную копию файла базы данных.

● Выполнить тестирование без установленного флажка Исправлять обнаруженные ошибки.

● Если при тестировании не выявлено проблем, то можно выполнить тестирование с установленным флажком Исправлять обнаруженные ошибки ‑ при этом будет выполнена операция реиндексации информационной базы или информационной базы хранилища. Такую операцию рекомендуется выполнять регулярно.

● Если при тестировании обнаружены проблемы, то попытаться выполнить исправление информационной базы. Если в процессе работы утилита сообщила о том, что какие-либо данные потеряны, то работать с такой информационной базой не рекомендуется. Из получившейся информационной базы можно:

● получить сохранившиеся данные и конфигурацию для создания на их основе новой информационной базы;

● получить последнюю версию конфигурации, на основании которой создать другое хранилище.

Утилита контроля целостности (ci) предназначена для контроля состояния объектов файловой системы и базы данных, используемых при работе «1С:Предприятие», и обнаружения ситуации изменения этих объектов. Для определения факта неизменности объекта используется сравнение хеш-сумм контролируемых объектов (объектов контроля), которые вычислены по алгоритму SHA-1 (алгоритм криптографического хеширования). Процесс проверки состоит из формирования эталонных значений хеш-сумм и последующей регулярной проверки.

Утилита работает со следующими объектами контроля:

● Файлы, расположенные в файловой системе;

● Некоторые таблицы базы данных системы «1С:Предприятие».

Списки объектов контроля для работы утилиты задаются с помощью шаблона источника информации. Шаблон источника информации описывается универсальным описателем источника информации (см. здесь). Такие шаблоны могут указываться в командной строке запуска утилиты непосредственно или как содержимое файла, указанного в качестве значения параметра in (см. здесь). Такой файл будет называться списком шаблонов (см. здесь).

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

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

При необходимости указания для контроля одновременно нескольких объектов контроля (или набора объектов) можно использовать специальный файл ‑ список шаблон источников информации. Каждая строка в этом файле содержит шаблон источника информации. Количество строк в файле не ограничено. Подробное описание формата шаблона источника информации см. здесь. Комментарий начинается с символа "#". Строка комментария, а также пустые строки и строки, состоящие из одних пробелов, игнорируется при формировании списка объектов контроля.

Файл списка шаблонов должен быть только в кодировке UTF-8.

Примеры универсальных описателей источников информации:

# объект контроля - файл /tmp/vokas/spru.cvs
file:///tmp/vokas/spru.cvs
# объект контроля - все файлы в каталоге c:\Program Files\1cv8\8.3.4.408\bin
rdir://c:\Program Files\1cv8\8.3.4.408\bin
# объект контроля - все файлы .rc и .cfg в каталоге /home/user/.kde и подчиненных каталогах
rdir:///home/user/.kde?*.rc,*.cfg
# объект контроля - все файлы, начинающиеся с "V8" файлы в каталоге /tmp, без подкаталогов
ndir:///tmp?V8*.txt
# объект контроля - все поддерживаемые таблицы в базе данных, расположенной на MS SQL Server
mssql://user:password@server/instance/dbname
# объект контроля - таблицы users и config на сервер PostrgeSQL
postgre://user:password@server:123/dbname?users,config
# объект контроля - таблицы users в файловой базе данных
dbe://c:\DB\checked_db?users

Для описания объекта контроля используется специальный формат ‑ универсальный описатель источника информации. В общем виде универсальный описатель источника информации выглядит следующим образом:

proto://[user:[password]@][server[:port]][/path/resource][?mask]

Подробнее рассмотрим каждую составную часть описателя:

● proto ‑ описание типа объекта контроля. В качестве способа работы могут выступать:

● file ‑ отдельный файл в файловой системе;

● ndir ‑ файлы, расположенные в каталоге (без обхода подкаталогов);

● rdir ‑ файлы, расположенные в каталоге и всех вложенных каталогах;

● mssql ‑ база данных, расположенная в СУБД Microsoft SQL Server;

● ora ‑ база данных, расположенная в СУБД Oracle Database;

● postgre ‑ база данных, расположенная в СУБД PostgreSQL;

● db2 ‑ база данных, расположенная в СУБД IBM Db2;

● dbe ‑ файловый вариант базы данных «1С:Предприятия».

● user:password@ ‑ описывает имя пользователя (user) и пароль (password), которые требуются для доступа к объекту контроля. Если выполняется контроль таблиц базы данных, то в качестве пользователя указывается пользователь СУБД, а не информационной базы «1С:Предприятия». Рекомендуется использовать параметры того пользователя, от имени которого создавалась база данных «1С:Предприятия». Символ «@» является обязательным в том случае, если указывается имя пользователя и пароль.

● server:port ‑ имя компьютера (и порт доступа), на котором запущена СУБД, обсуживающая базу данных «1С:Предприятия»;

● /path/resource ‑ полный путь к файлу или каталогу в нотации используемой операционной системы. В ОС Windows должен начинаться с имени диска, в ОС Linux ‑ с обозначения корневой файловой системы (/). Если используется подключение к клиент-серверному варианту базы данных, то в качестве пути выступает имя базы данных в терминах используемой СУБД, если СУБД не поддерживает организацию экземпляров сервера, и комбинация из имени экземпляра и имени базы данных для СУБД, которые такую организацию поддерживают. Если в качестве пути к ресурсу указывается имя базы данных с указанием экземпляра СУБД, то доступ к СУБД осуществляется с использованием порта доступа по умолчанию и указание номера порта в описании имени сервера, на котором функционирует СУБД, не поддерживается.

● ?mask ‑ перечень параметров описателя источника информации, разделенных запятыми. Зависит от протокола. В том случае, если в качестве объекта контроля выступают файлы, описанные по птротоколам ndir или rdir, то в качестве параметров могут выступать маски файлов. Если объектом контроля выступает таблица базы данных «1С:Предприятия», то в качестве параметров могут выступать имена таблиц:

● config ‑ конфигурация базы данных;

● users ‑ таблица пользователей конфигурации;

Обе этих таблицы являются виртуальными и содержат в себе информацию из нескольких таблиц базы данных «1С:Предприятия». Если в универсальном описателе информации присутствует ссылка на одну из приведенных выше таблиц, то хеш-сумма считается для всех данных, входящих в состав таблицы (физические таблицы, полностью или нет). Возможность контролировать фрагмент таблицы не предоставляется.

Хеш-суммы объектов контроля хранятся в специальном файле ‑ базе эталонов. Файл содержит информацию в формате UTF-8. Местоположение и имя файла указывается при запуске утилиты. Данный файл имеет следующий формат:

[Нормализованный вид универсального описателя источника информации]
<объект контроля> = <хеш>

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

● Для всех протоколов в конце описания объекта контроля (перед «?») добавляется прямой слеш («/»);

● Для протоколов, описывающих каталоги, в случае отсутствия маски, добавляется маска «*»;

● Для протоколов, описывающих базы данных, при отсутствии маски добавляется явное указание параметров config,users;

● Для протоколов, описывающих базы данных, маска «*» заменяется на явное указание config,users;

● Маски лексикографически сортируются;

● Обратные слеши («\») заменяются на прямые («/»);

● Несколько идущих друг за другом слешей (любых) заменяются одним прямым (например, конструкция «//\\//» заменяется на «/»).

Строка <объект> = <хеш> ‑ содержит имя объекта контроля и хеш-сумму этого объекта. Таких строк может быть более одной. Если универсальный описатель источника информации содержит указание на конкретный файл, то выражение <объект> отсутствует, и строка сразу начинается с символа «=».

Пример фрагмента базы эталонов:

[dbe://C:/1C DB/DB folder/?config]
config = FEC3FC5E46AE98299217D6885B3BE28C4F4D6FB9
[dbe://C:/1C DB/Another DB folder/?config,users]
config = FEC3FC5E46AE98299217D6885B3BE28C4F4D6FB9
users = A244BE3830C2B7075C0BB684896B97A0324984A0
[file://C:/Program Files (x86)/1cv82/8.2.9.356/docs/ru/V8UpdateFrom82Beta.htm]
 = 392BC75149AE02565C7E31592EDCD60F00BFA03C
[ndir://C:/Program Files (x86)/1cv8/8.3.5.625/bin/?*]
1cv8.exe = 232F2BCCE6ABB95FD56E3CB3FADE528D851A5D69
1cv8_root.hbk = 025B4C8465D3CD851363B2102478B1CAF2EC444E
1cv8_root.res = 8F48869F82BB222EE25E18502605AC117BB5736A
1cv8_ru.hbk = 81CBB0D5573D8517913053EA88AAADE9785AB443
...

Результат работы утилиты фиксируется в файле отчета. Файл содержит информацию в формате UTF-8. Местоположение и имя файла указывается при запуске утилиты. Однако указанное имя будет преобразовано следующим образом: в имя файла будет добавлено дата и время формирования отчета, например, если указано, что отчета надо поместить в файл C:\temp\report.rpt, то фактическое имя файла будет иметь вид C:\temp\report-14.02.26-14.07.58.019446.rpt.

Сам файл имеет следующий формат:

[.params]
Key=value
[Нормализованный вид универсального описателя источника информации]
<Объект контроля> = <Обнаруженное изменение>

Секция .params присутствует всегда и содержит описание параметров запуска утилиты. В качестве значения Key могут выступать следующие значения:

● datetime ‑ дата и время запуска утилиты;

● workdir ‑ рабочий каталог при запуске утилиты;

● exepath ‑ путь к исполняемому файлу с утилитой;

● mode ‑ режим запуска утилиты:

● create ‑ режим формирования базы эталонов;

● check ‑ режим проверки эталонов.

● etalon ‑ путь к базе эталонов;

● report ‑ путь к файлу отчета (как он указан в командной строке запуска утилиты);

● debug ‑ путь к файлу с отладочной информацией или пустая строка, если не задан вывод отладочной информации;

● in ‑ путь к файлу с параметрами. Если в командной строке запуска указано более одного параметра –in, то возможно наличие нескольких ключей in в секции .params;

● param ‑ все распознанные параметры командной строки запуска утилиты, разделенные запятыми.

Если в каком-либо источнике (из базы эталонов) обнаружены различия между базой эталонов и фактически состоянием файлов на диске, то в файл отчета помещается секция с описанием изменившегося источника и ниже выводятся обнаруженные изменения для объектов контроля. Если объект контроля не изменился ‑ по такому объекту информации не выводится.

Обрабатываются следующие возможные изменения:

● A ‑ в источнике информации обнаружен новый объект контроля;

● D ‑ в источнике информации удален объект контроля, который существовал на момент формирования базы эталонов;

● M ‑ объект контроля модифицирован.

Рассмотрим фрагмент файла отчета:

[dbe://C:/1C DB/DB folder/?config,users]
users = M
[ndir://C:/Program Files (x86)/1cv81/bin/?*]
1CMailV8.dll = D
1CMailV8.dll.32 = A

В данном файле отчета зафиксировано, что:

● Для файловой информационной базы, расположенной в каталоге C:/1C DB/DB folder изменено содержимое таблицы пользователей.

● В каталоге C:/Program Files (x86)/1cv81/bin удален файл 1CmailV8.dll и обнаружен новый файл 1CmailV8.dll.32.

Запуск утилиты осуществляется с помощью командной строки, имеющей следующие параметры:

ci <mode> --in <ШаблонИсточника> --etalon <ФайлБазыЭталонов> --report <ФайлОтчета> --debug <ФайлОтладочнаяИнформация> [описание источника]

Параметры имеют следующее значение:

Режим работы утилиты:

● --version, -v ‑ показать номер версии утилиты контроля целостности.

● --help, -h ‑ показать справочную информацию по режимам make и check. В этом случае режим следует указать через пробел после команды получения справочной информации.

● make ‑ сформировать файл базы эталонов или выполнить обновление данных по каким-либо источникам информации (если база эталонов существует, и в ней присутствуют данные по источнику, который указан при запуске утилиты).

● check ‑ проверить целостность переданного списка источников по базе эталонов.

Следующие параметры необходимо указывать только при использовании утилиты в режимах make и check.

Параметр предназначен для указания пути к шаблону источников информации (см. здесь). Таких параметров может быть более одного.

Для режимов make и check следует указать хотя бы одно описание источника. Это может быть параметр --in (-i) или простое указание описания источника (см. ниже параметр описание источника).

Параметр предназначен для указания полного пути к файлу с базой эталонов (см. здесь).

Для режимов make и check является обязательным параметром.

Параметр предназначен для указания полного пути к файлу отчетом (см. здесь).

Для режимов make и check является обязательным параметром.

Параметр предназначен для указания полного пути к файлу с отладочной информацией. Файл необходим для технического персонала фирмы «1С» в случае расследования некорректного поведения утилиты.

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

● sha1 ‑ используется алгоритм SHA-1.

● sha256 ‑ используется алгоритм SHA-256. Это значение используется по умолчанию.

● gost2012 ‑ используется алгоритм, описанный в ГОСТ Р 34.11-2012 (512 бит).

Позволяет указать источник информации без указания файла шаблона (в том числе и несколько описаний). Для этого источник следует указывать точно в таком же формате, как и каждая строка списка шаблонов источников информации (см. здесь). В своей работе утилита использует все описания источников, которые обнаружила при своем запуске (как с помощью параметра in, так и с помощью простого указания).

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

В качестве возможного сценария использования можно привести следующий вариант:

1. Утилита устанавливается в каталог, отличающийся от каталога установки системы «1С:Предприятие».

2. Для работы с утилитой создаётся привилегированный пользователь с ограниченными правами, однако, достаточными для работы со всеми объектами контроля в режиме чтения.

3. Права доступа к исполняемым и конфигурационным файлам утилиты ограничиваются созданным пользователем (т. е. любой доступ к файлам любых других пользователей должен быть запрещён).

4. Работать с утилитой следует от имени созданного пользователя.

Вышеперечисленные правила обеспечат высокий уровень защищённости утилиты от несанкционированного доступа и дискредитации.

В этом случае общая схема использования выглядит следующей:

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

2. Выполняется запуск утилиты в одном из необходимых режимов: создания базы эталонов или ее проверки целостности источников.

3. Выполняется анализ отчета о работе утилиты.

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

Файл базы данных имеет несколько версий внутреннего формата:

1. Версия 8.2.14 ‑ имеет размер внутренней страницы файла базы данных равный 4 096 байт. Размер внутреннего файла не может превышать 4 Гбайта. Более подробно про внутренний файл (написано в книге).

2. Версия 8.3.8 ‑ размер внутренней страницы файла базы данных может принимать несколько значений: 4 096, 8 192, 16 384, 32 768 и 65 536 байт. Кроме того, формат версии 8.3.8 обеспечивает более оптимальный формат хранения некоторых внутренних данных. Размер внутреннего файла не может превышать 4 Гбайта (при размере страницы в 4 096 байта) и 6 Гбайт (при размере страницы 8 192, 16 384, 32 768 и 65 536 байт). Более подробно про внутренний файл (написано в книге).

Система «1С:Предприятие» версии 8.3.8 и старше обеспечивает функционирование с файлом 1Cv8.1CD любого формата без дополнительных действий. Система «1С:Предприятие» версии 8.3.7 и младше обеспечивает функционирование с файлом 1Cv8.1CD только версии 8.2.14. Преобразование между двумя форматами возможно либо с помощью операции выгрузки/загрузки данных информационной базы в файл .dt, либо с помощью специальной утилиты cnvdbfl.

Утилита cnvdbfl является утилитой командной строки и позволяет:

1. преобразовывать файлы 1Cv8.1CD между различными форматами;

2. изменять размер страницы файла для формата 8.3.8.

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

cnvdbfl <команда> <путь к 1CV8.1CD>

Команды могут быть следующими:

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

Конвертация в формат 8.2.14:

cnvdbfl -c -f 8.2.14 c:\temp\1cv8.1cd

Конвертация в формат 8.3.8 со страницей по умолчанию:

cnvdbfl -c -f 8.3.8 c:\temp\1cv8.1cd

Конвертация в формат 8.3.8 со страницей размером 16К:

cnvdbfl -c -f 8.3.8 -p 16k c:\temp\1cv8.1cd

Получить информацию о файле 1Cv8.1CD:

cnvdbfl -i c:\temp\1cv8.1cd

Утилита ring ‑ это кроссплатформенная консольная (не имеющая графического интерфейса) утилита для управления локальной конфигурацией процессов системы «1С:Предприятия» и для выполнения различных операций, необходимых для поддержки работы системы.

Утилита ring имеет модульную архитектуру. Модуль ‑ это набор общей (по смыслу или выполняемым действиям) функциональности, доступ к которой осуществляется с помощью команд. Количество команд в модуле не ограничивается. Команда ‑ это некоторое действие, обладающее некоторым набором параметров (или без таковых). Один вызов утилиты ring приводит к выполнению одной команды одного модуля. Одновременно утилита может использовать несколько модулей.

Список установленных и используемых модулей находится в реестре экземпляров модулей ring-commands.cfg, формат и расположение которого см. здесь.

Параметры, которые передаются командам, не могут содержать пробелы. Если значение параметра содержит пробел ‑ это значение должно быть заключено в кавычки.

Общая схема вызова команды:

ring <module> <command> [--parameter "parameter value"]

В приведенной схеме вызова команды:

● ring ‑ имя утилиты.

● <module> ‑ имя модуля.

● <command> ‑ имя используемой команды.

● --parameter ‑ параметр и значение параметра для команды. Количество параметров, а также обязательные и необязательные параметры, значения по умолчанию и т. д. определяются для каждой команды индивидуально.

При использовании различных модулей и команд с утилитой ring под управлением ОС Windows, необходимо помнить, что при вводе аргументов командной строки вводимые символы не должны требовать более 8 бит. Если для ввода используются языки, в которых существуют символы, не отвечающие этому требованию, рекомендуется подбирать для этих символов соответствующую замену. Например, вместо символа «ə» можно попробовать использовать символ «a» или «e».

Работа утилиты ring поддерживается на тех же операционных системах, что и собственно «1С:Предприятие» (см. здесь). Утилита ring доступна в 32‑ и 64-разрядных версиях.

Дополнительно для работы утилиты ring требуются:

● Java 8 и выше (https://www.java.com/ru/download/).

● При работе под управлением ОС Linux необходимо, чтобы GNU Awk был установлен и использовался по умолчанию.

Установка утилиты выполняется при установке других продуктов, которые требуют данную утилиту. Другие продукты могут являться модулями утилиты ring или включать в себя модули для этой утилиты.

Утилита ring без установленных модулей не имеет какой-либо практической ценности, поэтому установка отдельно утилиты ring не поддерживается.

Утилита ring выводит информацию на языке, определенном операционной системой. Информацию о способе смены языка интерфейса можно получить в документации на используемую операционную систему.

Если необходимо, чтобы утилита ring выводила информацию на языке, отличном от языка в настройках операционной системы, то сделать это можно путем указания в переменной окружения RING_OPTS параметра -Duser.country=ru -Duser.language=RU. Если переменная RING_OPTS уже имеет значение, то к значению следует добавить пробел и после него указанную строку.

Пример установки переменной окружения c помощью командной строки:

● Для ОС Windows:

set RING_OPTS=-Duser.country=ru -Duser.language=RU

● Для ОС Linux (командный процессор bash):

export RING_OPTS=-Duser.country=ru -Duser.language=RU

Утилита поддерживает два языка вывода: русский и английский.

Обязательно установите для терминала шрифт Consolas или другой TrueType-шрифт с поддержкой символов Unicode. Проверьте, что нужный язык выбран в операционной системе в качестве языка для программ, не поддерживающих Unicode. Изменение данной настройки вступает в силу после перезагрузки системы.

Если изменить настройки операционной системы не представляется возможным, то при использовании шрифта Consolas попробуйте до запуска ring выполнить команду по смене кодовой страницы, указав кодовую страницу, подходящую для нужного языка, например:

chcp 1251

При работе под управлением ОС Windows возможна ситуация, когда переадресация вывода утилиты ring в файл приводит к тому, что содержимое файла содержит нечитаемые символы. Такая ситуация возникает при несоответствии настройки языка для программ, не поддерживающих Unicode, и языка в интерфейсе системы. Существует несколько способов получить данные в файле в читаемом виде:

● Установить язык для программ, не поддерживающих Unicode в соответствии с языком интерфейса, подробнее см. здесь.

● Указать кодировку UTF-8 используя переменную окружения RING_OPTS, подробнее см. здесь.

Утилита лицензирования предназначена для выполнения следующих задач:

● первичное получение лицензии;

● повторное получение и обновление лицензии;

● проверка соответствия файла лицензии текущему компьютеру;

● вывод списка лицензий;

● получение информации о лицензии;

● удаление лицензии;

● обновление лицензии.

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

● ОС Windows: %ProgramData%\1C\licenses.

● ОС Linux: /var/1C/licenses.

Полный список каталогов, где могут располагаться программные лицензии см. здесь.

При отображении лицензий используется унифицированное представление вида: пинкод-номер. Так, если имеется программная лицензия, для которой возможно использование пинкода 123-456-789-012 и эта лицензия используется для продукта с регистрационным номером 8000314159, то данная лицензия будет отображаться следующим образом: 123456789012-8000314159. Это же имя следует указывать в том случае, если какая-либо команда утилиты лицензирования требует в качестве параметра имя лицензии.

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

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

2. Использование последовательности команд prepare-request, acquire и generate. В этом случае вначале подготавливается файл запроса к центру лицензирования (команда prepare-request), затем выполняется запрос к центру лицензирования (с помощью электронной почты) и получается ответ центра лицензирования (в виде файла). Также имеется возможность выполнить формирование файла ответа от центра лицензирования через веб-сервис, без использования электронной почты (команда acquire). Затем на основании запроса и ответа получается файл лицензии (команда generate).

Утилита лицензирования, фактически, является отдельным модулем, требующим для своего исполнения утилиту ring. Модуль называется license. С точки зрения выполняемых действий, «модуль license» и «утилита лицензирования», являются взаимозаменяемыми понятиями. С технической точки зрения «утилита лицензирования» ‑ это утилита ring и модуль license, а «модуль license» ‑ это отдельный модуль, требующий для своей работы утилиту ring.

Для работы модуля license требуется установленная утилита ring. Модуль license доступен в 32‑ и 64-разрядных версиях.

Для работы модуля license требуются:

● Утилита ring версии 0.8.2 и выше.

● JCE для Java 8 (https://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) или корректная настройка конфигурационного файла Java (в зависимости от версии Java).

● Для ОС Windows: система Windows Script Host, работающая на компьютере, на котором запускается модуль license.

Дистрибутив утилиты лицензирования расположен на портале 1С:Обновление программ (https://releases.1c.ru/project/EnterpriseLicenseTools). Для установки утилиты следует выполнить следующие шаги:

1. Определить разрядность и операционную систему, под управлением которой будет использоваться утилита лицензирования.

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

3. Создать временный каталог.

4. Распаковать в этот каталог скаченный архив с утилитой.

5. Перейти в созданный каталог.

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

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

● 1ce-installer ‑ программа установки с графическим интерфейсом.

● 1ce-installer-cli ‑ программа установки с интерфейсом командной строки.

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

<lib>
1c-enterprise-installer-1.9.1+3-linux-anyarch.e1c.car
1c-enterprise-license-tools-0.15.0+2-linux-x86_64.e1c.car
1c-enterprise-license-tools-0.15.0+2-linux-x86_64.e1c.dar
1c-enterprise-license-tools-0.15.0+2-linux-x86_64.e1c.par
1c-enterprise-ring-0.19.5+12-linux-x86_64.e1c.car
1ce-installer
1ce-installer-cli

В данном случае видно, что:

● Утилита лицензирования скачана для 64-разрядной версии ОС Linux: linux-x86_64.

● Версия программы установки: 1.9.1.3.

● Версия утилиты ring: 0.19.5.12.

● Версия утилиты лицензирования (license tools): 0.15.0.2.

Описание работы с программой установки (как в графической, так и в консольной версии) можно получить на портале 1С:ИТС (https://its.1c.ru/db/inst10doc).

После установки модуля можно проверить, что он зарегистрировался в реестре экземпляров модулей (см. здесь).

Описание настройки Java для корректной работы утилиты лицензирования см. здесь.

Команда предназначена для формирования файла ответа по ранее сформированному файлу запроса, с использованием веб-сервиса центра лицензирования.

ring license acquire [--request <ФайлЗапроса>] [--response <ФайлОтвета>] [--conf-location] [--send-statistics <режим>]

● request ‑ полное имя к файлу с запросом к центру лицензирования. Если параметр не указан, то содержимое файла запроса ожидается со стандартного потока ввода.

● response ‑ полное имя файла, в которое будет помещен ответ центра лицензирования. Если параметр не указан, то содержимое файла ответа будет выведено в стандартный поток вывода.

● conf-location ‑ позволяет указать каталог, в котором расположен конфигурационный файл conf.cfg. В данном файле анализируется параметр ExternalResourcesMode, в соответствии с которым выбирается адрес используемого центра лицензирования.

Если параметр не задан или в указанном каталоге не обнаружен файл conf.cfg, то выполняется поиск этого файла в следующих каталогах:

● Для ОС Windows:

● 32-разрядная система в 64-разрядной ОС: %PROGRAMFILES(x86)%\1cv8\conf.

● В остальных случаях: %PROGRAMFILES%\1cv8\conf.

● Для ОС Linux:

● Каталог ~/.1cv8/1C/1cv8/conf (~ ‑ домашний каталог пользователя, от имени которого работает сервер «1С:Предприятия»).

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Ответ центра лицензирования.

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

Активация лицензии с использованием веб-сервиса центра лицензирования.

ring license activate --first-name <имя> --middle-name <отчество> --last-name <фамилия> [--email <email>] --company <компания> --country <страна> --zip-code <индекс> [--region <область> --district <район>] --town <город> --street <улица> --house <дом> --building <строение> --apartment <квартира> --serial <серийныйНомер> --pin <пинкод> [--previous-pin <предыдущийПинкод>] [--path <хранилище>] [--validate] [--conf-location <путь>] [--send-statistics <режим>]

● first-name ‑ имя владельца лицензии. При указании параметра company, данный параметр является необязательным.

● middle-name ‑ отчество владельца лицензии. При указании параметра company, данный параметр является необязательным.

● last-name ‑ фамилия владельца лицензии. При указании параметра company, данный параметр является необязательным.

● email ‑ электронная почта владельца лицензии.

● company ‑ организация владельца лицензии. При указании параметров first-name, middle-name, last-name, данный параметр является необязательным. Требуется не менее 5 символов, при этом не должно быть более 3 одинаковых символов подряд.

● country ‑ страна регистрации. Не может быть пустым.

● zip-code ‑ индекс. Не может быть пустым.

● region ‑ область/республика/край.

● district ‑ район.

● town ‑ город. Не может быть пустым.

● street ‑ улица. Не может быть пустым.

● house ‑ номер дома. При указании параметров building или apartment, данный параметр является необязательным. Не может быть пустым.

● building ‑ строение. При указании параметров house или apartment, данный параметр является необязательным. Не может быть пустым.

● apartment ‑ квартира. При указании параметров house или building, данный параметр является необязательным. Не может быть пустым.

● serial ‑ серийный номер программного продукта.

● pin ‑ пинкод, используемый при активации лицензии.

● previous-pin ‑ при повторной активации лицензии в данном параметре указывается пинкод, который использовался при первичной активации лицензии. Не должен совпадать со значением параметра pin.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● validate ‑ если указан, то выполнение команды будет завершено с ошибкой, если при попытке получения какого-либо из ключевых параметров возникла ошибка времени исполнения. В случае если параметр не указан, возникновение ошибки при получении какого-либо ключевого параметра не будет препятствовать успешной активации лицензии. Однако, поля лицензии, соответствующие неполученным параметрам, будут заполнены пустыми значениями, что приведет к невозможности дальнейшего использования активированной лицензии.

● conf-location ‑ позволяет указать каталог, в котором расположен конфигурационный файл conf.cfg. В данном файле анализируется параметр ExternalResourcesMode, в соответствии с которым выбирается адрес используемого центра лицензирования.

Если параметр не задан или в указанном каталоге не обнаружен файл conf.cfg, то выполняется поиск этого файла в следующих каталогах:

● Для ОС Windows:

● 32-разрядная система в 64-разрядной ОС: %PROGRAMFILES(x86)%\1cv8\conf.

● В остальных случаях: %PROGRAMFILES%\1cv8\conf.

● Для ОС Linux:

● Каталог ~/.1cv8/1C/1cv8/conf (~ ‑ домашний каталог пользователя, от имени которого работает сервер «1С:Предприятия»).

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

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

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

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

● Файл conf.cfg (см. здесь).

Команда предназначена для формирования файла лицензии по данным запроса к центру лицензирования и его (центра) ответа.

ring license generate --license <файлЛицензии> --request <ФайлЗапроса> --response <ФайлОтвета> [--send-statistics <режим>]

● license ‑ полное имя к файлу с получившейся лицензией. Если параметр не указан, то содержимое файла активированной лицензии выводится в стандартный поток вывода.

● request ‑ полное имя к файлу с запросом к центру лицензирования.

● response ‑ полное имя файла, в которое будет помещен ответ центра лицензирования.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Файл с активированной лицензией.

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

Получает файл с указанной активированной лицензией в указанном хранилище лицензий и записывает в файл.

ring license get -name <имя> [--license <полноеИмя>] [--path <хранилище>] [--send-statistics <режим>]

● name ‑ имя лицензии, для которой ожидается получение информации.

● license ‑ полный путь к файлу, в который будет записана получаемая лицензия. Если не указано ‑ содержимое файла с лицензией выводится в стандартный поток вывода.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Получает из хранилища файл с активированной лицензией и помещает его в файл с указанным именем.

В случае успешного завершения код возврата утилиты равен 0. В противном случае код возврата отличается от 0.

Выводит информацию об указанной лицензии.

ring license info [--name <имя>] [--path <хранилище>] [--send-statistics <режим>]

● name ‑ имя лицензии, для которой ожидается получение информации. Если данный параметр отсутствует, то система ожидает со стандартного потока ввода содержимое (не имя!) файла с активированной лицензией.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Информация о лицензии в следующем формате:

Имя файла лицензии:
Информация о пользователе:
    Имя:
    Отчество:
    Фамилия:
    e-mail:
    Компания:
    Страна:
    Индекс:
    Город:
    Улица:
    Дом:
Информация о продукте:
    Описание:
    Дата комплектации:
    Регистрационный номер:
    Код продукта:
    Тип лицензии:
    Тип привязки лицензии:
TechnicalInfo:
    LicenseType:
    LicenseAssociationType:
    HardwareKeyAssociation:
    LicenseGenerationDate:
    ProductCode:
    DistributionKitRegistrationNumber:

При выводе не выполняется проверка соответствия текущего оборудования компьютера и оборудования, использованного при активизации лицензии.

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

Машиночитаемый раздел ‑ это раздел TechnicalInfo. Этот раздел предназначен для автоматизированной обработки. Информация в разделе представлена в виде пар «ключ-значение». Одна пара выводится на одной строке. Разделителем ключа и значения является символ «:». Вся информация в этом разделе всегда выводится на английском языке и содержит следующие параметры:

● LicenseType ‑ типы лицензий и привязок возвращаются в виде их идентификаторов указанных далее:

● ProfLicenseUpdate ‑ лицензия является обновлением ранее выпущенных лицензий уровня ПРОФ.

● ClientLicense ‑ клиентская лицензия.

● ServerLicenseFor32BitServer ‑ лицензия на 32-разрядный сервер приложений.

● ServerLicenseFor64BitServer ‑ лицензия на 64-разрядный сервер приложений.

● ServerLicenseWithLimitedNumberOfConcurrentSessions –лицензия на сервер приложений с ограниченным количеством одновременно обслуживаемых сеансов.

● LicenseForDedicatedFunctionalityTesting ‑ лицензия для тестирования выделенной функциональности.

● CorporateLicense ‑ лицензия уровня КОРП.

● EntirePlatformFunctionality ‑ лицензия разрешает использование все возможности платформы.

● MoreThan500UsersInInfobase ‑ лицензия разрешает наличие более 500 активных пользователей в одной информационной базы.

● MoreThan12CpuCores ‑ лицензия разрешает серверу приложений использовать более 12 процессорных ядер.

● LicenseAssociationType к чему привязана программная лицензия:

● HardwareProtectionKey ‑ лицензия привязана к ключу аппаратной защиты HASP.

● Computer ‑ лицензия привязана к компьютеру.

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

● LicenseGenerationDate ‑ дата привязки лицензии в формате ISO 8601: yyyy-MM-ddTHH:mm:ss.

● ProductCode ‑ код лицензируемого продукта.

● DistributionKitRegistrationNumber ‑ регистрационный номер лицензируемого продукта.

Команда предназначена для отображения списка лицензий в хранилище лицензий.

ring license list [--path <хранилище>] [--send-statistics <режим>]

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Список имен обнаруженных лицензий.

В том случае, если активировать программную лицензию с использованием веб-сервиса центра лицензирования не представляется возможным, имеется возможность активировать лицензию с помощью электронного письма в центр лицензирования. Для этого используются команды prepare-request, acquire и generate в указанном порядке.

Команда prepare-request выполняет подготовку файла для передачи в центр лицензирования.

ring license prepare-request --first-name <имя> --middle-name <отчество> --last-name <фамилия> [--email <email>] --company <компания> --country <страна> --zip-code <индекс> [--region <область> --district <район>] --town <город> --street <улица> --house <дом> --building <строение> --apartment <квартира> --serial <серийныйНомер> --pin <пинкод> [--previous-pin <предыдущийПинкод> --request <файл>] --validate [--send-statistics <режим>]

● first-name ‑ имя владельца лицензии. При указании параметра company, данный параметр является необязательным.

● middle-name ‑ отчество владельца лицензии. При указании параметра company, данный параметр является необязательным.

● last-name ‑ фамилия владельца лицензии. При указании параметра company, данный параметр является необязательным.

● email ‑ электронная почта владельца лицензии.

● company ‑ организация владельца лицензии. При указании параметров first-name, middle-name, last-name, данный параметр является необязательным. Требуется не менее 5 символов, при этом не должно быть более 3 одинаковых символов подряд.

● country ‑ страна регистрации. Не может быть пустым.

● zip-code ‑ индекс. Не может быть пустым.

● region ‑ область/республика/край.

● district ‑ район.

● town ‑ город. Не может быть пустым.

● street ‑ улица. Не может быть пустым.

● house ‑ номер дома. При указании параметров building или apartment, данный параметр является необязательным. Не может быть пустым.

● building ‑ строение. При указании параметров house или apartment, данный параметр является необязательным. Не может быть пустым.

● apartment ‑ квартира. При указании параметров house или building, данный параметр является необязательным. Не может быть пустым.

● serial ‑ серийный номер программного продукта.

● pin ‑ пинкод, используемый при активации лицензии.

● previous-pin ‑ при повторной активации лицензии в данном параметре указывается пинкод, который использовался при первичной активации лицензии. Не должен совпадать со значением параметра pin.

● request ‑ указывает полный путь к файлу, в который будет помещена информация для передачи в центр лицензирования. Если не указан, то текст запроса в центр лицензирования будет выведен в стандартный поток вывода.

● validate ‑ если указан, то выполнение команды будет завершено с ошибкой, если при попытке получения какого-либо из ключевых параметров возникла ошибка времени исполнения. В случае если параметр не указан, возникновение ошибки при получении какого-либо ключевого параметра не будет препятствовать успешной активации лицензии. Однако, поля лицензии, соответствующие неполученным параметрам, будут заполнены пустыми значениями, что приведет к невозможности дальнейшего использования активированной лицензии.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Формируется содержимое файла запроса в центр лицензирования (в файле или в стандартном потоке вывода).

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

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

ring license put --license <полноеИмя> [--path <хранилище>] [--send-statistics <режим>]

● license ‑ полный путь к файлу активированной лицензии, который будет помещен в хранилище лицензий.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Помещает указанный файл с активированной лицензией в указанное (явно или неявно) хранилище лицензий.

В случае успешного завершения код возврата утилиты равен 0. В противном случае код возврата отличается от 0.

Удаляет указанную лицензию из указанного хранилища лицензий.

ring license remove -name <имя> [--path <хранилище>] [--all] [--send-statistics <режим>]

● name ‑ имя лицензии, которую требуется удалить из хранилища.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● all ‑ удалить все лицензии с заданным именем в хранилище.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Удаленная лицензия в хранилище лицензий.

В случае успешного завершения код возврата утилиты равен 0. В противном случае код возврата отличается от 0.

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

ring license update --conf-location <КонфигурационныйФайл> [--force <значение>] [--path <хранилище>] [--validate] [--send-statistics <режим>]

● conf-location ‑ каталог расположения конфигурационных файлов платформы. Используется для поиска конфигурационного файла conf.cfg, в котором анализируется параметр ExternalResourcesMode. Если параметр не указан или в указанном каталоге отсутствует файл conf.cfg, то будет выполнена попытка найти файл conf.cfg в следующих каталогах:

● Для ОС Windows:

● 32-разрядная система в 64-разрядной ОС: %PROGRAMFILES(x86)%\1cv8\conf.

● В остальных случаях: %PROGRAMFILES%\1cv8\conf.

● Для ОС Linux:

● Каталог ~/.1cv8/1C/1cv8/conf (~ ‑ домашний каталог пользователя, от имени которого запускается утилита лицензирования).

● force ‑ определяет поведение утилиты лицензирования, если при обновлении лицензии произошли ошибки. Параметр может принимать следующие значение:

● true ‑ ошибка игнорируется и файл, при обработке которого произошла ошибка, пропускается. Обработка продолжается.

● false ‑ обработка файлов прерывается, все лицензии восстанавливаются из резервных копий (значение по умолчанию).

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● validate ‑ указывает, следует ли проверять аппаратные данные, полученные от системы. Параметр может принимать следующие значения:

● true ‑ проверять.

● false ‑ не проверять (значение по умолчанию).

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

Обновлены все лицензии в хранилище лицензий.

В случае успешного завершения код возврата утилиты равен 0. В противном случае код возврата отличается от 0.

Проверяет соответствие оборудования на компьютере оборудованию, которое было зафиксировано в момент активации лицензии.

ring license validate [--name <имя>] [--path <хранилище>] [--send-statistics <режим>]

● name ‑ имя лицензии, для которой ожидается получение информации. Если данный параметр отсутствует, то система ожидает со стандартного потока ввода содержимое (не имя!) файла с активированной лицензией.

● path ‑ указывает путь к хранилищу лицензий, если оно отличается от пути по умолчанию.

● send-statistics ‑ управляет отправкой статистической информацию в сервис 1С:Пульт (адрес pult.1c.com, порт 443). Параметр <режим> может принимать следующие значения:

● true ‑ информация отправляется. Значение по умолчанию.

● false ‑ информация не отправляется.

Перечень отправляемой информации см. здесь.

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

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

● 1 ‑ изменены параметры компьютера;

● 2 ‑ ошибка проверки цифровой подписи лицензии.

В сервис 1С:Пульт отправляются следующие данные:

● Тип операционной системы: Windows или Linux.

● Полное имя операционной системы.

● Архитектура компьютера, на котором запустили утилиту.

● Версия запущенной утилиты лицензирования.

● Архитектура запущенной утилиты лицензирования.

● Версия Java, под управлением которой работает утилита.

● Название исполняемой команды утилиты лицензирования.

● Уникальный идентификатор установки, сгенерированный на основе следующей информации (хеш в формате UUID):

● MAC-адрес компьютера;

● версия утилиты;

● архитектура утилиты.

● Номер пакета данных.

● Уникальный идентификатор компьютера, сгенерированный на основе MAC-адреса сервера (хеш в формате UUID).

● Дата и время выполнения команды.

Утилита административной консоли (1cv8a) предназначена для ускорения проверки и исправления определенных проблем:

● Тестирование и исправление таблиц узлов планов обмена.

● Тестирование и исправление хеш-полей таблиц информационной базы.

Утилита административной консоли позволяет исправлять некоторые проблемы, возникающие с информационной базой, без запуска конфигуратора и за более короткое время. Это обусловлено тем, что утилита административной консоли занимается обработкой только проблемных объектов и при этом выполняется ограниченный набор исправлений.

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

1cv8a <режимы> <ключи>

Режимы могут быть следующими:

● help [режим] или h [режим]

Отображение краткой информации об утилите или какому-либо режиму работы.

● ib-check-and-repair или ibcr

Выполнение операции тестирования и исправления данных.

При исполнении команды можно указывать следующие параметры:

● --repair или -r

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

● --exchange-plan-integrity или -epi

Выполнять тестирование и исправление таблиц узлов планов обмена.

● --exchange-plan-integrity-outFile=<имя XML-файла> или -epiof <имя XML-файла>

Указывает имя XML-файла для сохранения состояния записей ЭтотУзел планов обмена. Параметр является обязательным при выполнении команды с параметром --exchange-plan-integrity.

● --data-history-integrity или -dhis

Выполнять тестирование и исправление таблиц истории данных.

● --dimhash-integrity или -dhi

Выполняет пересчет итогов для устранения некорректного расчета итогов для регистров накопления и бухгалтерии, если среди измерений есть хотя-бы одно измерение с типом Строка и в состав индекса по измерениям входят более 16 полей базы данных. Пересчет итого выполняется только в том случае, если одновременно с параметром --dimhash-integrity используется параметр --repair. Если параметр --repair не указан ‑ выполняется только проверка того, что в информационной базе есть некорректные итоги регистров накопления и бухгалтерии.

● --connection-string=<string>

Указывает строку соединения с информационной базой.

● --file=<path> или -f <path>

Указывает путь к каталогу информационной базы в файловом варианте.

● --server=<server:port/infobase> или -s <server:port/infobase>

Указывает параметры подключения к информационной базе в клиент-серверном варианте.

● --user=<name> или -u <name> или -n <name>

Указывает имя пользователя, от имени которого будет выполняться подключение к информационной базе.

● --password=<password> или –p <password>

Указывает пароль пользователя информационной базы, от имени которого будет выполняться подключение к информационной базе.

● --unlock-code=<code>

Указывает код разрешения соединения с информационной базой (если задан).

● --security-level=<level>

Указывает уровень защищенности соединения с сервером.

● --verbose

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

Режим агента ‑ специальный вариант пакетного режима запуска конфигуратора, в котором он (конфигуратор) выполняет функции SSH‑ и SFTP-сервера и принимает команды по этим протоколам.

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

Общая схема работы в режиме агента выглядит следующим образом:

1. Выполняется запуск конфигуратора в режиме агента.

2. С удаленного компьютера выполняется подключение к агенту.

3. С помощью SFTP-клиента выполняется обмен файлами с агентом.

4. С помощью SSH-клиента выполняется передача команд агенту и получение результата работы.

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

login as: adminadmin
admin@localhost's password:
1C:Enterprise 8.3 1C Designer Shell © 1C LLC 1996-2018
designer>

Результат работы команд в режиме агента могут быть представлены в двух форматах: в текстовом формате (по умолчанию) и в формате JSON-сообщений. При работе в формате JSON-сообщений, сервер всегда возвращает массив с информацией о результате работы. Для установки формата результата работы предназначена специальная команда. В конце обработки всех команд агент конфигуратора отправляет сообщение с типом success, error, cancel или question. Команда help отправляет в конце сообщение с типом success, а при вводе неизвестной команды ‑ сообщение с типом error.

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

1cv8 DESIGNER <информационная база> /AgentMode [параметры режима агента] [/Visible].

При указании командной строки запуска следует учитывать следующие особенности:

● Для указания информационной базы может использоваться любой из доступных способов: параметры /IBName, /F или /S. При этом параметры, определяющие имя пользователя и пароль доступа к информационной базе, указывать не имеет смысла, эти параметры будут проигнорированы. Логин и пароль будет необходимо ввести в ответ на соответствующие запросы в консоли удаленного доступа. Также следует помнить, что для подключения к информационной базе, которая будет использоваться в режиме агента, не рекомендуется использовать пользователя, имя которого задано с использованием национальных символов.

● В том случае, если в командной строке будет обнаружен параметр /AgentMode, конфигуратор будет игнорировать все параметры, кроме: параметров режима агента; параметров, указывающих информационную базу; параметра /Visible.

● Указание параметра /Visible приводит к появлению на экране специального окна, с помощью которого можно завершить работу режима агента. Если запуск выполняется без этого параметра, то завершить работу в режиме агента можно только с помощью командной строки удаленного доступа.

К конфигуратору, работающему в режиме агента, может быть подключен один клиент по протоколу SSH и несколько клиентов по протоколу SFTP.

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

● Описание работы с JSON (см. стр. см. здесь).

● Команды работы в режиме агента (см. здесь).

В режиме агента предоставляются следующие команды:

● Команда help (подробнее см. здесь).

● Группа команд common ‑ общие команды (подробнее см. здесь).

● Группа команд options ‑ команды работы с настройками (подробнее см. здесь).

● Группа команд config ‑ команды редактирования конфигурации (подробнее см. здесь).

● Группа команд infobase-tools ‑ сервисные команды работы с информационной базой (подробнее см. здесь).

Более подробное описание формата JSON-сообщений см. здесь.

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

Следует помнить, что все примеры, приведенные в данном разделе, не являются законченными конструкциями и предназначены только для демонстрации работы того или иного механизма или приема использования.

Данная команда предназначена для получения справочной информации. Команда help без параметров покажет общую информацию по использованию режима агента.

designer> help
Использование:
         help [options] [arguments]
Общие параметры:
    --version | -v
        получение версии утилиты
Режим:
    help (h)
        Отображение справочной информации для указанного режима.
Аргументы:
    MODE
        режим, для которого необходимо получить информацию о ключах командной строки
Поддерживаемые режимы:
help              Отображение справочной информации для указанного режима.
common            Общие команды
options           Управление настройками
config            Режим работы с конфигурацией
infobase-tools    Сервисные функции работы с информационной базой
designer>

Если требуется получить более конкретную информацию о группе команд или какой-то конкретной команде, то следует всю эту информацию ввести после ключевого слова help. Например, для получения информации о группе команд options необходимо выполнить команду help options.

designer> help options
Использование:
         options [command] [options]
Общие параметры:
    --version | -v
        получение версии утилиты
Режим:
    options
        Управление настройками
Команды:
    list
        Вывести значения всех настроек
    get
        Получить значение настройки
        --output-format
            Формат вывода
        --show-prompt
            Показывать приглашение командной строки
    set
        Установить значение настройки
        --output-format=<text|json>
            Формат вывода
        --show-prompt=<yes|no>
            Показывать приглашение командной строки
designer>

Для получения версии системы «1С:Предприятие», которая выполняется в режиме агента, необходимо выполнить команду help –version.

designer> help --version
8.3.10.2000
designer>

Если установить формат вывода в JSON-сообщения, то вывод информации о версии платформы «1С:Предприятие» будет выглядеть следующим образом:

designer> options set --output-format=json
[
{
"type": "success",
"message": ""
}
]
designer> help --version
[
{
"type": "success",
"body": "8.3.10.1772"
}
]
designer>

В данном примере первая команда (options set …) устанавливает формат вывода, а следующая команда получает версию системы «1С:Предприятие».

Команды группы common отвечают за общие операции. В состав группы входят следующие команды:

● connect-ib ‑ выполнить подключение к информационной базе, параметры которой указаны при старте режима агента.

● disconnect-ib ‑ выполнить отключение от информационной базы, подключение к которой ранее выполнялось с помощью команды connect-ib.

● shutdown ‑ завершить работу конфигуратора в режиме агента.

Команды данной группы не имеют параметров.

Команды группы options отвечают за управление настройкам текущей сессии.

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

● --output-format=<значение> ‑ позволяет указать формат вывода результата работы команд:

● text ‑ команды возвращают результат в текстовом формате.

● json ‑ команды возвращают результат в формате JSON-сообщений.

● --show-prompt=<значение> ‑ позволяет управлять наличием приглашения командной строки designer>:

● yes ‑ в командной строке есть приглашение;

● no ‑ в командной строке нет приглашения.

● --notify-progress ‑ позволяет получить информацию об отображении прогресса выполнения команды.

● --notify-progress-interval ‑ позволяет получить интервал времени, через который обновляется информация о прогрессе.

C помощью данной команды можно просмотреть список параметров и их (параметров) текущее состояние.

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

● --output-format=<значение> ‑ позволяет указать формат вывода результата работы команд:

● text ‑ команды возвращают результат в текстовом формате.

● json ‑ команды возвращают результат в формате JSON-сообщений.

● --show-prompt=<значение> ‑ позволяет управлять наличием приглашения командной строки designer>:

● yes ‑ в командной строке есть приглашение;

● no ‑ в командной строке нет приглашения.

● --notify-progress=<значение> ‑ позволяет управлять выводом информации о прогрессе выполнения команды:

● yes ‑ отображается прогресс;

● no ‑ прогресс не отображается (значение по умолчанию).

Список команд, поддерживающих отображение прогресса см. здесь.

● --notify-progress-interval=<значение> ‑ позволяет указать интервал времени, через который обновляется информация о прогрессе. Значение задается с точностью 0.1 секунды. Значение по умолчанию равно 1 секунда. Нарушение точности приводит к формированию ошибки CommandLineFormaError. Список команд, поддерживающих отображение прогресса см. здесь.

Команды группы config отвечают за команды редактирования конфигурации.

Команда позволяет выполнить выгрузку конфигурации или расширения в файл. Для команды доступны следующие параметры:

● --file=<путь> ‑ путь к файлу конфигурации (cf-файл) или расширению (cfe-файл).

● --extension=<имя расширения> ‑ содержит имя расширения, которое будет выгружено в файл.

Команда позволяет выполнить выгрузку конфигурации в xml-файлы. Для команды доступны следующие параметры:

● --dir=<путь> ‑ содержит путь к каталогу, в который будет выгружена конфигурация. Параметр является обязательным.

● --extension=<имя расширения> ‑ содержит имя расширения, которое будет выгружено в файлы.

● --all-extensions ‑ если параметр указан, то в файлы будут выгружены все расширения конфигурации.

● --format=<значение> ‑ определяет формат выгрузки

● hierarchical ‑ иерархический формат выгрузки. Значение по умолчанию.

● plain ‑ линейный формат выгрузки.

● --update ‑ обновить существующую выгрузку. В этом случае будут выгружены только те объекты, версии которых отличаются от версий, указанных в файле ConfigDumpInfo.xml.

● --force ‑ выполнить полную выгрузку, если при попытке обновления выгрузки (параметр update) выяснилось, что текущая версия формата выгрузки не совпадает с версией формата выгрузки, которая указана в файле ConfigDumpInfo.xml.

● --get-changes=<путь> ‑ сформировать файл, который содержит изменения между текущей и указанной выгрузками конфигурации.

● --config-dump-info-for-changes=<путь> ‑ путь к файлу ConfigDumpInfo.xml, который используется для формирования файла изменений между двумя выгрузками конфигурации.

● --list-file=<файл> ‑ выгрузить только объекты метаданных и/или внешние свойства, указанные в файле, вне зависимости от того были они изменены или нет.

● --server ‑ указывает на необходимость выполнить выгрузку конфигурации в файлы на стороне сервера «1С:Предприятия». В этом случае выгрузка будет выполняться в многопоточном режиме (и будет выполняться быстрее). Для указания количества используемых потоков используется параметр --threads.

Команда игнорируется в случае использования

● автономного сервера,

● агента конфигуратора, работающего с файловым вариантом информационной базы.

● --threads=<количество> ‑ позволяет указать, какое количество одновременно работающих фоновых заданий будет использоваться для выгрузки конфигурации в файлы на стороне сервера. Применимо только одновременно с командой --server.

Значение по умолчанию ‑ auto. В этом случае количество фоновых заданий определяется платформой автоматически, на основании количества ядер процессора на компьютере с кластером серверов «1С:Предприятия».

● --archive=<имя файла> ‑ позволяет выполнить выгрузку конфигурации в файл zip-архива. Этот параметр может использоваться для полной выгрузки, частичной выгрузки, выгрузки всех расширений конфигурации (указан параметр --all-extensions).

● --ignore-unresolved-refs ‑ в выгрузке конфигурации не выгружаются ссылки к недостижимым объектам, т. е. к таким объектам, которые были удалены в одной из предыдущих версий конфигурации.

Команда позволяет выполнить выгрузку внешних обработок или отчетов в xml-файлы. Для команды доступны следующие параметры:

● --file=<файл> ‑ содержит имя файла, который будет выступать в роли корневого файла выгрузки внешней обработки/отчета в формате XML. Параметр является обязательным.

● --ext-file=<файл> ‑ полное имя файла с выгружаемой внешней обработкой (*.epf) или отчетом (*.erf).

● --format=<значение> ‑ определяет формат выгрузки

● hierarchical ‑ иерархический формат выгрузки. Значение по умолчанию.

● plain ‑ линейный формат выгрузки.

Команда позволяет получить идентификатор текущего «поколения» метаданных конфигурации. Подробнее см. здесь.

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

● –-extension ‑ выполняется получение идентификатора метаданных указанного расширения. Если параметр не указан ‑ идентификатор получается для основной конфигурации.

Команда позволяет выполнить загрузку конфигурации или расширения из файла. Для команды доступны следующие параметры:

● --file=<путь> ‑ путь к файлу конфигурации (cf-файл) или расширению (cfe-файл).

● --extension=<имя расширения> ‑ содержит имя расширения, которое будет загружено из файла.

Команда позволяет выполнить загрузку конфигурации из XML-файлов. Для команды доступны следующие параметры:

● --dir=<путь> ‑ содержит путь к каталогу, из которого будет загружена конфигурация. Параметр является обязательным.

● --extension=<имя расширения> ‑ содержит имя расширения, которое будет загружено из файлов.

● --all-extensions ‑ если параметр указан, то из файлов будут загружены все расширения конфигурации.

● --format=<значение> ‑ определяет формат выгрузки

● hierarchical ‑ иерархический формат выгрузки. Значение по умолчанию.

● plain ‑ линейный формат выгрузки.

● --files=<файл[, файл]> ‑ список файлов, которые требуется загрузить. Файла разделяются запятыми. Пути к файлам указываются относительно каталога загрузки. Абсолютные пути не поддерживаются. При использовании параметра --list-file данный параметр не используется.

● --list-file=<файл> ‑ путь к файлу, в котором перечислены загружаемые файлы. Одна строка соответствует одному файлу. Пути к файлам указываются относительно каталога загрузки. Абсолютные пути не поддерживаются. При использовании параметра --files, данный параметр не используется.

● --update-config-dump-info ‑ после окончания загрузки создать в директории файл ConfigDumpInfo.xml, соответствующий загруженной конфигурации.

● --no-check ‑ указывает, что при загрузке конфигурации не требуется проводить проверку целостности загружаемой конфигурации. Это сокращает время загрузки, если инициатор команды уверен, что загружается заведомо целостная конфигурация.

● --archive=<файл> ‑ содержит имя ZIP-архива из которого будет выполняться загрузка файлов. Для успешного выполнения команды должен быть указан или параметр --dir, или данный параметр. Одновременное указание параметра --dir и данного параметра не допускается.

● --partial ‑ при загрузке конфигурации из файлов выполняется загрузка только для тех элементов описания объекта конфигурации, который указан как файл. Такими файлами могут быть:

● Файл описания объекта метаданных (без его внешних свойств).

● Файл внешнего свойства (форма и т. д.).

● Файл модуля формы (без файла описания самой формы).

Команда позволяет выполнить загрузку внешних обработок или отчетов из xml-файлов. Для команды доступны следующие параметры:

● --file=<файл> ‑ содержит имя файла, который является корневым файлом выгрузки внешней обработки/отчета в формате XML. Параметр является обязательным.

● --ext-file=<файл> ‑ полное имя файла с загружаемой внешней обработкой (*.epf) или отчетом (*.erf).

Команда позволяет снимать конфигурация с поддержки. Допустимо использование следующих параметров:

● --disable-support ‑ указывает на необходимость снятия конфигурации с поддержки. При отсутствии параметра генерируется ошибка.

● --force ‑ выполнить снятие конфигурации с поддержки даже в том случае, если в конфигурации запрещены изменения. При отсутствии параметра будет сгенерирована ошибка, если попытка снятия с поддержки будет выполняться для конфигурации, для которой в интерактивном режиме управления поддержкой запрещены изменения.

Команда позволяет сохранить конфигурацию для создания мобильного приложения в XML-файл. Для команды доступны следующие параметры:

● --file=<имя файла> ‑ определяет имя файла, в который будет сохранена конфигурация.

Команда позволяет сформировать цифровую подпись конфигурации мобильного клиента. Для команды доступны следующие параметры:

● --file=<имя файла> ‑ определяет имя файла, в котором расположен закрытый ключ, который используется для формирования подписи.

Команда позволяет сохранить конфигурацию для создания мобильного клиента в XML-файл. Для команды доступны следующие параметры:

● --file=<имя файла> ‑ определяет имя файла, в котором расположен закрытый ключ, который используется для формирования подписи.

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

● --configuration-type=<тип конфигурации> ‑ местоположение подписываемого расширения конфигурации. Параметр может принимать следующие значения:

● extension-configuration ‑ расширение конфигурации.

● extension-db-configuration ‑ расширение конфигурации, расположенное в базе данных.

● extension-configuration-repository ‑ расширение конфигурации, расположенное в хранилище расширения конфигурации.

● file ‑ файл расширения конфигурации.

● --name=<имя расширения> ‑ имя расширения. Используется, если типа конфигурации принимает одно из следующих значений: extension-configuration, extension-db-configuration, extension-configuration-repository.

● --version=<версия > ‑ версия расширения конфигурации в хранилище. Используется при указании типа конфигурации extension-configuration-repository.

● --digisign=<имя файла с параметрами лицензирования> ‑ позволяет указать параметры лицензирования рабочего места пользователя.

● --file=<путь к cfe-файлу> ‑ путь к файлу с подписываемым расширением. Используется при указании типа конфигурации file.

● --signed-file=<путь к cfe-файлу> ‑ путь к результирующему файлу.

Команда позволяет выполнить обновление конфигурации базы данных. Для команды доступны следующие параметры:

● --prompt-confirmation ‑ определяет необходимость запроса у пользователя подтверждения о принятии изменений при реструктуризации информационной базы.

● --dynamic-enable ‑ сначала выполняется попытка динамического обновления, если она завершена неудачно, будет запущено фоновое обновление.

● --dynamic-disable ‑ указание данного параметра запрещает динамическое обновление.

● --warnings-as-errors ‑ при указании данного параметра все предупреждения, которые могут возникнуть при обновлении конфигурации базы данных, будут считаться ошибками.

● --background-start ‑ при указании данного параметра будет запущено фоновое обновление конфигурации, а текущий сеанс будет завершен.

● --background-cancel ‑ при указании данного параметра происходит отмена запущенного фонового обновления конфигурации базы данных.

● --background-finish ‑ при указании данного параметра запущенное фоновое обновление конфигурации базы данных будет завершено. При этом на базу данных будет наложена монопольная блокировка и проведена финальная фаза обновления. Допускается одновременное использование параметров session-terminate и session-terminate-message.

● --background-resume ‑ при указании данного параметра система продолжает фоновое обновление конфигурации базы данных, приостановленное ранее.

● --server ‑ данный параметр указывает, что обновление конфигурации базы данных необходимо выполнить на стороне сервер «1С:Предприятия».

● --extension=<имя расширения> ‑ имя расширения.

● --session-terminate=<назначение> ‑ завершение активных сеансов в случае необходимости установки эксклюзивной блокировки информационной базы. Параметр может использоваться при обновлении как основной конфигурации, так и при обновлении расширения. Может использоваться как для интерактивного, так и для фонового обновления конфигурации.

Допустимые значения:

● disable ‑ запрещено (значение по умолчанию);

● prompt ‑ запрос пользователя;

● force ‑ принудительное завершение сеансов.

● --session-terminate-message=<сообщение> ‑ задает текст сообщения о причине завершения сеанса для отображения на стороне отключаемого клиента. Может использоваться как для интерактивного, так и для фонового обновления конфигурации.

При выполнении команды update-db-cfg используется следующий алгоритм работы:

● В том случае, если невозможно монопольно заблокировать базу данных и динамическое обновление возможно (не указан параметр --dynamic-disable) ‑ пользователю будет предложен выбор между отменой операции, динамическим обновлением и повтором попытки установить монопольных режим.

● Если выбрана повтор попытки установки монопольного режима, и указан параметр --session-terminate=prompt, то пользователю будет предложен выбор между отменой операции, повтором попытки установки монопольного режима и завершением сеансов, препятствующих обновлению информационной базы.

● Если выбрано завершение сеансов, то пользователю будет предложено подтвердить свой выбор или отказаться от выполнения операции. Если выбор подтверждается, то сеансы завершают и выполняется процесс обновления конфигурации информационной базы.

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

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

● выполняется определение списка измененных объектов;

● полученный список отображается в консоли;

● если указана необходимость подтверждения пользователя на принятие изменений (параметр --prompt-confirmation) ‑ пользователю задается соответствующий вопрос;

● если ответ на вопрос отрицательный ‑ обновление отменяется с выдачей соответствующего уведомления;

● если ответ утвердительный или запрос не требовался или параметр --prompt-confirmation не указан ‑ обновление продолжается штатным образом.

Группа команд config extensions предназначена для управления расширениями с помощью режима агента.

Команда предназначена для создания расширения в информационной базе. Расширение создается пустым. Для загрузки расширения следует использовать команду config load-cfg или config load-config-from-files. Допустимо использование следующих параметров:

● --extension=<имя> ‑ задает имя расширения. Параметр является обязательным.

● --name-prefix=<префикс> ‑ задает префикс имени для расширения. Параметр является обязательным.

● --synonym=<синоним> ‑ синоним имени расширения. Многоязычная строка в формате функции Nstr().

● --purpose=<назначение> ‑ назначение расширения:

● customization ‑ назначение Адаптация (значение по умолчанию);

● add-on ‑ назначение Дополнение;

● patch ‑ назначение Исправление.

Команда предназначена для удаления расширения из информационной базы. Допустимо использование следующих параметров:

● --extension=<имя> ‑ задает имя удаляемого расширения.

● --all-extensions ‑ указывает, что необходимо удалить все расширения.

Группа команд config extensions properties позволяет задавать и получать свойства расширения.

Команда предназначена для получения свойств расширения, расположенного в информационной базе. Допустимо использование следующих параметров:

● --extension=<имя> ‑ задает имя расширения, для которого необходимо получить свойства.

● --all-extensions ‑ указывает, что необходимо получить свойства всех расширений, загруженных в информационную базу.

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

● --extension=<имя> ‑ задает имя расширения, для которого необходимо установить свойства.

● --active=<режим> ‑ определяет активность расширения. <Режим> может принимать следующие значения:

● yes ‑ расширение активно.

● no ‑ расширение не активно.

● --safe-mode=<режим> ‑ определяет работу в безопасном режиме:

● yes ‑ расширение работает в безопасном режиме.

● no ‑ расширение работает в небезопасном режиме. В этом случае имя профиля безопасности автоматически сбрасывается (имя профиля устанавливается равным пустой строке).

● --security-profile-name=<профиль> ‑ определяет имя профиля безопасности, под управлением которого работает расширение. Если задается имя профиля безопасности, то автоматически устанавливается и признак работы в безопасном режиме.

● --unsafe-action-protection=<режим> ‑ определяет режим защиты от опасных действий:

● yes ‑ защита от опасных действий в расширении включена.

● no ‑ защита от опасных действий в расширении отключена.

● --used-in-distributed-infobase=<режим> ‑ определяет возможность работы расширения в распределенной информационной базе:

● yes ‑ расширение используется в распределенной информационной базе.

● no ‑ расширение не используется в распределенной информационной базе.

● --scope=<область действия> ‑ область действия расширения:

● infobase ‑ расширение действительно для всей информационной базы.

● data-separation ‑ расширение действительно для области данных.

Команды группы infobase-tools отвечают за получение сервисной информации об информационной базе.

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

C помощью данной команды получить информацию о настройках отладчика для информационной базы. Для получения доступны следующие параметры настроек отладчика:

● enabled ‑ признак включения отладки.

● protocol ‑ протокол отладки: tcp или http.

● server-address ‑ адрес сервера отладки для данной информационной базы.

Команда предназначена для выполнения выгрузки информационной базы в dt-файл. Допустимо использование следующих параметров:

● --file=<имя файла> ‑ определяет имя dt-файла.

Команда выполняет удаление данных информационной базы.

Команда предназначена для выполнения загрузки информационной базы из dt-файла. После выполнения операции, агент конфигуратора выполняется следующие действия:

● В текстовом формате: выдается интерактивное предупреждение о необходимости повторного подключения к агенту конфигуратора.

● В формате JSON-сообщений: формируется сообщение о необходимости повторного подключения к агенту конфигуратора.

● Сеанс работы с информационной базы завершается.

● SSH-соединение разрывается.

● Агент конфигуратора не перезапускается и ожидает повторного подключения.

Допустимо использование следующих параметров:

● --file=<имя файла> ‑ определяет имя dt-файла.

В том случае, если установлен формат вывода в виде JSON-сообщений, сервер всегда будет возвращать массив из различной комбинации следующих значений:

● Имя: type, обязательное.

● Возможные значения: log | success | error | canceled | question | dbstru | loading-issue | progress | extension-info.

● Описывает тип сообщения:

● log ‑ информационное сообщение.

● success ‑ операция успешно завершена.

● error ‑ операция завершена с ошибкой.

● canceled ‑ операция отменена.

● question ‑ вопрос пользователю.

● dbstru ‑ информация о процессе реструктуризации.

● loading-issue ‑ ошибки и предупреждения, накопленные за время загрузки конфигурации из файлов.

● progress ‑ информация о прогрессе выполнения команды.

● extension-info ‑ информация о расширении, которое находится в информационной базе.

● Имя: error-type

● Возможные значения: отсутствуют.

● Содержит тип ошибки, которая возникла при выполнении команды:

● UnknownError ‑ неизвестная ошибка.

● DesignerNotConnectedToInfoBase ‑ соединение с информационной базой не установлено.

● DesignerAlreadyConnectedToInfoBase ‑ соединение с информационной базой уже установлено.

● CommandFormatError ‑ неверный формат команды.

● DBRestructInfo ‑ ошибка реструктуризации базы данных.

● InfoBaseNotFound ‑ информационная база не найдена.

● AdministrationAccessRightRequired ‑ для выполнения операции требуются административные права.

● ConfigFilesError ‑ ошибки в процессе загрузки/выгрузки конфигурации из/в файла.

● DesignerAlreadyStarted ‑ обнаружен запущенный конфигуратор.

● InfoBaseExclusiveLockRequired ‑ требуется исключительная блокировка информационной базы.

● LanguageNotFound ‑ язык не обнаружен.

● ExtensionWithDataIsActive ‑ расширение конфигурации активно и содержит данные.

● ExtensionNotFound ‑ расширение не обнаружено.

● Имя: message

● Возможные значения: отсутствуют.

● Содержит локализованное сообщение об ошибке.

● Имя: body

● Возможные значения: JSON-сообщение.

● Содержание данного значения зависит от конкретной операции.

Некоторые команды могут требовать для своего исполнения существенного времени. Имеется возможность настроить режим агента таким образом, что прогресс выполнения команды будет отображаться или в виде сообщений, или непосредственно на экране консоли. Настройка отображения прогресса выполняется с помощью команды options set (подробнее см. здесь).

Команды оповещают информацию о прогрессе, только в том случае, если в настройках включен соответствующий режим. Частота обновления информации также устанавливается параметром настроек. Прогресс измеряется в процентах. Если за интервал времени прогресс не изменился, то сообщение не отправляется.

Отображение прогресса поддерживают следующие команды:

● dump-config-to-files;

● load-config-from-files;

● dump-external-data-processor-or-report-to-files;

● load-external-data-processor-or-report-from-files;

● dump-cfg;

● load-cfg;

● update-db-cfg.

При настройке SSH-клиента PuTTY рекомендуется выполнить следующие настройки:

● Группа параметров Terminal:

● параметр Local echo ‑ Force on;

● параметр Local line ending ‑ Force on.

● Группа параметров Window ‑ Translation:

● параметр Remote character set ‑ UTF-8.

● Группа параметров Connection ‑ SSH ‑ TTY:

● включить параметр Don`t allocate a pseudo-terminal.

Приложение 1С:Предприятие ‑ оповещение и запуск (далее «агент клиентского приложения») предназначено для получения сообщений от сервера системы взаимодействия, а также для централизованного отображения оповещений. При этом сообщения получаются и отображаются также и в том случае, если само приложение (для которого предназначено сообщение) в данный момент не запущено. Агент клиентского приложения, кроме накопления и отображения оповещений, позволяет быстро переходить к клиентскому приложению, для которого поступило сообщение, а также управлять отображением оповещений. Если приложение не запущено, агент выполняет запуск этого приложения. Также агент клиентского приложения, будучи запущенным, заменяет все пиктограммы информационных баз, которые (в ОС Windows) находятся в системном лотке панели задач, на единственную пиктограмму агента.

Агент клиентского приложения поставляется в следующих вариантах:

● исполняемый файл для ОС Windows в 32-разрядном варианте;

● исполняемый файл для ОС Linux в 32‑ и 64-разрядном вариантах;

● расширение веб-браузера для Google Chrome, Mozilla Firefox в 32‑ и 64-разрядном вариантах (в зависимости от разрядности используемого веб-браузера), а также расширение Microsoft Internet Explorer в 32-разрядном варианте.

При установке «1С:Предприятия» (кроме отдельного дистрибутива тонкого клиента) дистрибутив агента клиентского приложения размещается в:

● Для ОС Windows: каталоге ExtDst конкретной версии.

● Для ОС Linux: каталоге ExtDst конкретной версии.

Файл пакета агента имеет имя вида 1c-enterprise-client-application-agent-a.b.c.d.arch, где:

● a.b.c.d ‑ это полный номер версии агента, расположенного в пакете, который соответствует номеру в виде a.b.c.d.

● arch ‑ архитектура утилиты. Может принимать следующие значения:

● ОС Windows:

● x86 ‑ 32-разрядная версия агента.

● ОС Linux:

● i386 ‑ 32-разрядная версия агента;

● x86_64 ‑ 64-разрядная версия агента.

Для ОС Windows пакет имеет расширение .exe, для ОС Linux ‑ .sh.

Установка агента инициируется запуском соответствующего установочного пакета вручную, с помощью встроенного языка или из диалога настроек системы взаимодействия клиентского приложения. Агент клиентского приложения устанавливается в следующие каталоги:

● ОС Windows:

● 32-разрядная система в 64-разрядной ОС: %PROGRAMFILES(x86)%\1C\1CE\1cecla\ecs_ver_<api-version>.

● В остальных случаях: %PROGRAMFILES%\1C\1CE\1cecla\ecs_ver_<api-version>.

● ОС Linux:

● ~/bin/1cecla/ecs_ver_<api-version> (вне зависимости от разрядности ОС).

● Выражение <api-version> представляет собой цифру, равную версии протокола взаимодействия с сервером системы взаимодействия.

Имя исполняемого файла агента клиентского приложения: 1cecla.

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

Если во время установки платформы «1С:Предприятие» обнаруживается, что агент клиентского приложения установлен, то выполняется определение версии установленного агента. В том случае, если версия установленного приложения агента меньше версии агента, который поставляется с устанавливаемой платформой, то выполняются следующие действия:

● устанавливается (обновляется) агент клиентского приложения до актуальной версии;

● обновляется расширение веб-браузера, если это необходимо;

● выполняется перезапуск агента клиентского приложения, если он был запущен перед установкой новой версии платформы «1С:Предприятие».

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

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

Для доступа к программному интерфейсу агента клиентского приложения служит менеджер агента клиентского приложения, который доступен через свойство глобального контекста АгентКлиентскогоПриложения.

С помощью программного интерфейса может выполнять следующие действия:

● выполнить установку агента;

● проверить наличие новых версий агента;

● получать/устанавливать представление клиентского приложения в контекстном меню агента;

● подключать/отключать текущее клиентское приложение от агента;

● подключать/отключать обработчик изменения состояния агента.

Подключение агента к запущенному клиентскому приложению выполняется автоматически, по факту запуска клиентского приложения. Однако если возникает необходимость, чтобы агент клиентского приложения отображал оповещения и в том случае, если клиентское приложение в данный момент не запущено, то следует воспользоваться методом АгентКлиентскогоПриложения.НачатьПодключение(). Фактическое состояние подключения можно получить с помощью обработчика, который подключается методом АгентКлиентскогоПриложения.ОтключитьОбработчикИзмененияСостояния(). Для изменения представления приложения в списке агента следует использовать методы АгентКлиентскогоПриложения.ПолучитьНаименованиеПриложения()/АгентКлиентскогоПриложения.УстановитьНаименованиеПриложения().

Автономный сервер управляется с помощью конфигурационного файла и параметров командной строки. Параметры командной строки имеют приоритет над параметрами конфигурационного файла. Это означает, что если какой-то параметр указан и в командной строке, и в конфигурационном файле, то автономный сервер использует значение параметра, указанное в командной строке.

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

ibsrv [--parameter[=value]] [--parameter[=value]]

Где:

● parameter ‑ задаваемый параметр автономного сервера. Список доступных параметров перечислен в следующей таблице.

● value ‑ значение параметра, если таковое требуется для используемого параметра.

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

Для того, чтобы получить справочную информацию о параметрах запуска автономного сервера, можно использовать командную строку вида:

ibsrv --help

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

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

● Автономный сервер (см. здесь).

● Конфигурационный файл автономного сервера (см. здесь).

Утилита администрирования автономного сервера является инструментом, позволяющим управлять автономным сервером и выполнять различные административные действия.

Параметры командной строки имеют приоритет над параметрами конфигурационного файла. Это означает, что если какой-то параметр указан и в командной строке, и в конфигурационном файле, то утилита администрирования использует значение параметра, указанное в командной строке.

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

ibcmd mode command [command] [--parameter[=value]] [--parameter[=value]]

Где:

● mode ‑ режим работы утилиты администрирования.

● command ‑ команда режима работы. Некоторые режимы работы могут использовать «многословные» команды, т. е. команды, которые состоят из нескольких идентификаторов. Например, команды вида ibcmd infobase config load.

● parameter ‑ задаваемый параметр команды утилиты администрирования. Список доступных параметров перечислен в таблице, которая соответствует конкретной команде выбранного режима, далее в разделе.

● value ‑ значение параметра, если таковое требуется для используемого параметра.

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

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

ibcmd --version

Для того, чтобы получить справочную информацию о параметрах запуска утилиты администрирования, можно использовать командную строку вида:

ibcmd --help

Утилита администрирования выводит справочную информацию одним фрагментом по каждому режиму. В данном разделе параметры разбиты по командам. Все параметры упорядочены по алфавиту. Если параметр является обязательным, то он выделяет подчеркиванием, например:

Утилита администрирования может управлять как работающим экземпляром автономного сервера, так и автономным сервером, находящимся в offline-режиме (подробнее о способах управления см. здесь). Для подключения к автономному серверу, утилите администрирования необходимо указать параметры этого подключения. Эти параметры можно разбить на две группы.

Первая группа параметров предназначена для указания данных работающего экземпляра автономного сервера. Эти параметры могут использоваться для всех команд утилиты администрирования, кроме отдельных команд, про которые будет сказано по месту.

Вышеперечисленные параметры не содержат параметров базы данных, используемой СУБД и т. д. Это происходит потому, что работающий автономный сервер работает с какой-то СУБД и базой данных. Это означает, что утилита администрирования может воспользоваться этими знаниями для своей работы.

Другая группа параметров описывает подключение к автономному серверу, который находится в offline-режиме. Эта группа параметров значительно более объемна, т. к. многие команды утилиты администрирования работают непосредственно с информационной базы. Значит надо указать все параметры, которые необходимы для того, чтобы подключиться к базе данных, которая управляется какой-либо СУБД.

Данный список параметров (по составу и сути) подобен списку параметров собственно автономного сервера (ibsrv), но имеет более ограниченный состав. Это определено спецификой утилиты администрирования ‑ для ее работы нужны только параметры доступа к информационной базе, но не требуется указывать ряд других настроек (например, параметры доступа с помощью протокола HTTP).

При работе в offline-режиме будут недоступны режимы session и lock утилиты администрирования, т. к. у неработающего автономного сервера отсутствуют сеансы и блокировки.

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

Управление конфигурацией автономного сервера.

Команда выполняет инициализацию конфигурации автономного сервера.

Команда предназначена для импорта конфигурации автономного сервера из реестра существующего кластера серверов «1С:Предприятия».

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

● Файл default.vrd (см. здесь).

Режим управления информационной базой.

Описание общих параметров команды см. здесь.

С помощью данной команды выполняется создание информационной базы.

С помощью команды можно выгрузить информационную базу в dt-файл. Данная операция не является операцией резервного копирования базы данных.

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

● Резервное копирование базы данных (см. здесь).

Данная команда позволяет загрузить информационную базу из dt-файла.

С помощью данной команды можно очистить текущую информационную базу.

С помощью данной команды можно настроить и запустить операцию конвертации клиент-серверной информационной базы из одной СУБД в другую без выгрузки в промежуточный формат (dt-файл). Команда не позволяет выполнить репликацию из файловой базы в клиент-серверную базу по соображениям безопасности.

Группа команд предназначена для управление конфигурацией информационной базы.

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

Предоставляет возможность выгрузить конфигурацию информационной базы.

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

Позволяет выполнить обновление конфигурации базы данных.

Восстанавливает рабочую конфигурацию из конфигурации базы данных.

Команда позволяет выполнить попытку восстановления конфигурации после незавершенной операции.

С помощью команд этой группы предоставляется возможность выгрузить конфигурацию информационной базы в xml-файлы. Поддерживается только иерархический формат.

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

● Выгрузка конфигурации в xml-файлы (см. здесь).

Данные параметры применимы ко всем команды группы export.

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

● ConfigDumpInfo.xml (см. здесь).

Формирует файл ConfigDumpInfo.xml, содержащий информацию о состоянии конфигурации.

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

● ConfigDumpInfo.xml (см. здесь).

Отобразить информацию об изменениях между конфигурацией информационной базы и конфигурацией, расположенной в каталоге выгрузки. Информация о конфигурации в каталоге выгрузки расположена в файле ConfigDumpInfo.xml.

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

● ConfigDumpInfo.xml (см. здесь).

Данная команда позволяет выгрузить в xml-файлы выбранные объекты конфигурации.

Выгрузить в xml-файлы все расширения конфигурации.

Команды данной группы позволяют загружать объекты конфигурации из xml-файлов иерархического формата.

Данные параметры применимы ко всем команды группы import.

Загрузить из xml-файлов объекты конфигурации.

Загрузить из xml-файлов все расширения конфигурации.

Группа команд предназначена для настройки поддержки конфигурации информационной базы.

Команда предназначена для снятия с поддержки конфигурации информационной базы.

Данная группа команд предназначена для получения информации о разделителях информационной базы.

Выводит список разделителей информационной базы. Команда не имеет параметров.

Данная группа команд предназначена для работы с расширениями конфигурации данной информационной базы.

Создать расширение в информационной базе.

Получить информацию о расширении.

Получить список расширений информационной базы. Команда не имеет параметров.

Установить значения свойств у выбранного расширения.

Удаление расширений из информационной базы.

Получить идентификатор поколения конфигурации.

Выполнить цифровую подпись конфигурации или расширения.

Команды данного режима полностью эквивалентны (по списку и параметрам) командам ibcmd infobase config. Подробнее см. здесь.

Следующие команды будут полностью эквивалентны:

ibcmd config load …
ibcmd infobase config load …

Команды данного режима полностью эквивалентны (по списку и параметрам) командам ibcmd infobase config extension. Подробнее см. здесь.

Следующие команды будут полностью эквивалентны:

ibcmd extension update …
ibcmd infobase extension update …

Режим работы с мобильным приложением

Выполняет экспорт конфигурации мобильного приложения.

Команда доступна только при включении режима расширенной функциональности конфигурирования (параметр extended-designer-features конфигурационного файла автономного сервера, см. здесь).

Режим работы с мобильным клиентом.

Выполняет экспорт конфигурации мобильного клиента.

Команда доступна только при включении режима расширенной функциональности конфигурирования (параметр extended-designer-features конфигурационного файла автономного сервера, см. здесь).

Выполняет цифровую подпись конфигурации мобильного клиента.

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

Позволяет получить информацию о выбранном сеансе информационной базы.

Позволяет получить список сеансов информационной базы.

Предоставляет возможность принудительно завершить сеанс информационной базы.

Позволяет принудительно завершить текущий серверный вызов.

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

Позволяет получить список блокировок информационной базы.

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

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

Команда выполняет выгрузку модели событий журнала регистрации в виде XSD-схемы с целевым URI пространства имён http://v8.1c.ru/eventLog. Версия схемы (атрибут version) соответствует версии платформы 1С:Предприятие. Команда не выполняет подключение к информационной базе, поэтому не требует соответствующих параметров для работы.

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

Позволяет выполнить очистку неиспользуемых данных во встроенном хранилище двоичных данных.

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

Выполняет создание полной резервной копии встроенного хранилища двоичных данных.

Получение информации о хранилище двоичных данных. Один из параметров должен быть указан обязательно.

Получение списка всех подключенных хранилищ двоичных данных.

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

Выполняет восстановление встроенного хранилища двоичных данных из полной резервной копии.

Сервер отладки (dbgs) может быть запущен как приложение, «демон» или служба операционной системы. Как приложение сервер отладки может быть запущен под управлением любой поддерживаемой операционной системы. Как «демон» сервер отладки может быть запущен только под управлением ОС Linux. Как служба операционной системы сервер отладки может работать только под управлением ОС Windows.

При необходимости вручную запускать сервер отладки, следует использовать командную строку, в которой могут быть указаны следующие команды:

dbgs --version|--help      --service|--daemon --addr=<host> --port=<port>|--range=<range> --ownerPID=<PID> --password=<pwd> --notify=<file> --debugServerUsers=<file>

Описание команд:

При запуске сервера отладки в качестве службы или «демона», следует помнить, что через такой сервер отладки можно отлаживать предметы отладки информационных баз в файловом варианте и клиентские предметы отладки клиент-серверных информационных баз. Не поддерживается отладка серверных предметов отладки клиент-серверных информационных баз через сервер отладки, работающий в режиме службы или «демона».

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

● Сервер отладки (см. здесь).

Для того чтобы зарегистрировать сервер отладки в качестве службы ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл register-dbgs.bat:

@echo off
rem %1 - полный номер версии 1С:Предприятия
rem %2 - сетевой порт подключения к серверу отладки
set DbgsUserName=<пользователь сервера отладки>
set DbgsUserPwd=<пароль пользователя сервера отладки>
set SrvcName="Debug Server %2"
set BinPath="\"C:\Program Files\1cv8\%1\bin\dbgs.exe\" --service --port=%2%"
set Desctiption="1C:Enterprise 8.3 Debug Server. Parameters: %1, port: %2"
sc stop %SrvcName%
sc delete %SrvcName%
sc create %SrvcName% binPath= %BinPath% start= auto obj= %DbgsUserName% password= %DbgsUserPwd% displayname= %Desctiption%

Перед применением данного командного файла необходимо указать в нем данные реального пользователя (имя и пароль) от имени которого будет работать служба сервера отладки (строки set DbgsUserName= и set DbgsUserPwd=).

При запуске данного командного файла используются следующие параметры:

1. Полный номер версии системы «1С:Предприятие», из который будет использован сервер отладки.

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

Пример запуска командного файла (требуются права администратора):

register-dbgs.bat 8.3.25.100 1550

После запуска командного файла с такими параметрами будут выполнены следующие действия:

● Имя службы: Debug Server 1550.

● Используемая версия «1С:Предприятия»: 8.3.24.100.

● Командная строка запуска службы: "C:\Program Files\1cv8\8.3.25.100\bin\dbgs.exe" --service --port=1550.

● Отображаемое имя: 1C:Enterprise 8.3 Debug server. Parameters: 8.3.24.100, port: 1550.

● Режим запуска службы: Автоматический.

Для того чтобы отменить регистрацию службы сервера отладки ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл unregister-dbgs.bat:

@echo off
rem %1 - сетевой порт подключения к серверу отладки
set SrvcName="Debug Server %1"
sc stop %SrvcName%
sc delete %SrvcName%

При запуске данного командного файла используются следующие параметры:

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

Пример запуска командного файла (требуются права администратора):

unregister-dbgs 1550

Командный файл останавливает службу и удаляет ее регистрацию. Имя службы формируется по тем же правилам, что и при регистрации новой (нестандартной) службы сервера отладки «1С:Предприятия».

Агент сервера (ragent) может быть запущен как приложение, «демон» или служба операционной системы. Как приложение или служба агент сервера может быть запущен под управлением любой поддерживаемой операционной системы. Как «демон» агент сервера может быть запущен только под управлением ОС Linux.

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

./ragent /daemon /instsrvc /rmsrvc /start /stop /usr <значение> /pwd <значение> /port <значение> /regport <значение> /range <значение> /seclev <значение> /d <значение> /pingPeriod <значение> /pingTimeout <значение> /debug -<значение> /debugServerAddr <значение> /debugServerPort <значение> /debugServerPwd <значение> /debugServerUsers <значение>

В описании команд следует обращать внимание на колонку «ОС». В этой колонке указывается применимость команды при запуске под управлением операционной системы Linux (в колонке указана буква «L») или Windows (в колонке указана буква «W»). Если в колонке ничего не указано, значит команда может использоваться в любой поддерживаемой операционной системе.

В строке запуска могут использоваться следующие команды:

Указанные значения для команд /pingPeriod и /pingTimeout используются для всех исходящих соединений процессов кластера на данном сервере, запуск которых выполнялся через этот процесс агента сервера.

Если кластер содержит несколько рабочих серверов, и целесообразно изменить значения периода и таймаута по умолчанию, то рекомендуется:

● устанавливать значение таймаута проверки в 3-10 раз больше периода проверки;

● не устанавливать значение периода проверки меньше 1 000 миллисекунд;

● на всех серверах, включенных в один кластер, указывать одинаковые значения периода и таймаута проверки.

Остановка агента сервера, запущенного как приложение, выполняется нажатием клавиш Ctrl + C.

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

● Запуск кластера серверов (см. здесь).

Для того чтобы зарегистрировать агент сервиса в качестве службы ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл register-agent.bat:

@echo off
rem %1 - полный номер версии 1С:Предприятия
rem %2 - первые две цифры номеров портов. Для портов 1540,1541,1560:1591 - это цифра 15
rem %3 - каталог с данными реестра кластера
set SrvUserName=<имя пользователя>
set SrvUserPwd=<пароль пользователя>
set RangePort=%260:%291
set BasePort=%241
set CtrlPort=%240
set SrvcName="Server Agent %CtrlPort% %1"
set BinPath="\"C:\Program Files\1cv8\%1\bin\ragent.exe\" /srvc /agent /regport %BasePort% /port %CtrlPort% /range %RangePort% /d \"%~3\" /debug"
set Desctiption="1C:Enterprise 8.3 Server Agent. Parameters: %1, ragent port: %CtrlPort%, rmngr port: %BasePort%, range: %RangePort%"
if not exist "%~3" mkdir "%~3"
sc stop %SrvcName%
sc delete %SrvcName%
sc create %SrvcName% binPath= %BinPath% start= auto obj= %SrvUserName% password= %SrvUserPwd% displayname= %Desctiption% depend= Dnscache/Tcpip/Tcpip6/lanmanworkstation/lanmanserver

Перед применением данного командного файла необходимо указать в нем данные реального пользователя (имя и пароль) от имени которого будет работать служба кластера серверов (строки set SrvUserName= и set SrvUserPwd=).

При запуске данного командного файла используются следующие параметры:

1. Полный номер версии системы «1С:Предприятие», из который будет использован сервер отладки.

2. Первые две цифры номеров сетевых портов, которые использует кластер серверов, запускаемый данным агентом сервиса. Для портов 1540, 1541, 1560:1591 ‑ это цифра 15.

3. Каталог данных реестра кластера.

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

● Строка Server Agent,

● Номер сетевого порта главного менеджера кластера,

● Полный номер версии «1С:Предприятия».

При регистрации сервера версии 8.3.27.100, использующего сетевой порт главного менеджера кластера с номером 2540, имя службы будет выглядеть следующим образом: Server Agent 2540 8.3.27.100.

Пример запуска командного файла (требуются права администратора):

register-agent 8.3.27.100 25 "c:\cluster_data\cluster 1"
register-agent 8.3.27.100 35 "c:\cluster_data\cluster 2"

В данном примере первая строка выполняет регистрацию службы сервера со следующими параметрами:

● Имя службы: Server Agent 2540 8.3.27.100;

● Порты сервера: 2540, 2541, 2560:2591;

● Каталог с данными реестра кластера: C:\cluster_data\cluster 1;

● Описание службы: 1C:Enterprise 8.3 Server Agent. Parameters: 8.3.27.100, ragent port: 2540, rmngr port: 2541, range: 2560:2591.

Вторая строка выполняет регистрацию службы сервера со следующими параметрами:

● Имя службы: Server Agent 3540 8.3.27.100;

● Порты сервера: 3540, 3541, 3560:3591;

● Каталог с данными реестра кластера: C:\cluster_data\cluster 2;

● Описание службы: 1C:Enterprise 8.3 Server Agent. Parameters: 8.3.27.100, ragent port:3540, rmngr port: 3541, range: 3560:3591.

Для того чтобы отменить регистрацию службы сервера отладки ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл unregister-agent.bat:

@echo off
rem %1 - полный номер версии 1С:Предприятия
rem %2 - первые две цифры номеров портов. Для портов 1540,1541,1560:1591 - это цифра 15
set SrvcName="Server Agent %240 %1"
sc stop %SrvcName%
sc delete %SrvcName%

При запуске данного командного файла используются следующие параметры:

1. Полный номер версии системы «1С:Предприятие», из который будет использован сервер отладки.

2. Первые две цифры номеров сетевых портов, которые использует кластер серверов, запускаемый данным агентом сервиса. Для портов 1540, 1541, 1560:1591 ‑ это цифра 15.

Пример запуска командного файла (требуются права администратора):

unregister-agent 8.3.27.100 25

Командный файл останавливает службу и удаляет ее регистрацию. Имя службы формируется по тем же правилам, что и при регистрации новой (нестандартной) службы сервера «1С:Предприятия».

Сервер администрирования (ras) может быть запущен как приложение, «демон» или служба операционной системы. Как приложение сервер администрирования может быть запущен под управлением любой поддерживаемой операционной системы. Как «демон» сервер администрирования может быть запущен только под управлением ОС Linux. Как служба операционной системы сервер администрирования может работать только под управлением ОС Windows.

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

ras cluster --port=<port> --monitor-address=<address> --monitor-base=<location> --monitor-port=<port> <host[:port]>

Команды строки запуска сервера администрирования (ras) в ОС Windows и ОС Linux идентичны и имеют следующее значение:

Обязательными параметрами служит параметр cluster (с аналогичным выделением в таблице выше).

Для аутентификации в кластере используется аутентификация «1С:Предприятия».

Для того чтобы зарегистрировать сервер администрирования в качестве службы ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл register-ras.bat:

@echo off
rem %1 - полный номер версии 1С:Предприятия
rem %2 - номер сетевого порта сервера администрирования
rem %3 - имя экземпляра кластера серверов
rem %4 - номер сетевого порта агента сервера
set RasUserName=<имя пользователя>
set RasUserPwd=<пароль пользователя>
set SrvcName="Remote Server %2"
set BinPath="\"C:\Program Files\1cv8\%1\bin\ras.exe\" cluster --service --port=%2 %3:%4"
set Desctiption="1C:Enterprise 8.3 Remote Server. Parameters: %1, port: %2, cluster: %3:%4"
sc stop %SrvcName%
sc delete %SrvcName%
sc create %SrvcName% binPath= %BinPath% start= auto obj= %RasUserName% password= %RasUserPwd% displayname= %Desctiption%

Перед применением данного командного файла необходимо указать в нем данные реального пользователя (имя и пароль) от имени которого будет работать служба кластера серверов (строки set RasUserName= и set RasUserPwd=).

При запуске данного командного файла используются следующие параметры:

1. Полный номер версии системы «1С:Предприятие», из который будет использован сервер отладки.

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

3. Имя экземпляра кластера серверов, к которому будет подключаться сервер администрирования.

4. Номер сетевого порта агента сервера, к которому будет подключаться сервер администрирования.

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

● Строка Remote Server,

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

При регистрации сервера администрирования версии 8.3.27.100, использующего сетевой порт с номером 1545, имя службы будет выглядеть следующим образом: Remote Server 1545.

Пример запуска командного файла (требуются права администратора):

register-ras 8.3.27.100 1545 localhost 1540

В данном примере первая строка выполняет регистрацию службы сервера со следующими параметрами:

● Имя службы: Remote Server 1545;

● Порт сервера администрирования: 1545;

● Имя экземпляра кластера серверов: localhost;

● Порт агента кластера: 1540;

● Описание службы: 1C:Enterprise 8.3 Remote Server. Parameters: 8.3.27.100, port: 1545, cluster: localhost:1540.

● Режим запуска службы: Автоматический.

Для того чтобы отменить регистрацию службы сервера отладки ОС Windows, можно воспользоваться следующим командным файлом (или взять его за основу для дальнейшей модернизации):

Файл unregister-ras.bat:

@echo off
rem %1 - полный номер версии 1С:Предприятия
rem %1 - номер сетевого порта сервера администрирования
set SrvcName="Remote Server %1"
sc stop %SrvcName%
sc delete %SrvcName%

При запуске данного командного файла используются следующие параметры:

1. Первые две цифры номеров сетевых портов, которые использует кластер серверов, запускаемый данным агентом сервиса. Для портов 1540, 1541, 1560:1591 ‑ это цифра 15.

Пример запуска командного файла (требуются права администратора):

unregister-ras 25

Командный файл останавливает службу и удаляет ее регистрацию. Имя службы формируется по тем же правилам, что и при регистрации новой (нестандартной) службы сервера «1С:Предприятия».

Утилита webinst предназначена для настройки веб-серверов с целью поддержки работы веб-клиента. Утилита работает в среде ОС Windows и Linux, и входит в состав дистрибутива системы «1С:Предприятие».

webinst [-publish]|-delete <веб-сервер> -wsdir <виртуальный каталог> -dir <физический каталог> -connstr <строка соединения> -confpath <путь к файлу httpd.conf> -descriptor <путь к файлу default.vrd> [-osauth]

Для выполнения публикации утилита должна запускаться от имени администратора. При работе в ОС Windows будет выполняться запрос на повышение привилегий.

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

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

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

● Использование утилиты webinst (351).