Командная строка
Использование ключей командной строки позволяет выполнять функции Business Studio в автоматическом режиме.
Выполнить необходимые действия командной строки можно несколькими различными способами, например:
- Запустить командную строку (например, через Пуск - Выполнить - cmd), задать в ней путь к исполняемому файлу, необходимые команды и ключи и выполнить (нажать кнопку Enter).
- Создать ярлык на исполняемый файл (exe), в его свойствах прописать командную строку с нужными командами и ключами и запустить этот ярлык.
При запуске приложения "Business Studio.exe" обязательно задание одного из ключа редакций (/enterprise, /professional, /ultimate или /cockpit). В таблице 1 приведен перечень возможных ключей запуска программы и их назначение.
| Ключ | Описание |
|---|---|
| /enterprise | Запуск Business Studio редакции Enterprise. Аналогичен запуску приложения "Business Studio Enterprise.exe". |
| /professional | Запуск Business Studio редакции Professional. Аналогичен запуску приложения "Business Studio Professional.exe". |
| /ultimate | Запуск Business Studio редакции Ultimate. Аналогичен запуску приложения "Business Studio Ultimate.exe". |
| /cockpit | Запуск Business Studio редакции Cockpit. Аналогичен запуску приложения "Business Studio Cockpit.exe". |
| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> [/branch=<ИДЕНТИФИКАТОРВЕТКИ>] | Запуск программы с подключением к указанной базе данных, где <ИМЯСЕРВЕРА> - имя сервера SQL <ИМЯБАЗЫДАННЫХ> - название базы данных <ТИПБАЗЫ> - тип базы данных: MSSQL или PGSQL <ИДЕНТИФИКАТОРВЕТКИ> - идентификатор ветки базы данных. Если ветка не указана, то будет запущена корневая ветка. |
| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> /backup="<ИМЯКОПИИ>" | Создание резервной копии указанной базы данных в файл. |
| /convert [/log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. |
| /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. |
| /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполнение команды системы. Если команда не использует аргумент, то кавычки можно не указывать. |
| /quit | Выход из программы после выполнения всех действий. |
Внимание! Все команды и ключи вводятся после полного пути к файлу, указанного в кавычках.
Например, команда запуска Business Studio в редакции Professional, если программа установлена по пути, предлагаемому по умолчанию, будет выглядеть следующим образом:
"C:\Program Files (x86)\STU-Soft\Business Studio 6\Business Studio.exe" /professional
Команды системы
Выполнение команд системы осуществляется только при запуске файла "Business Studio.exe" с одним из ключей редакции (/enterprise, /professional, /ultimate или /cockpit).
Внимание! Для более удобного восприятия синтаксиса используются следующие обозначения:
- В скобках <> приведены названия аргументов.
- В квадратных скобках [] приведены аргументы, которые не являются обязательными для заполнения.
Символы <> и [] в командной строке писать не нужно.
С примерами команд можно ознакомиться ниже.
Формирование отчёта
Вид командной строки: /runcmd="AppPlatform.FastReport.ExecuteReport <GUIDОТЧЁТА>"
Аргументы:
GUIDОТЧЁТА - guid отчёта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка параметров" в Окне свойств отчёта (подробнее см. Меню свойств объекта).
Формирование отчёта объекта
Вид командной строки: /runcmd="AppPlatform.FastReport.ExecuteReport <GUIDОТЧЁТАОБЪЕКТА>,<GUIDАРГУМЕНТА>"
GUIDОТЧЁТАОБЪЕКТА - guid отчёта объекта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка параметров" в Окне свойств отчёта (подробнее см. Меню свойств объекта).
GUIDАРГУМЕНТА - guid объекта, от которого вызывается отчёт. Класс объекта должен совпадать с классом, для которого был создан отчёт.
Формирование HTML-публикации
Вид командной строки: /runcmd="BizArch.ClientMethods.HTMLPublication <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
ПУТЬВЫГРУЗКИ - Путь к каталогу HTML-публикации, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст.
ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы объектов справочников", а также объекты всех справочников со вкладки "Методы управления" Навигатора) или имя сохраненной пометки для фильтрации Навигатора. HTML-публикация будет формироваться только по тем объектам, которые присутствуют в составе этой группы, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-публикация будет сформирована по всем объектам, которые присутствуют в составе группы фильтрации, установленной данным пользователем для Навигатора, или по всему содержимому Навигатора при ее отсутствии.
Доформирование HTML-публикации
Команду можно использовать для того, чтобы закончить формирование HTML-публикации, которое прервали до его завершения.
Вид командной строки: /runcmd="BizArch.ClientMethods.FinishHTMLPublicationGeneration <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
Требуется указывать такие же, как при формировании HTML-публикации, которое было прервано, подробнее см. в примере Формирование HTML-публикации выше.
Открытие справочника
Вид командной строки: /runcmd="AppPlatform.Editor.EditObjectList <СИСТЕМНОЕИМЯСПРАВОЧНИКА>"
Аргументы:
СИСТЕМНОЕИМЯСПРАВОЧНИКА - полное системное имя открываемого справочника Business Studio. Системное имя справочника отображается в Объектной модели.
Пакетное формирование отчетов
Вид командной строки: /runcmd="BizArch.ClientMethods.GenerateReports <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
Аргументы:
ПУТЬВЫГРУЗКИ - Путь к каталогу отчетов, например C:\Temp\reports\. Путь указывается без кавычек. Каталог должен быть создан.
ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" Навигатора) или имя сохраненной пометки для фильтрации Навигатора. Пакетное формирование отчетов будет производится только по тем объектам, которые будут в Навигаторе при фильтрации по этой группе, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то пакетное формирование будет произведено по всей базе.
Запуск автоматического импорта
Вид командной строки:
/runcmd="BizArch.ClientMethods.Autoimport [<ПУТЬККАТАЛОГУ>[,<ПАКЕТИМПОРТА>[,<ИНТЕРВАЛЗАДЕРЖКИ>]]]"
Аргументы:
ПУТЬККАТАЛОГУ − путь к каталогу с файлами, указывается без кавычек.
ПАКЕТИМПОРТА − название пакета импорта.
ИНТЕРВАЛЗАДЕРЖКИ - интервал задержки в мс.
Если какие-то из этих аргументов не будут указаны, откроется форма со значениями по умолчанию в соответствующих полях.
Конвертация базы данных
Вид командной строки: /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit
Аргументы:
ИМЯСЕРВЕРА - имя сервера базы данных;
ИМЯБАЗЫДАННЫХ - имя базы данных;
ТИПБАЗЫ - тип базы данных MSSQL или PGSQL;
ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации;
ИМЯЛОГФАЙЛА − имя файла для фиксации сообщений, полученных в процессе конвертации.
Экспорт данных из базы
Вид командной строки: /runcmd="BizArch.ClientMethods.ExportDataToFile <ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]"
Аргументы:
ИМЯФАЙЛА - имя файла, в который производится экспорт;
ГРУППА_ПАКЕТИМПОРТА - название группы, по которой производится экспорт, или название пакета импорта, по которому производится экспорт; если параметр не задан, то будет произведен экспорт всей базы данных.
Импорт данных в базу с использованием пакета импорта
Вид командной строки: /runcmd="BizArch.ClientMethods.ImportDataFromPackageBasedFile <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>"
Аргументы:
ИМЯФАЙЛА - имя файла, из которого импортируются данные;
ПАКЕТИМПОРТА - название пакета импорта, с использованием которого производится импорт данных в базу.
Удаление помеченных объектов из базы данных
Вид командной строки:
/runcmd="AppPlatform.ClientClasses.PhysicalDeletion.DeleteMarkedObjectsFromDatabase <ОЧИСТКА_СОБЫТИЙ>,<ОЧИСТКА_АУДИТА>;[<ПОМЕЧЕННЫЕ_НА_УДАЛЕНИЕ>,<КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>,<ДЕФРАГМЕНТАЦИЯ>,<ОЧИСТКА_ОБЪЕКТОВ_ИМПОРТА>]"
Аргументы:
ОЧИСТКА_СОБЫТИЙ - дата, либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале событий, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале событий будут удалены все записи, кроме записей на один месяц назад от текущей даты.
ОЧИСТКА_АУДИТА - дата, либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале аудита, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале аудитов будут удалены все записи, кроме записей на один месяц назад от текущей даты.
Формат задания даты - универсальный (ГГГГ-ММ-ДД) или заданный в региональных настройках операционной системы.
ПОМЕЧЕННЫЕ_НА_УДАЛЕНИЕ – переменная, указывает необходимость проведения удаления данных, помеченных на удаление. Можно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: DeleteMarked.
КОРРЕКТИРОВКА_БАЗЫ - переменная, указывает необходимость проведения методов корректировки базы. Можно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: AllMethods.
АВТООЧИСТКА_ССЫЛОК - переменная, указывает необходимость проведения автоматической очистки ссылок на помеченные объекты. Можно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: ClearRefs.
ДЕФРАГМЕНТАЦИЯ - переменная, указывает необходимость проведения дефграментации и обновления статистики индексов. Можно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: Defragment.
ОЧИСТКА_ОБЪЕКТОВ_ИМПОРТА - переменная, указывает необходимость удаления объектов импорта. Можно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: ClearImport.
Примеры использования:
/runcmd="AppPlatform.ClientClasses.PhysicalDeletion.DeleteMarkedObjectsFromDatabase 31,30;DeleteMarked,ClearRefs,ClearImport"
/runcmd="AppPlatform.ClientClasses.PhysicalDeletion.DeleteMarkedObjectsFromDatabase 2999-01-01,2999-01-01;AllMethods"
/runcmd="AppPlatform.ClientClasses.PhysicalDeletion.DeleteMarkedObjectsFromDatabase 2999-01-01,2999-01-01"
Открытие Окна свойств объекта
Вид командной строки: /runcmd="AppPlatform.Editor.EditObject [<GUID>]"
Аргументы:
GUID - значение параметра "guid" объекта, Окно свойств которого требуется открыть.
Другие команды
С синтаксисом других команд можно ознакомиться в интерфейсе администратора системы в справочнике "Действия меню пользователя" (Меню Администратора → Администрирование → Объекты администрирования → Действия меню пользователя). В параметре "Метод" содержится команда системы (Рис. 1). Например, действие "Показать справочник", в методе которого содержится указанная выше команда, позволяет открыть справочник.
Действия меню пользователя используются при выполнении меню пользователя. Так действие "Показать справочник" выполняется при выборе пункта меню для открытия справочника. В Окне свойств меню пользователя можно посмотреть синтаксис команды. Например, чтобы посмотреть синтаксис команды для открытия Окна справочника "Физические лица", необходимо открыть справочник "Меню пользователя"(Главное меню → Администрирование → Меню пользователя) и открыть Окно свойств соответствующего меню пользователя: Меню Business Studio → Меню пользователя → Справочники → Оргструктура → Физические лица. Командой будет параметр "Метод" действия (см. Рис. 1), указанного в параметре "Действие", т.е. "AppPlatform.Editor.EditObjectList", а аргументом будет значение параметра "Аргумент", т.е. "AppPlatform.Person" (Рис. 2).
Например, чтобы открыть справочник "Физические лица" в базе данных с названием "BASE", которая находится на сервере "SQLSERVER", нужно в командной строке ввести:
C:\Program Files (x86)\STU-Soft\Business Studio 6\"Business Studio.exe" /ultimate /server=SQLSERVER /db=BASE /dbtype=MSSQL /runcmd="AppPlatform.Editor.EditObjectList AppPlatform.Person"