Различия

Здесь показаны различия между выбранной ревизией и текущей версией данной страницы.

Ссылка на это сравнение

ru:manual:administration:cmd_line [2012/07/03 17:13]
admin
ru:manual:administration:cmd_line [2016/11/25 16:22] (текущий)
Строка 1: Строка 1:
 ====== Командная строка ====== ====== Командная строка ======
  
-Использование ключей командной строки позволяет выполнять функции Business Studio в автоматическом режиме. При запуске приложения «Business Studio.exe» обязательно задание одного из ключа версий %%(/%%enterprise, /professional или /cockpit). В таблице 1 [[ru/manual/administration/cmd_line]] приведен перечень возможных ключей запуска программы и их назначение:+Использование ключей командной строки позволяет выполнять функции Business Studio в автоматическом режиме. При запуске приложения "Business Studio.exe" обязательно задание одного из ключа редакций %%(/%%enterprise, /professional или /cockpit). В таблице 1 приведен перечень возможных ключей запуска программы и их назначение.
  
-Таблица 1. //Параметры командной строки// +<startTableBox> 
- +^  Ключ  ^  Описание  ^ 
-Ключ Описание | +| /enterprise | Запуск Business Studio редакции Enterprise. Аналогичен запуску приложения "Business Studio Enterprise.exe". | 
-| /enterprise | Запуск Business Studio версии Enterprise. Аналогичен запуску приложения «Business Studio Enterprise.exe». | +| /professional | Запуск Business Studio редакции Professional. Аналогичен запуску приложения "Business Studio Professional.exe". | 
-| /professional | Запуск Business Studio версии Professional. Аналогичен запуску приложения «Business Studio Professional.exe». | +| /cockpit | Запуск Business Studio редакции Cockpit. Аналогичен запуску приложения "Business Studio Cockpit.exe". | 
-| /cockpit | Запуск Business Studio версии Cockpit. Аналогичен запуску приложения «Business Studio Cockpit.exe». | +| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ>  | Запуск программы с подключением к указанному SQL Server и базе данных. | 
-| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> | Запуск программы с подключением к указанному серверу и базе данных. | +| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>"  | Создает резервную копию указанной базы данных в файл. |
-| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" | Создает резервную копию указанной базы данных в файл. |+
 | /convert %%[/%%log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. | | /convert %%[/%%log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. |
 | /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. | | /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. |
 | /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполняет команду системы. Если команда не использует аргумент, то кавычки можно не указывать. | | /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполняет команду системы. Если команда не использует аргумент, то кавычки можно не указывать. |
 | /quit | Выход из программы после выполнения всех действий. | | /quit | Выход из программы после выполнения всех действий. |
 +<endTableBox|Таблица 1. Параметры командной строки>
  
-==== Примеры команд ====+===== Команды системы =====
  
-Выполнение команд осуществляется только при запуске файла «Business Studio.exe» с одним из ключей версии %%(/%%enterprise, /professional или /cockpit).+Выполнение команд системы осуществляется только при запуске файла "Business Studio.exe" с одним из ключей редакции %%(/%%enterprise, /professional или /cockpit).
  
-1)     Формирование HTML-Навигатора в папку: 
  
-/runcmd=изнесМодельлиентскиеМетоды.СформироватьHTMLНавигатор <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"+== Внимание! == 
 +Для более удобного восприятия синтаксиса используются следующие обозначения:  
 +  * В скобках **<>** приведены названия аргументов. 
 +  * В квадратных скобках **[]** приведены аргументы, которые не являются обязательными для заполнения. 
 +Символы **<>** и **[]** в командной строке писать не нужно.  
 +===== ===== 
 +\\ 
 +С примерами команд можно ознакомиться ниже.
  
-Аргументы:+==== Формирование HTML-публикации ====
  
-ПУТЬВЫГРУЗКИ -- Путь к каталогу HTML-навигатора, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст.+**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.HTMLПубликация <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
  
-ИМЯГРУППЫ -- Имя группы или имя сохраненной пометки для фильтрации Навигатора. HTML-Навигатор будет формироваться только по тем элементам, которые будут в Навигаторе при фильтрации по этой группе, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-Навигатор будет сформирован по всей базе.+**Аргументы:**
  
-2)     Выбор пункта меню «Отчеты --> Отчеты объектов»:+ПУТЬВЫГРУЗКИ - Путь к каталогу HTML-публикации, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст.
  
