Конфигурация и расширения

/DumpCfg <имя cf-файла> [-Extension <Имя расширения>]

Выполняет сохранение конфигурации или расширения конфигурации в файл. Сохранение конфигурации расширения выполняется при корректном указании параметра -Extension.

/LoadCfg <имя cf-файла> [-Extension <Имя расширения>]

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

/MergeCfg <имя cf- или cfe-файла> -Settings <имя файла настроек> [-EnableSupport | -DisableSupport] [-IncludeObjectsByUnresolvedRefs | -ClearUnresolvedRefs] [-Extension <Имя расширения>] [-force]

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

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

• <имя cf- или cfe-файла> – имя файла с конфигурацией (cf-файл) или расширением (cfe-файл) для объединения;
• -Settings <имя файла настроек> – позволяет указать имя файла с настройками объединения конфигураций;
• -EnableSupport – поставить конфигурацию на поддержку, если имеется возможность объединения с постановкой на поддержку (правила поддержки должны быть указаны в файле настроек);
• -DisableSupport – не выполнять постановку на поддержку, даже если такая возможность имеется;
• -IncludeObjectsByUnresolvedRefs – если в настройках объединения имеются объекты, не включенные в список объединения и отсутствующие в основной конфигурации, но на которые имеются ссылки из объектов, включенных в список, такие объекты также помечаются для объединения и выполняется попытка продолжить объединение. Попытки выполняются, пока не останется объектов со ссылками на невключенные объекты или пока не будет выбрана вся конфигурация. Аналогично кнопке Отметить все для объединения в окне с неразрешенными ссылками, но с повторением попыток;
• -ClearUnresolvedRefs – ссылки на объекты, не включенные в список объектов для объединения, будут очищены. Аналогично кнопке Продолжить в окне с неразрешенными ссылками;
• -Extension <Имя расширения> – имя расширения, с которым будет выполняться объединение;

• -force – выполнять объединение при наличии:

  • предупреждений об удалении объектов, на которые имеются ссылки в объектах, не участвующих в объединении (такие объекты будут исключены из объединения);
  • предупреждения о применении настроек.
• Если параметр не указан, объединение будет прервано в вышеуказанных случаях.

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

Если имеется возможность поставить конфигурацию на поддержку, указан параметр -EnableSupport, но в файле настроек нет элемента SupportRules, устанавливаются следующие правила поддержки:

• Новые объекты поставщика:

  • Объектам с правилом поставщика Изменения разрешены устанавливается правило поддержки Объект поставщика не редактируется.
  • Объектам с правилом поставщика Изменения не рекомендуются устанавливается правило поддержки Объект поставщика не редактируется.

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

  • Объектам с правилом поставщика Изменения разрешены устанавливается правило поддержки Объект поставщика не редактируется.
  • Объектам с правилом поставщика Изменения не рекомендуются устанавливается правило поддержки Объект поставщика не редактируется.

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

  • Объектам с правилом поставщика Изменения разрешены устанавливается правило поддержки Объект редактируется с сохранением поддержки.
  • Объектам с правилом поставщика Изменения не рекомендуются устанавливается правило поддержки Объект редактируется с сохранением поддержки.

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

Предупреждения выводятся в файл вывода служебных сообщений независимо от -force.

/CompareCfg -FirstConfigurationType <тип конфигурации> [-FirstName <имя конфигурации>] [-FirstFile <путь к файлу>] [-FirstVersion <номер версии>] -SecondConfigurationType <тип конфигурации> [-SecondName <имя конфигурации>] [-SecondFile <путь к файлу>] [-SecondVersion <номер версии>] [-MappingRule <правило>] [-Objects <имя файла>] -ReportType <тип отчета> [-IncludeChangedObjects] [-IncludeDeletedObjects] [-IncludeAddedObjects] -ReportFormat <тип формата> -ReportFile <имя файла>

Выполняет сравнение двух конфигураций и формирует файл с отчетом о сравнении.

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

