Описание и примеры использования SolutionConsole

Описание и примеры использования SolutionConsole

Создано: 12 октября 2011 – 12:48 alexserg

Предназначение и миссия

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

Описание и назначение параметров

1. Основные обязательные параметры

На основании этих параметров происходит соединение с базой и конфигурацией.

-solution=<Название конфигурации>
Допустимые значения:
<Название конфигурации> - конфигурация над которой будет выполнятся операция
<*> - имя конфигурации не указано. Логин будет осуществляться на прямую в базу без привязки к конфигурации. Доступны будут только системные схемы.
Обязательность: нет

-user=<Имя пользователя>
Допустимые значения:
<Имя пользователя> - имя пользователя системы имеющего права доступа к конфигурации
<Имя пользователя> - имя пользователя базы данных в случае когда - solution=*
Обязательность: да

-password=<Пароль пользователя>
Допустимые значения:
<Пароль пользователя> - пароль пользователя системы имеющего права доступа к конфигурации
<Пароль пользователя> - пароль пользователя базы данных в случае когда - solution=*
Обязательность: да

2. Параметр операции

-operation=<Название операции>
Описание:
Параметр, определяющий операцию, которую будет осуществлять утилита.
Допустимые значения:
<ExtractSolutionData> - выгрузка конфигурации
<LoadSolutionData> - загрузка выгруженной ранее конфигурации
<LoadSystemDBData> - загрузка выгруженных ранее данных только для системных схем
<UpdateConfigurationDBStructureAndData> - обновляет структуру таблиц и данные в текущей базе данных для конфигурационных схем выгруженными ранее данными
<UpdateSystemDBStructureAndData> - обновляет структуру таблиц и данные в текущей базе данных для системных схем выгруженными ранее данными
<UpdateConfigurationRightsDBStructure> - обновляет структуру таблиц прав для конфигурационных схем
<ReGenerateSchemaSources> - Требует уточнения
<GenerateUpdateSystemDBStructureSqlText> - генерирует Sql скрипт обновления структуры системных таблиц на основании выгруженных ранее данных о схемах
<GenerateUpdateSystemDBDataSqlText> - генерирует Sql скрипт обновления данных системных таблиц на основании выгруженных ранее данных
<ReGenerateSchemaMetaData> - Требует уточнения

Опции операций:

-destinationPath=<Путь к папке>
Описание:
Путь к папке, в которую будет осуществляться выгрузка или из которой будет происходить загрузка файлов данных.
Допустимые значения:
<Путь к папке> - путь к папке хранения файлов данных используемых утилитой
Обязательность: да

-includedSchemas=<Имя схемы, Имя схемы, Имя схемы,…>
Описание:
Список схем, для которых необходимо выполнить операцию. В случае отсутствия параметра операция выполняется для всех схем
Допустимые значения:
<Имя схемы> - имя схемы
<Имя схемы, Имя схемы, Имя схемы,…> - список схем через запятую
Обязательность: нет

-contentTypes=<Тип данных для операции>|<Тип данных для операции>|…
Описание:
Определяет тип данных, которые необходимо выгрузить или загрузить. Можно указать несколько типов через знак «|».
Допустимые значения:
<Source> - исходники схем. Расширение файлов “*.cs”
<MetaData> - метаданные схем. Расширение файлов “*.json”
<Data> - данные хранящиеся в базе для данных схем. Расширение файлов “*.dat”
<Localization> - ресурсы схем. Расширение файлов “*.tsresx”
<CodeReviewData> - данные для CodeReview. Расширение файлов “*. mdcs”
<LocalizableData> - данные схем для локализации. Выгружается или в файл "SolutionLocalizableData. xml" или в файл указанный в параметре –fileName
<ExportData> - метаданные схемы с дополнительной информацией о схеме (состояние, название, имя менеджера). Выгрузка идет напрямую из базы. Расширение файлов “*.md”
<All> - все перечисленные выше типы
Обязательность: нет
Значение по умолчанию:

–fileName=<Путь к файлу>
Допустимые значения:
<Путь к файлу> - путь к файлу для выгрузки данных
Обязательность: нет
Значение по умолчанию: "SolutionLocalizableData. xml"

- foldername=<Имя папки в конфигурации>
Допустимые значения:
<Имя папки в конфигурации> - имя папки в конфигурации в которую будет происходить загрузка выгруженных ранее схем
Обязательность: нет

