Командная строка
Использование ключей командной строки позволяет выполнять функции Business Studio в автоматическом режиме. При запуске приложения "Business Studio.exe" обязательно задание одного из ключа редакций (/enterprise, /professional или /cockpit). В таблице 1 приведен перечень возможных ключей запуска программы и их назначение.
| Ключ | Описание |
|---|---|
| /enterprise | Запуск Business Studio редакции Enterprise. Аналогичен запуску приложения "Business Studio Enterprise.exe". |
| /professional | Запуск Business Studio редакции Professional. Аналогичен запуску приложения "Business Studio Professional.exe". |
| /cockpit | Запуск Business Studio редакции Cockpit. Аналогичен запуску приложения "Business Studio Cockpit.exe". |
| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> | Запуск программы с подключением к указанному SQL Server и базе данных. |
| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" | Создает резервную копию указанной базы данных в файл. |
| /convert [/log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. |
| /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. |
| /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполняет команду системы. Если команда не использует аргумент, то кавычки можно не указывать. |
| /quit | Выход из программы после выполнения всех действий. |
Команды системы
Выполнение команд системы осуществляется только при запуске файла "Business Studio.exe" с одним из ключей редакции (/enterprise, /professional или /cockpit).
Внимание!
Для более удобного восприятия синтаксиса используются следующие обозначения:
- В скобках <> приведены названия аргументов.
- В квадратных скобках [] приведены аргументы, которые не являются обязательными для заполнения.
Символы <> и [] в командной строке писать не нужно.
С примерами команд можно ознакомиться ниже.
Формирование HTML-публикации
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.HTMLПубликация <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
ПУТЬВЫГРУЗКИ - Путь к каталогу HTML-публикации, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст.
ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" Навигатора) или имя сохраненной пометки для фильтрации Навигатора. HTML-публикация будет формироваться только по тем объектам, которые присутствуют в составе этой группы, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-публикация будет сформирована по всем объектам, которые присутствуют в составе группы фильтрации, установленной данным пользователем для Навигатора, или по всему содержимому Навигатора при ее отсутствии.
Доформирование HTML-публикации
Команду можно использовать для того, чтобы закончить формирование HTML-публикации, которое прервали до его завершения.
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.ДоформироватьHTMLПубликацию <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
Требуется указывать такие же, как при формировании HTML-публикации, которое было прервано, подробнее см. в примере Формирование HTML-публикации выше.
Открытие справочника
Вид командной строки: /runcmd="База.Редактор.РедактироватьСписокОбъектов <СИСТЕМНОЕИМЯСПРАВОЧНИКА>"
Аргументы:
СИСТЕМНОЕИМЯСПРАВОЧНИКА - полное системное имя открываемого справочника Business Studio. Системное имя справочника отображается в Объектной модели.
Пакетное формирование отчетов
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.СформироватьОтчетыWord <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
ПУТЬВЫГРУЗКИ - Путь к каталогу отчетов, например C:\Temp\reports\. Путь указывается без кавычек. Каталог должен быть создан.
ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" Навигатора) или имя сохраненной пометки для фильтрации Навигатора. Пакетное формирование отчетов будет производится только по тем объектам, которые будут в Навигаторе при фильтрации по этой группе, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то пакетное формирование будет произведено по всей базе.
Запуск автоматического импорта
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.Автоимпортер [<ПУТЬККАТАЛОГУ>[,<ПАКЕТИМПОРТА>[,<ИНТЕРВАЛЗАДЕРЖКИ>]]]"
Аргументы:
ПУТЬККАТАЛОГУ − путь к каталогу с файлами, указывается без кавычек.
ПАКЕТИМПОРТА − название пакета импорта.
ИНТЕРВАЛЗАДЕРЖКИ - интервал задержки в мс.
Если какие-то из этих аргументов не будут указаны, откроется форма со значениями по умолчанию в соответствующих полях.
Конвертация базы данных
Вид командной строки: /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit
Аргументы:
ИМЯСЕРВЕРА - имя сервера базы данных;
ИМЯБАЗЫДАННЫХ - имя базы данных;
ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации;
ИМЯЛОГФАЙЛА − имя файла для фиксации сообщений, полученных в процессе конвертации.
Экспорт данных из базы
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.ЭкспортироватьДанныеВФайл <ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]"
Аргументы:
ИМЯФАЙЛА - имя файла, в который производится экспорт;
ГРУППА_ПАКЕТИМПОРТА - название группы, по которой производится экспорт, или название пакета импорта, по которому производится экспорт; если параметр не задан, то будет произведен экспорт всей базы данных.
Импорт данных в базу с использованием пакета импорта
Вид командной строки: /runcmd="БизнесМодель.КлиентскиеМетоды.ИмпортироватьДанныеИзФайлаПоПакету <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>"
Аргументы:
ИМЯФАЙЛА - имя файла, из которого импортируются данные;
ПАКЕТИМПОРТА - название пакета импорта, с использованием которого производится импорт данных в базу.
Удаление помеченных объектов из базы данных
Вид командной строки: /runcmd="База.КлиентскиеКлассы.ЖурналУдаления.УдалениеПомеченныхОбъектовИзБазы [<КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>[,<ОЧИСТКА_СОБЫТИЙ>[,<ОЧИСТКА_АУДИТА>]]]"
Аргументы:
КОРРЕКТИРОВКА_БАЗЫ - логическая переменная, указывает необходимость проведения методов корректировки базы, можно установить значение "Нет" для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False;
АВТООЧИСТКА_ССЫЛОК - логическая переменная, указывает необходимость проведения автоматической очистки ссылок на помеченные объекты, можно установить значение "Нет" для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False.
Значение "Да" равнозначно значению "True", значение "Нет" равнозначно значению "False".
ОЧИСТКА_СОБЫТИЙ - дата либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале событий, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале событий будут удалены все записи, кроме записей на один месяц назад от текущей даты.
ОЧИСТКА_АУДИТА - дата либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале аудита, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале аудитов будут удалены все записи, кроме записей на один месяц назад от текущей даты.
Формат задания даты - универсальный (ГГГГ-ММ-ДД) или заданный в региональных настройках операционной системы.
Открытие Окна свойств объекта
Вид командной строки: /runcmd="База.Редактор.РедактироватьОбъект [<GUID>]"
Аргументы:
GUID - значение параметра "guid" объекта, Окно свойств которого требуется открыть.
Другие команды
С синтаксисом других команд можно ознакомиться в интерфейсе администратора системы в справочнике "Действия меню пользователя" (Главное меню → Администрирование → Справочники администрирования → Действия меню пользователя). В Окне свойств действия меню пользователя в параметре "Метод" содержится команда системы (Рис. 1). Например, действие "Показать справочник", в методе которого содержится указанная выше команда 2 - "Открытие справочника", позволяет открыть справочник.
Действия меню пользователя используются при выполнении меню пользователя. Так действие "Показать справочник" выполняется при выборе пункта меню для открытия справочника. В Окне свойств меню пользователя можно посмотреть синтаксис команды. Например, чтобы посмотреть синтаксис команды для открытия Окна справочника "Физические лица", необходимо открыть справочник "Меню пользователя"(Главное меню → Администрирование → Меню пользователя) и открыть Окно свойств соответствующего меню пользователя: МенюПользователя → Модуль БизнесМодель → Меню пользователя → Справочники → Оргструктура → Физические лица. Командой будет параметр "Метод" действия (см. Рис. 1), указанного в параметре "Действие", т.е. "База.Редактор.РедактироватьСписокОбъектов", а аргументом будет значение параметра "Аргумент", т.е. "БизнесМодель.ФизЛица" (Рис. 2).
Таким образом, если, например, необходимо открыть справочник "Физические лица" в базе данных с названием "BASE", которая находится на сервере "SQLSERVER", а Business Studio установлена по пути "C:\Program Files (x86)\STU-Soft\Business Studio 4.2\", то командная строка будет выглядеть следующим образом:
"C:\Program Files (x86)\STU-Soft\Business Studio 4.2\Business Studio.exe" /enterprise /server=SQLSERVER /db=BASE /runcmd="База.Редактор.РедактироватьСписокОбъектов БизнесМодель.ФизЛица".