• -FirstConfigurationType <тип конфигурации> – тип первой конфигурации для сравнения. Параметр может принимать следующие значения:

  • MainConfiguration – основная конфигурация;
  • DBConfiguration – конфигурация базы данных;
  • VendorConfiguration – конфигурация поставщика;
  • ExtensionConfiguration – расширение конфигурации;
  • ExtensionDBConfiguration – расширение конфигурации из базы данных;
  • ConfigurationRepository – конфигурация из хранилища конфигурации;
  • ExtensionConfigurationRepository – расширение конфигурации из хранилища конфигурации;
  • File – файл конфигурации/расширения конфигурации.

• -FirstName <дополнительный идентификатор> – имя первой конфигурации. Значение параметра может принимать следующие значения в зависимости от значения параметра /FirstConfigurationType:

  • VendorConfiguration – имя конфигурации поставщика;
  • ExtensionConfiguration – имя расширения конфигурации;
  • ExtensionDBConfiguration – имя расширения конфигурации из базы данных.

Для других значений параметра /FirstConfigurationType этот параметр не применяется.

• -FirstFile – путь к файлу конфигурации (.cf) или расширения конфигурации (.cfe). Этот параметр имеет смысл только тогда, когда параметр -FirstConfigurationType имеет значение File.
• -FirstVersion – версия хранилища конфигурации. Этот параметр имеет смысл только тогда, когда параметр -FirstConfigurationType имеет значение ConfigurationRepository или ExtensionConfigurationRepository.
• -SecondConfigurationType <тип конфигурации> – тип второй конфигурации для сравнения. Значения параметра полностью эквивалентны значениям параметра -FirstConfigurationType.
• -SecondName <дополнительный идентификатор> – имя второй конфигурации. Полностью аналогично параметру -FirstName.
• -SecondFile – путь к файлу конфигурации (.cf) или расширения конфигурации (.cfe). Полностью аналогично параметру -FirstFile.
• -SecondVersion – версия хранилища конфигурации. Полностью аналогично параметру -FirstVersion.

• -MappingRule <правило> – правило установления соответствий объектов для случаев, когда конфигурации не находятся в отношениях «родитель-потомок»:

  • ByObjectName – по именам объектов (используется по умолчанию);
  • ByObjectIDs – по внутренним идентификаторам.
• -Objects <имя файла> – путь к файлу со списком объектов, которые будут участвовать в операции. Если файл указан, в операции участвуют только указанные в файле объекты, иначе участвует вся конфигурация.
• -IncludeChangedObjects – включать в отчет измененные подчиненные объекты.
• -IncludeDeletedObjects – включать в отчет удаленные подчиненные объекты.
• -IncludeAddedObjects – включать в отчет добавленные подчиненные объекты.

• -ReportType <тип отчета> – тип отчета о сравнении:

  • Brief – краткий отчет;
  • Full – полный отчет.

• -ReportFormat <тип формата> – определяет формат файла отчета:

  • txt – текстовый документ;
  • mxl – табличный документ.
• -ReportFile <имя файла> – определяет имя файла, в который будет помещен отчет о сравнении.

/UpdateDBCfg [-Dynamic<Режим>] [-BackgroundStart] [-BackgroundCancel] [-BackgroundFinish [-Visible]] [-BackgroundSuspend] [-BackgroundResume] [-WarningsAsErrors] [-Server] [-v1|-v2] [-Extension <Имя расширения>]

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

Следует учитывать, что механизм фонового обновления не связан с выбором механизма реструктуризации. Если указано выполнение фонового обновления, выбор варианта механизма реструктуризации (-v1|-v2) будет проигнорирован.

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

• -Dynamic<Режим> – признак использования динамического обновления. Возможны следующие варианты режима:

  • - – явно запрещает динамическое обновление;
  • + – разрешает динамическое обновление. Сначала выполняется попытка обычного обновления, а в случае неудачи – попытка динамического обновления. При отсутствии параметра -Dynamic+ или при использовании -Dynamic без указания режима также выполняется динамическое обновление.