-readableMetadata=[<true>|<false>]
Описание:
Назначение параметра не ясно и выяснить его назначение не удалось
Обязательность: нет

-useDefRights=[<true>|<false>]
Допустимые значения:
<true> - создавать записи прав по умолчанию при добавлении записи в базу данных для импорта
<false> - не создавать права по умолчанию
Описание:
Добавлять ли права по умолчанию при загрузке данных в базу
Обязательность: нет
Значение по умолчанию: false

-fromModifiedOn=<Дата начала изменения>
Допустимые значения:
<Дата начала изменения> - дата в одном из форматов

"yyyy-MM-dd",
"yyyy-dd-MM",
"yyyy. MM. dd",
"yyyy. dd. MM",
"yyyy/dd/MM",
"yyyy/MM/dd",
"dd. MM. yyyy",
"dd-MM-yyyy",
"dd/MM/yyyy"

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

-toModifiedOn=<Дата окончания изменения>
Допустимые значения:
<Дата начала изменения> - дата в одном из форматов

"yyyy-MM-dd",
"yyyy-dd-MM",
"yyyy. MM. dd",
"yyyy. dd. MM",
"yyyy/dd/MM",
"yyyy/MM/dd",
"dd. MM. yyyy",
"dd-MM-yyyy",
"dd/MM/yyyy"

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

-contentTypes=<Значение типа>
Допустимые значения:
<Schema> - назначение не удалось выяснить
<DB> - назначение не удалось выяснить
Описание:
назначение не удалось выяснить

3. Дополнительные параметры

-logPath=<Путь к папке>
Допустимые значения:
<Путь к папке> - путь к директории в которую будет осуществляться запись лог файлов
Обязательность: нет

Запуск и использование

1. Необходимые условия

1) Для работы утилиты необходимо наличие библиотек проекта. Лучше взять все бинарники
2) Наличие скомпилированного в необходимой разрядности файла утилиты «Terrasoft. Tools. SolutionConsole. exe»
3) Наличие файла настроек «Terrasoft. Tools. SolutionConsole. exe. config» с выполненными настройками для конкретной базы
4) Установленный. Net Framework
5) В случае использования базы Oracle может понадобиться установленный Oracle клиент «\\tsstore\InstallTSDEV\Developing\Oracle Client»

2. Настройка

Необходимо настроить файл «Terrasoft. Tools. SolutionConsole. exe. config» на базу с которой будет осуществляться работа
1) Задаем строку соединения с базой

<connectionStrings>
<add name="mssqlConnection" connectionString="Data Source=tscoredev\MSSQL2008; Initial Catalog=BPMonlineMSSqlDataBaseName; Persist Security Info=True; MultipleActiveResultSets=True; User ID=Supervisor; Password=masterkey; Pooling = true; Max Pool Size = 100" />
<add name="oracleConnection" connectionString="Data Source=(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = TSCDATA_ORA)(PORT = 1522))) (CONNECT_DATA = (SERVICE_NAME = )));User Id=BPMONLINEORACLEUSERNAME;Password=BPMONLINEORACLEUSERNAME;" />
...

2) Оставляем необходимый блок исходя из типа используемой СУБД и указываем необходимое название строки соединения

<db>
<general securityEngineType="Terrasoft. DB. MSSql. MSSqlSecurityEngine, Terrasoft. DB. MSSql"
executorType="Terrasoft. DB. MSSql. MSSqlExecutor, Terrasoft. DB. MSSql"
engineType="Terrasoft. DB. MSSql. MSSqlEngine, Terrasoft. DB. MSSql"
metaEngineType="Terrasoft. DB. MSSql. MSSqlMetaEngine, Terrasoft. DB. MSSql"
metaScriptType="Terrasoft. DB. MSSql. MSSqlMetaScript, Terrasoft. DB. MSSql"
typeConverterType="Terrasoft. DB. MSSql. MSSqlTypeConverter, Terrasoft. DB. MSSql"
connectionStringName="mssqlConnection"
binaryPackageSize="1048576"
currentSchemaName="dbo" />
<!--<general securityEngineType="Terrasoft. DB. Oracle. OracleSecurityEngine, Terrasoft. DB. Oracle"
executorType="Terrasoft. DB. Oracle. OracleExecutor, Terrasoft. DB. Oracle"
engineType="Terrasoft. DB. Oracle. OracleEngine, Terrasoft. DB. Oracle"
metaEngineType="Terrasoft. DB. Oracle. OracleMetaEngine, Terrasoft. DB. Oracle"
metaScriptType="Terrasoft. DB. Oracle. OracleMetaScript, Terrasoft. DB. Oracle"
typeConverterType="Terrasoft. DB. Oracle. OracleTypeConverter, Terrasoft. DB. Oracle"
connectionStringName="oracleConnection"
binaryPackageSize="1048576"
currentSchemaName="BPMONLINEORACLEUSERNAME"/>-->
</db>

