Параметры WorkspaceConsole
Glossary Item Box
Общие сведения
Утилита WorkspaceConsole — это консольное приложение, предназначенное для выполнения различных операций с пакетами bpm'online. Наиболее часто используемые операции, выполняемые с помощью утилиты:
- Выгрузка пакетов из среды разработки в файловую систему для переноса в среду тестирования или продуктовую среду. Пакеты сохраняются в виде zip-архивов.
- Установка новых пакетов при обновлении или при переносе из среды разработки.
- Выгрузка и загрузка ресурсов и наполнения схем для локализации.
- Создание и перенос рабочих пространств между приложениями.
- Работа с конфигурационными схемами.
Поскольку утилита WorkspaceConsole многофункциональна, ее необходимо запускать на выполнение с определенными параметрами. Значения параметров передаются в качестве аргументов командной строки при запуске утилиты. Параметры предназначены для конфигурирования WorkspaceConsole при выполнении определенной операции. Имена параметров утилиты не чувствительны к регистру.
Параметры WorkspaceConsole
Параметр -help
Справка о параметрах запуска. Результат выполнения WorkspaceConsole с этим параметром — полный перечень параметров с их кратким описанием. Если указать другие параметры, то они будут проигнорированы.
Парметр -operation
Название операции, которую необходимо выполнить. Обязательный параметр. Значение по умолчанию — LoadLicResponse. Основные операции приведены в таблице 1.
Табл. 1. — Параметры WorkspaceConsole
Операция | Описание |
---|---|
LoadLicResponse | Загружает лицензии в базу данных, указанную в строке подключения. Единственная операция, которая не требует указания параметра -workspaceName. |
SaveRepositoryContent | Сохраняет указанное в параметре -contentTypes содержимое zip-архивов пакетов из каталога, указанного в параметре -sourcePath, в каталог, указанный в параметре -destinationPath. |
SaveDBContent | Сохраняет содержимое базы данных в файловую систему. Тип содержимого определяется значением параметра -contentTypes. Место в файловой системе, куда будет выгружено содержимое, определяется параметром -destinationPath. Требует указания одного из параметров -webApplicationPath или -configurationPath. |
SaveVersionSvnContent | Выгружает иерархию пакетов в виде zip-архивов в каталог -destinationPath из нескольких хранилищ SVN, перечисленных через запятую в параметре -sourcePath. |
RegenerateSchemaSources | Выполняет перегенерацию исходных кодов и их компиляцию. |
InstallFromRepository |
Загружает в конфигурацию последнюю версию структуры и метаданных пакетов из zip-архивов. При необходимости выполняются привязанные SQL-скрипты, перегенерация исходных кодов, установка привязанных данных. Работает только с измененными или новыми пакетами и их элементами. Требует указания одного из параметров -webApplicationPath или -configurationPath. |
InstallBundlePackages | Устанавливает набор пакетов, перечисленных через запятую в параметре -packageName, в рабочее пространство, указанное в параметре -workspaceName. Требует указания одного из параметров -webApplicationPath или -configurationPath. |
PrevalidateInstallFromRepository | Проверяет возможность установки пакетов из zip-архивов. |
ConcatRepositories | Cлияние нескольких репозиториев в один. |
ConcatSVNRepositories | Cлияние нескольких хранилищ SVN. |
ExecuteProcess | Выполняет запуск бизнес-процесса в конфигурации, если он будет найден. |
UpdatePackages | В базе данных приложения выполняет обновление пакетов (параметр -packageName), которые присутствуют в иерархии пакета продукта (параметр -productPackageName). Требует указания одного из параметров -webApplicationPath или -configurationPath. |
BuildWorkspace |
Компилирует рабочее пространство (конфигурацию). Используется при разработке схем с помощью VisualStudio (см. "Работа с серверным кодом в Visual Studio"). |
ReBuildWorkspace |
Полностью перекомпилирует рабочее пространство (конфигурацию). Используется при разработке схем с помощью Visual Studio (см. "Работа с серверным кодом в Visual Studio"). |
UpdateWorkspaceSolution | Обновляет решение и файлы проекта Visual Studio (см. "Работа с серверным кодом в Visual Studio"). |
BuildConfiguration | Выполняет генерацию статического контента в файловую систему (см. "Статический клиентский контент в файловой системе"). Используемые параметры -workspaceName, -destinationPath, -webApplicationPath, -logPath, -force. При значении true параметра -force выполняется генерация контента по всем схемам, а при значении false — только по измененным. |
Параметр -user
Имя пользователя для авторизации. Указывается, если эта информация отсутствует в конфигурационном файле утилиты либо необходимо выполнить операцию от имени другого пользователя.
Параметр -password
Пароль пользователя для авторизации. Указывается, если эта информация отсутствует в конфигурационном файле утилиты либо необходимо выполнить операцию от имени другого пользователя.
Параметр -workspaceName
Имя рабочего пространства (конфигурации), в котором выполняется операция.
Параметр -autoExit
Указывает, завершать ли автоматически процесс утилиты после выполнения операции. Принимает значения true или false. По умолчанию — false.
Параметр -processName
Имя процесса, который необходимо запустить.
Параметр -repositoryUri
Адрес хранилища SVN для хранения структуры и метаданных пакетов. Необязательный параметр. Если он не пустой, то перекрывает аналогичное свойство конфигурации, указанное в параметре -workspaceName.
Параметр -sourceControlLogin
Имя пользователя для доступа к хранилищу SVN.
Параметр -sourceControlPassword
Пароль пользователя для доступа к хранилищу SVN.
Параметр -workingCopyPath
Локальный каталог для рабочей копии пакетов, хранящихся в SVN.
Параметр -contentTypes
Типы содержимого (например, ресурсов) которые необходимо извлечь из пакетов. Возможные значения приведены в таблице 2.
Табл. 2. — Возможные значения типов содержимого
Тип содержимого | Описание |
---|---|
SystemData | Данные системных схем в формате JSON. Выгружаются все системные схемы и их колонки, кроме указанных в параметре -excludedSchemas. |
ConfigurationData | Данные конфигурационных схем в формате JSON. Выгружаются все конфигурационные схемы, кроме указанных в параметре -excludedSchemas. |
Resources | Ресурсы конфигурационных схем для локализации в формате XML. |
LocalizableData | Наполнение конфигурационных схем для локализации в формате XML. Выгружаются только текстовые колонки. Дополнительные ограничения указываются в параметрах -excludedSchemas и -excludedSchemaColumns. |
Repository | Данные рабочего пространства в формате zip. |
SqlScripts | SQL-скрипты, привязанные к пакетам. |
Data | Данные как системных, так и конфигурационных схем в формате JSON. Комбинация значений SystemData и ConfigurationData. |
LocalizableSchemaData |
Данные локализиемых объектов. |
All | Все типы содержимого. |
Параметр -sourcePath
Путь к локальному каталогу на диске, из которого необходимо забрать данные (например, пакеты, схемы или ресурсы). Для операций ConcatRepositories и SaveVersionSvnContent может принимать несколько значений, указанных через запятую.
Параметр -destinationPath
Путь к локальной папке на диске, в которую необходимо сохранить данные (например, пакеты, схемы или ресурсы).
Параметр -webApplicationPath
Путь к каталогу на диске, в который установлено приложение bpm'online. По этому пути из файла ConnectionStrings.config будет считана информация по соединению с базой данных. Если параметр не указан, то будет установлено соединение с базой данных, указанной в строке соединения в конфигурационном файле утилиты. Если указан — соединение будет установлено с базой данных, указанной в файле ConnectionStrings.config приложения bpm’online.
Параметр -configurationPath
Путь к подкаталогу Terrasoft.Configuration в каталоге, в который установлено приложение. Например, C:\bpmonline7.11.1\Terrasoft.WebApp\Terrasoft.Configuration. В этот каталог выгружаются исходные коды и ресурсы схем пользовательских пакетов в режиме разработки в файловой системе.
Параметр -filename
Имя файла. Обязательный параметр для операции LoadLicResponse.
Параметр -excludedSchemas
Названия схем, которые необходимо исключить из операции.
Параметр -excludedSchemaColumns
Названия колонок схем, которые необходимо исключить из операции.
Параметр -excludedWorkspaceNames
Названия рабочих пространств (конфигураций), которые необходимо исключить из операции.
Параметр -includedSchemas
Названия схем, которые принудительно используются при выполнении операции.
Параметр -includedSchemaColumns
Названия колонок схем, которые принудительно используются при выполнении операции.
Параметр -cultureName
Код культуры. Обязательный, если используются значения Resources и/или LocalizableData для параметра -contentTypes.
Параметр -schemaManagerNames
Имена менеджеров схем, которые используются для операций. Значение по умолчанию — EntitySchemaManager.
Параметр -packageName
Имя пакета из рабочего пространства, указанного в параметре -workspaceName, который будет использоваться для операции. Важно, что также будут задействованы все пакеты, от которых он зависит. Необязательный параметр. Если он не указан, то будут задействованы все пакеты рабочего пространства.
Параметр -clearWorkspace
Указывает на необходимость очистки рабочего пространства перед обновлением. Принимает значения true или false. Значение по умолчанию — false.
Параметр -installPackageSqlScript
Указывает на необходимость выполнения SQL скриптов до и после сохранения пакетов. Принимает значения true или false. Значение по умолчанию — true.
Параметр -installPackageData
Указывает на необходимость установки привязанных к пакету данных после сохранения пакетов. Принимает значения true или false. Значение по умолчанию — true.
Параметр -updateDBStructure
Указывает на необходимость обновления структуры базы данных после сохранения пакетов. Принимает значения true или false. Значение по умолчанию — true.
Параметр -regenerateSchemaSources
Указывает на необходимость перегенерации исходных кодов после сохранения пакетов. Принимает значения true или false. Значение по умолчанию — true.
Параметр -continueIfError
Указывает на необходимость прервать выполнение процесса установки при получении первой ошибки. Если значение параметра — true, то процесс установки пройдет до конца, а пользователь получит список всех возникших ошибок. Принимает значения true или false. Значение по умолчанию — false.
ВАЖНО Особенностью выполнения операций InstallFromSvn и InstallFromRepository является то, что они работают с измененными или новыми пакетами и их элементами. Информация об измененных элементах получается на основании сравнения новой и существующей структур пакетов. По этой причине, если пользователь выполняет команду (например, InstallFromSvn) без указания ключа continueIfError=true и получает ошибку (например, при обновлении структуры базы данных), то повторный запуск команды для той же конфигурации выполнится без ошибок, но не внесет изменения в базу данных. Причина — предыдущая операция синхронизировала структуры пакетов указанной конфигурации и хранилища, и измененных элементов пакетов в этой операции нет. |
Параметр -skipCompile
Указывает на необходимость выполнения этапа компиляции. Работает только в случае, если для параметра -updateDBStructure установлено значение false. Принимает значения true или false. Значение по умолчанию — false.
Параметр -autoUpdateConfigurationVersion
Обновляет значение версии конфигурации в базе данных до версии приложения bpm'online. Принимает значения true или false. Значение по умолчанию — false.
Параметр -warningsOnly
При обнаружении ошибки выполнения операции утилита WorkspaceConsole только информирует об ошибке. Принимает значения true или false. Значение по умолчанию — false.