• -BackgroundStart – запускает фоновое обновление конфигурации базы данных и завершает работу. Если дополнительно указан параметр -Dynamic или -Dynamic+, сначала выполняется попытка динамического обновления, а в случае ее неудачного завершения запускается фоновое обновление.
• -BackgroundCancel – отменяет ранее запущенное фоновое обновление конфигурации базы данных.
• -BackgroundFinish – завершает фоновое обновление конфигурации базы данных, выполняя фазу принятия изменений: осуществляется попытка установить монопольную блокировку базы данных и выполнить финальную фазу. Если установлен флажок -Visible, при невозможности завершить фоновое обновление, то есть перейти к фазе принятия изменений, выводится диалоговое окно с кнопками Отменить, Повторить, Завершить сеансы и повторить. Если флажок не установлен, выполнение завершается с ошибкой.
• -BackgroundSuspend – приостанавливает фоновое обновление конфигурации базы данных.
• -BackgroundResume – продолжает ранее приостановленное фоновое обновление конфигурации базы данных.
• -WarningsAsErrors – все предупреждающие сообщения будут трактоваться как ошибки.

• -Server – обновление выполняется на сервере и имеет смысл только в клиент-серверном варианте работы. Если параметр используется вместе с фоновым обновлением, то:

  • фаза актуализации всегда выполняется на сервере;
  • фаза обработки и фаза принятия изменений могут выполняться как на клиенте, так и на сервере;
  • разрешено запускать фоновое обновление на стороне клиента, а завершать на стороне сервера, или наоборот;
  • оптимизированный механизм реструктуризации не используется: параметр -v2 игнорируется, если он указан.
• -v1|-v2 – определяет версию используемого механизма реструктуризации. Если версия механизма реструктуризации не указана (-v1 или -v2), будет использоваться механизм реструктуризации той версии, которая указана в файле conf.cfg на стороне клиентской прикладной программы. Иначе будет использована указанная версия механизма. Если указан оптимизированный механизм реструктуризации, но его использование конфликтует с другими параметрами, будет использован обычный механизм реструктуризации.
• -Extension <Имя расширения> – будет выполнено обновление указанного расширения.

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

• если в командной строке явно указана версия механизма реструктуризации, будет использоваться указанный механизм;
• если в командной строке нет значения версии механизма реструктуризации, будет использоваться механизм реструктуризации, заданный параметром UpdateDBCfg в файле conf.cfg на стороне клиентской программы.
• в любом случае параметр -Server означает, что реструктуризация будет выполняться на сервере. Эта команда не влияет на выбор используемого механизма реструктуризации.

Параметр /UpdateDBCfg разрешено указывать после параметров:

• /LoadCfg;
• /UpdateCfg;
• /ConfigurationRepositoryUpdateCfg;
• /LoadConfigFiles;
• /LoadConfigFromFiles;
• /MobileAppUpdatePublication;
• /MobileAppWriteFile;
• /MobileClientDigiSign;
• /MobileClientWriteFile.

/DumpDBCfg <имя cf/cfe-файла> [-Extension <Имя расширения>]

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

/DumpDBCfgList [-Extension <Имя расширения>] [-AllExtensions]

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

• -Extension – выводит имя указанного расширения;
• -AllExtensions – выводит имена всех расширений.

/RollbackCfg

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

При указании параметра -Extension произойдет возврат к конфигурации, сохраненной в базе данных, для указанного расширения.

/DeleteCfg [-Extension <Имя расширения>] [-AllExtensions]

Выполняет удаление расширения с указанным именем. Указание параметра -AllExtensions приведет к удалению всех расширений. Использование команды без параметра недопустимо.

/DumpConfigFiles <каталог выгрузки> [-Module] [-Template] [-Help] [-AllWritable] [-Picture] [-Right] [-Extension <Имя расширения>]

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