-/runcmd="БазаедакторедактироватьСписокОбъектов База.ОтчетыОбъектовWord"+ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" **Навигатора**) или имя сохраненной пометки для фильтрации **Навигатора**. HTML-публикация будет формироваться только по тем объектам, которые присутствуют в составе этой группы, или, если не найдена группа с таким именем, по сохраненной пометкеИмя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-публикация будет сформирована по всем объектам, которые присутствуют в составе группы фильтрации, установленной данным пользователем для **Навигатора**, или по всему содержимому **Навигатора** при ее отсутствии.
  
-Таким образом можно выполнить любой пункт меню. Примеры синтаксиса остальных команд можно посмотреть в интерфейсе администратора системы, в справочнике «Меню пользователя» (пункт меню «Администрирование --> Меню пользователя»).+==== Доформирование HTML-публикации ====
  
-3)     Пакетное формирование отчетов:+Команду можно использовать для того, чтобы закончить формирование HTML-публикации, которое прервали до его завершения.
  
-/runcmd="БизнесМодель.КлиентскиеМетоды.СформироватьОтчетыWord <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"+**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ДоформироватьHTMLПубликацию <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
  
-Аргументы:+**Аргументы:**
  
-ПУТЬВЫГРУЗКИ -- Путь к каталогу отчетов, например C:\Temp\reports\. Путь указывается без кавычек. Каталог должен быть создан.+Требуется указывать такие же, как при формировании HTML-публикации, которое было прерваноподробнее см. в примере [[ru/manual/administration/cmd_line#формирование_html-публикации|Формирование HTML-публикации]] выше.
  
-ИМЯГРУППЫ -- Имя группы или имя сохраненной пометки для фильтрации Навигатора. Пакетное формирование отчетов будет производится только по тем элементам, которые будут в Навигаторе при фильтрации по этой группе, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то пакетное формирование будет произведено по всей базе.+==== Открытие справочника ====
  
-4)     Запуск автоматического импорта:+**Вид командной строки:** /runcmd="База.Редактор.РедактироватьСписокОбъектов <СИСТЕМНОЕИМЯСПРАВОЧНИКА>"
  
-/runcmd="БизнесМодель.КлиентскиеМетоды.Автоимпортер %%[[[%%<ПУТЬККАТАЛОГУ>],<ПАКЕТИМПОРТА>],<ИНТЕРВАЛЗАДЕРЖКИ>]"+**Аргументы:**
  
-Аргументы:+СИСТЕМНОЕИМЯСПРАВОЧНИКА - полное системное имя открываемого справочника Business Studio. Системное имя справочника отображается в **Объектной модели**. 
 + 
 +==== Пакетное формирование отчетов ==== 
 + 
 +**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.СформироватьОтчетыWord <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>" 
 + 
 +**Аргументы:** 
 + 
 +ПУТЬВЫГРУЗКИ - Путь к каталогу отчетов, например C:\Temp\reports\. Путь указывается без кавычек. Каталог должен быть создан. 
 + 
 +ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" **Навигатора**) или имя сохраненной пометки для фильтрации **Навигатора**. Пакетное формирование отчетов будет производится только по тем объектам, которые будут в **Навигаторе** при фильтрации по этой группе, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то пакетное формирование будет произведено по всей базе. 
 + 
 +==== Запуск автоматического импорта ==== 
 + 
 +**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.Автоимпортер [<ПУТЬККАТАЛОГУ>[,<ПАКЕТИМПОРТА>[,<ИНТЕРВАЛЗАДЕРЖКИ>]]]" 
 + 
 +**Аргументы:**
  
 ПУТЬККАТАЛОГУ − путь к каталогу с файлами, указывается без кавычек. ПУТЬККАТАЛОГУ − путь к каталогу с файлами, указывается без кавычек.
Строка 56: Строка 78:
 ПАКЕТИМПОРТА − название пакета импорта. ПАКЕТИМПОРТА − название пакета импорта.
  
-ИНТЕРВАЛЗАДЕРЖКИ -- интервал задержки в мс.+ИНТЕРВАЛЗАДЕРЖКИ - интервал задержки в мс.
  
-Если параметры не указаны, откроется форма с параметрами по умолчанию.+Если какие-то из этих аргументов не будут указаны, откроется форма со значениями по умолчанию в соответствующих полях.
  
-5)     Запуск конвертации базы данных:+==== Конвертация базы данных ====
  