3. Запуск

Для запуска рекомендуется создать файл с расширением «*.bat» и задать параметры вызова в нем.
Пример содержания файла:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=TSBpm - user=Guest - password=Guest - operation=UpdateConfigurationRightsDBStructure - logPath=C:\
pause;

Бинарники и файл утилиты находятся в данном примере в папке «SolutionConsole»

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

1. Выгрузка данных всех типов

Выгружаем всю возможную информацию о схемах конфигурации TSBpm в папку C:\UpLoad\Tests с созданием логов в папке C:\UpLoad\Tests\Logs. Выгружаются метаданные, данные таблиц, локализация, ресурсы и т. д.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=TSBpm - user=Guest - password=Guest - operation=ExtractSolutionData - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs
pause;

Структура папок после выгрузки будет соответствовать структуре в дереве папок конфигурации

2. Выгрузка только записей для таблиц схем из базы данных

Выгружаем данные всех схем(включая системные схемы) конфигурации TSBpm в папку C:\UpLoad\Tests с созданием логов в папке C:\UpLoad\Tests\Logs. Выгружаются только данные таблиц.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=TSBpm - user=Guest - password=Guest - operation=ExtractSolutionData - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs - contentTypes=Data
pause;

Пример содержания файла данных:

{"Entities":{"Entity":{"ModifiedOn":"\/Date(1309539468300)\/","Name":"BPMonline CRM"},"Entity":{"Name":"Отчеты"},"Entity":{"CreatedOn":"\/Date(1278920240591)\/","ModifiedOn":"\/Date(1279635431060)\/","Name":"Конфигурационные элементы"},"Entity":{"CreatedOn":"\/Date(1278933279435)\/","ModifiedOn":"\/Date(1278933279435)\/","Name":"Города"},"Entity":{"CreatedOn":"\/Date(1278933296591)\/","ModifiedOn":"\/Date(1278933296591)\/","Name":"Страны"},"Entity":{"CreatedOn":"\/Date(1279089334159)\/","ModifiedOn":"\/Date(1279089334159)\/","Name":"Категории контрагентов"},"Entity":{"CreatedOn":"\/Date(1279089360551)\/","ModifiedOn":"\/Date(1279089360551)\/","Name":"Количество сотрудников контрагента"},"Entity":{"CreatedOn":"\/Date(1279089385974)\/","ModifiedOn":"\/Date(1279089385974)\/","Name":"Отрасли
....

3. Загрузка данных для системных таблиц

Загружаем данные всех системных схем из папки C:\UpLoad\Tests с созданием логов в папке C:\UpLoad\Tests\Logs. Загружаются только данные системных таблиц. Логин и пароль указываем для пользователя базы данных.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=* - user=Supervisor - password=masterkey - operation=LoadSystemDBData - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs - contentTypes=Data
pause;

4. Загрузка данных для конфигурационных таблиц

Загружаем данные всех конфигурационных схем конфигурации TSBpm из папки C:\UpLoad\Tests с созданием логов в папке C:\UpLoad\Tests\Logs. Загружаются только данные таблиц.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=TSBpm - user=Guest - password=Guest - operation=LoadSolutionData - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs - contentTypes=Data
pause;

5. Загрузка данных и обновление структуры системных таблиц

Обновляется структура системных таблиц в базе данных и загружаются данные из папки C:\UpLoad\Tests, если они есть.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=* - user=Supervisor - password=masterkey - operation=UpdateSystemDBStructureAndData - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs - contentTypes=Data
pause;

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

Обновляется структура конфигурационных таблиц на основании метаданных хранящихся в базе(возможно загруженных ранее в системные таблицы) и загружаются данные таблиц из папки C:\UpLoad\Tests, если они есть.
Параметры запуска:

SolutionConsole\Terrasoft. Tools. SolutionConsole. exe - solution=TSBpm - user=Guest - password=Guest - operation=UpdateConfigurationRightsDBStructure - destinationPath=C:\UpLoad\Tests - logPath=C:\UpLoad\Tests\Logs - contentTypes=Data
pause;