• <каталог выгрузки> – каталог расположения файлов свойств;
• -Module – признак необходимости выгрузки модулей;
• -Template – признак необходимости выгрузки макетов;
• -Help – признак необходимости выгрузки справочной информации;
• -AllWritable – признак выгрузки свойств только объектов, доступных для записи;
• -Picture – признак выгрузки общих картинок;
• -Right – признак выгрузки прав;
• -Extension – выгрузка будет выполнена для указанного расширения.

/LoadConfigFiles <каталог загрузки> [-Module] [-Template] [-Help] [-AllWritable] [-Picture] [-Right] [-Extension <Имя расширения>]

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

• <каталог загрузки> – каталог расположения файлов свойств;
• -Module – признак необходимости загрузки модулей;
• -Template – признак необходимости загрузки макетов;
• -Help – признак необходимости загрузки справочной информации;
• -AllWritable – признак загрузки свойств только объектов, доступных для записи;
• -Picture – признак загрузки общих картинок;
• -Right – признак загрузки прав;
• -Extension – загрузка будет выполнена в указанное расширение. Если расширение подключено к хранилищу, загружаемые объекты должны быть захвачены в хранилище.

Если команда пакетного режима запуска выполнена успешно, возвращается код 0, иначе – 1 (101 – при наличии ошибок в данных).

/DumpConfigToFiles <каталог выгрузки> [-Format <режим>] [-Extension <Имя расширения>] [-AllExtensions] [-update] [-force] [-getChanges <имя файла>] [-configDumpInfoForChanges <имя файла>] [ -listFile <имя файла>] [-configDumpInfoOnly]

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

• -Format – определяет формат выгрузки конфигурации в файлы:

  • Plain – линейный формат;
  • Hierarchical – иерархический формат (по умолчанию).
• -Extension – выполняется выгрузка указанного расширения.
• -AllExtensions – выгружаются все расширения, но основная конфигурация не выгружается. Каждое расширение выгружается в каталог со своим именем.
• -update – указывает на необходимость обновить ранее выполненную выгрузку, то есть будут выгружены только те объекты, версии которых отличаются от версий ранее выгруженных объектов.
• Файл версий (ConfigDumpInfo.xml) будет получен из текущего каталога выгрузки. Если текущая версия формата выгрузки не совпадает с версией формата в файле версий или файл версий не найден, будет сгенерирована ошибка. После завершения выгрузки файл версий обновляется.

• Возможно совместное использование с параметрами:

  • -force – если текущая версия формата выгрузки не совпадает с версией формата в файле версий, выполняется полная выгрузка;
  • -configDumpInfoForChanges – если текущий каталог выгрузки перед началом работы не пустой, будет сгенерирована ошибка. Соответствие текущей версии формата выгрузки и версии формата выгрузки в файле версий не проверяется. Во время выгрузки генерируется новый файл версий. Файл, указанный в параметре -configDumpInfoForChanges, не изменяется.