-/server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit+**Вид командной строки:** /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit
  
-Аргументы:+**Аргументы:**
  
-ИМЯСЕРВЕРА -- имя сервера базы данных;+ИМЯСЕРВЕРА - имя сервера базы данных;
  
-ИМЯБАЗЫДАННЫХ -- имя базы данных;+ИМЯБАЗЫДАННЫХ - имя базы данных;
  
 ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации; ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации;
Строка 74: Строка 96:
 ИМЯЛОГФАЙЛА − имя файла для фиксации сообщений, полученных в процессе конвертации. ИМЯЛОГФАЙЛА − имя файла для фиксации сообщений, полученных в процессе конвертации.
  
-6)     Экспорт данных из базы:+==== Экспорт данных из базы ==== 
 + 
 +**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ЭкспортироватьДанныеВФайл  <ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]" 
 + 
 +**Аргументы:** 
 + 
 +ИМЯФАЙЛА - имя файла, в который производится экспорт; 
 + 
 +ГРУППА_ПАКЕТИМПОРТА - название группы, по которой производится экспорт, или название пакета импорта, по которому производится экспорт; если параметр не задан, то будет произведен экспорт всей базы данных. 
 + 
 +==== Импорт данных в базу с использованием пакета импорта ==== 
 + 
 +**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ИмпортироватьДанныеИзФайлаПоПакету   <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>" 
 + 
 +**Аргументы:** 
 + 
 +ИМЯФАЙЛА - имя файла, из которого импортируются данные; 
 + 
 +ПАКЕТИМПОРТА - название пакета импорта, с использованием которого производится импорт данных в базу. 
 + 
 +==== Удаление помеченных объектов из базы данных ==== 
 + 
 +**Вид командной строки:** /runcmd="База.КлиентскиеКлассы.ЖурналУдаления.УдалениеПомеченныхОбъектовИзБазы [<КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>[,<ОЧИСТКА_СОБЫТИЙ>[,<ОЧИСТКА_АУДИТА>]]]" 
 + 
 +**Аргументы:** 
 + 
 +КОРРЕКТИРОВКА_БАЗЫ - логическая переменная, указывает необходимость проведения методов корректировки базы, можно установить значение "Нет" для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False; 
 + 
 +АВТООЧИСТКА_ССЫЛОК - логическая переменная, указывает необходимость проведения автоматической очистки ссылок на помеченные объекты, можно установить значение "Нет" для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False.
  
-/runcmd="БизнесМодель.КлиентскиеМетоды.ЭкспортироватьДанныеВФайл  &lt;ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]"+Значение "Да" равнозначно значению "True", значение етравнозначно значению &quot;False".
  
-Аргументы:+ОЧИСТКА_СОБЫТИЙ - дата либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале событий, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале событий будут удалены все записи, кроме записей на один месяц назад от текущей даты
  
-ИМЯФАЙЛА -имя файла, в который производится экспорт;+ОЧИСТКА_АУДИТА - дата либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале аудита, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале аудитов будут удалены все записи, кроме записей на один месяц назад от текущей даты.
  
-ГРУППА_ПАКЕТИМПОРТА -- название группы, по которой производится экспорт, или название пакета импорта, по которому производится экспорт; если параметр не задан, то будет произведен экспорт всей базы данных.+Формат задания даты - универсальный (ГГГГ-ММ-ДД) или заданный в региональных настройках операционной системы.
  
-7)     Импорт данных в базу с использованием пакета импорта:+==== Открытие Окна свойств объекта ====
  
-/runcmd="БизнесМодель.КлиентскиеМетоды.ИмпортироватьДанныеИзФайлаПоПакету   <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>"+**Вид командной строки:** /runcmd="База.Редактор.РедактироватьОбъект [<GUID>]"
  
-Аргументы:+**Аргументы:**
  
-ИМЯФАЙЛА -- имя файла, из которого импортируются данные;+GUID значение параметра "guid" объекта, **Окно свойств** которого требуется открыть.
  
-ПАКЕТИМПОРТА -- название пакета импорта, с использованием которого производится импорт данных в базу.+==== Другие команды ====
  