• -force – выполнить полную выгрузку при обнаружении расхождений между текущей версией формата выгрузки, полученной при попытке обновления, и версией формата, записанной в файле версий (ConfigDumpInfo.xml). Используется только вместе с параметром -update. В других случаях игнорируется.
• -getChanges <имя файла> – в указанном файле будет сформирован список изменений текущей конфигурации относительно выгрузки версии, каталог которой является параметром команды /DumpConfigToFiles. Для этого параметра имя файла является обязательным.
• Может использоваться вместе с параметром -configDumpInfoForChanges; в таком случае изменения будут вычислены относительно файла версий (ConfigDumpInfo.xml), указанного в этом параметре. Если при использовании параметра -configDumpInfoForChanges файл версий не найден, будет сгенерирована ошибка.
• -configDumpInfoForChanges <имя файла> – указывает файл версий (ConfigDumpInfo.xml), который будет использован для сравнения изменений. Для этого параметра указание полного имени файла версий является обязательным.
• Этот параметр используется только совместно с параметрами -update и -getChanges.
• -listFile <имя файла> – указывает файл со списком объектов, которые будут выгружены независимо от того, были ли они изменены. Для этого параметра имя файла является обязательным.
• Объекты из списка будут полностью выгружены, за исключением подчиненных объектов, которые являются отдельными объектами разработки. Для выгрузки таких подчиненных объектов их следует указать в списке.
• Если объект из списка имеет подчиненные объекты, которые не являются отдельными объектами разработки, но имеют внешние свойства, внешние свойства таких объектов также будут выгружены.
• В файле, содержащем имена объектов для выгрузки, можно указать идентификатор Configuration, который является эквивалентом корня конфигурации. Если в файле имеется идентификатор Configuration, после которого не указано имя корневого объекта конфигурации, при выгрузке этот идентификатор будет эквивалентен полному имени корневого объекта конфигурации, то есть запись вида Configuration.Help эквивалентна записи Configuration.ИмяКонфигурации.Help.
• Можно одновременно использовать полные и сокращенные варианты написания имен: только с идентификатором Configuration или с полным именем корневого объекта конфигурации. При необходимости выгрузки двух внешних свойств корневого объекта конфигурации, например Help и Splash, в файле со списком объектов можно указать следующие строки:

Configuration.Help
Configuration.ИмяКонфигурации.Splash

• Этот параметр используется только отдельно от других параметров.
• -configDumpInfoOnly – указание этого параметра означает, что при выгрузке формируется только файл версий (ConfigDumpInfo.xml). Если в командной строке указан параметр -format, файл версий будет сформирован для указанного формата выгрузки. По умолчанию файл версий формируется для иерархического формата выгрузки.
• Этот параметр может сочетаться только с параметром -format. Сочетание с другими параметрами недопустимо.

/LoadConfigFromFiles <каталог загрузки> [-Extension <Имя расширения>] [-AllExtensions] -files «<файлы>» -listFile <файлСписка> -Format <режим> [-updateConfigDumpInfo]

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

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

• -Extension – выполняется загрузка указанного расширения. Если расширения нет, оно будет создано. Если расширение подключено к хранилищу, полная загрузка такого расширения не поддерживается. Возможна частичная загрузка, если загружаемые объекты захвачены в хранилище конфигурации расширения.
• -AllExtensions – выполняется загрузка расширений из файлов. Каждый подкаталог в этом каталоге считается расширением. Параметр несовместим с параметрами -files или -listFile.
• -files – указывает, какие файлы должны быть загружены при частичной загрузке конфигурации из файлов. Каждый файл может быть указан как с полным путем, так и с путем относительно каталога загрузки. Список файлов должен быть указан в кавычках, файлы перечисляются через запятую. Параметр несовместим с параметром -AllExtensions.
• -listFile – описывает файл, содержащий список файлов для загрузки. В списке каждая строка должна содержать только одно имя файла, а имя может быть как полным, с указанием полного пути к файлу, так и с путем относительно каталога загрузки. Строки должны разделяться символом перевода строки. Перевод строки поддерживается как в варианте Windows, так и в варианте Linux. Файл должен быть в кодировке UTF-8. Пустые строки не поддерживаются. Строка может быть пропущена, если начинается с REM. Параметр несовместим с параметром -AllExtensions.

• -Format – определяет формат выгрузки конфигурации в файлы:

  • Plain – линейный формат;
  • Hierarchical – иерархический формат (по умолчанию).
• Параметр используется только вместе с параметрами -files или -listFile.
• -updateConfigDumpInfo – указывает, что в конце загрузки в каталоге будет создан файл версий (ConfigDumpInfo.xml), который будет соответствовать загруженной конфигурации. Если выполняется частичная загрузка, то есть используются параметры -files или -listFile, имеющийся файл версий будет обновлен.
• При одновременном указании параметров -files и -listFile будет использован параметр, который в командной строке указан первым.