-8)     Удаление помеченных объектов из базы данных:+С синтаксисом других команд можно ознакомиться в интерфейсе администратора системы в справочнике "Действия меню пользователя" (**Главное меню -> Администрирование -> Справочники администрирования -> Действия меню пользователя**). В **Окне свойств** действия меню пользователя в параметре "Метод" содержится команда системы (Рис. 1). Например, действие "Показать справочник", в методе которого содержится указанная выше команда 2 - "Открытие справочника", позволяет открыть справочник.
  
-/runcmd="База.КлиентскиеКлассы.ЖурналУдаления.УдалениеПомеченныхОбъектовИзБазы [&lt;КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>;]"+[{{ ru/manual/administration/cmd_line/cmd_line_001.png?nolink |Рисунок 1Справочник "Действия меню пользователя&quot;}}
  
-Аргументы:+Действия меню пользователя используются при выполнении меню пользователя. Так действие "Показать справочник" выполняется при выборе пункта меню для открытия справочника. В **Окне свойств** меню пользователя можно посмотреть синтаксис команды. Например, чтобы посмотреть синтаксис команды для открытия **Окна справочника** "Физические лица", необходимо открыть справочник "Меню пользователя"(**Главное меню -> Администрирование -> Меню пользователя**) и открыть **Окно свойств** соответствующего меню пользователя**МенюПользователя -> Модуль БизнесМодель -> Меню пользователя -> Справочники -> Оргструктура -> Физические лица**. Командой будет параметр "Метод" действия (см. Рис. 1), указанного в параметре "Действие", т.е. "База.Редактор.РедактироватьСписокОбъектов", а аргументом будет значение параметра "Аргумент", т.е. "БизнесМодель.ФизЛица" (Рис. 2).
  
-КОРРЕКТИРОВКА_БАЗЫ -- логическая переменная, указывает необходимость проведения методов корректировки базы, можно установить значение «Нет» для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: True, False, Да, Нет;+[{{ ru/manual/administration/cmd_line/cmd_line_002.png?nolink |Рисунок 2. **Окно свойств** меню пользователя}}] 
  
-АВТООЧИСТКА_ССЫЛОК -- логическая переменнаяуказывает необходимость проведения автоматической очистки ссылок на помеченные объекты, можно установить значение «Нет» для ускорения процедуры удаления, например при продолжении прерванного удаления. ВариантыTrue, False, Да, Нет.+Таким образом, если, например, необходимо открыть справочник "Физические лица" в базе данных с названием "BASE", которая находится на сервере "SQLSERVER", а Business Studio установлена по пути "C:\Program Files (x86)\STU-Soft\Business Studio 4.2\", то командная строка будет выглядеть следующим образом:
  
-9    Открытие окна свойств объекта:+"C:\Program Files (x86)\STU-Soft\Business Studio 4.2\Business Studio.exe" /enterprise /server=SQLSERVER /db=BASE /runcmd="База.Редактор.РедактироватьСписокОбъектов БизнесМодель.ФизЛица".
  
-/runcmd="База.Редактор.РедактироватьОбъект [<GUID>]" 
  
-Аргументы: 
  
-GUID -- значение параметра «guid» объекта, окно свойств которого требуется открыть. 
  
-==== Пример. Синтаксис команды ==== 
  
-Чтобы посмотреть синтаксис команды для открытия окна справочника «Физические лица» необходимо открыть справочник «Меню пользователя» и открыть свойства соответствующего элемента меню пользователя: «Модуль БизнесМодель --&gt; Меню пользователя -->Справочники --Физические лица». Командой будет параметр «Метод» в свойствах параметра «Действие», т.е. «База.Редактор.РедактироватьСписокОбъектов», а аргументом будет параметр «Аргумент», т.е. «БизнесМодель.ФизЛица».+[&lt;contextnavigator>]
  
-Таким образом, если, например, нам необходимо открыть этот справочник в базе данных с названием «BASE», которая находится на сервере «SQLSERVER», а Business Studio установлена по пути «C:\Program Files (x86)\STU-Soft\Business Studio 3.6\», то соответствующая строка будет выглядеть следующим образом: 
  
-"C:\Program Files (x86)\STU-Soft\Business Studio 3.6\Business Studio.exe" /enterprise /server=SQLSERVER /db=BASE /runcmd="База.Редактор.РедактироватьСписокОбъектов БизнесМодель.ФизЛица". 
Актуальные новости, публикации и практики для бизнес-архитекторов и аналитиков
Driven by DokuWiki