Различия

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

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

ru:manual:administration:cmd_line [2021/05/18 08:56]
gorbunova [Командная строка]
ru:manual:administration:cmd_line [2024/07/12 14:47] (текущий)
filchagin.s [Удаление помеченных объектов из базы данных]
Строка 13: Строка 13:
 | /ultimate | Запуск Business Studio редакции Ultimate. Аналогичен запуску приложения "Business Studio Ultimate.exe". | | /ultimate | Запуск Business Studio редакции Ultimate. Аналогичен запуску приложения "Business Studio Ultimate.exe". |
 | /cockpit | Запуск Business Studio редакции Cockpit. Аналогичен запуску приложения "Business Studio Cockpit.exe". | | /cockpit | Запуск Business Studio редакции Cockpit. Аналогичен запуску приложения "Business Studio Cockpit.exe". |
-| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> [/branch=<ИДЕНТИФИКАТОРВЕТКИ>]  | Запуск программы с подключением к указанному SQL Server базе данных и ветке по её идентификатору. Если ветка не указана, то будет запущена актуальная модель. | +| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> [/branch=<ИДЕНТИФИКАТОРВЕТКИ>]  | Запуск программы с подключением к указанной  базе данных, где\\ <ИМЯСЕРВЕРА> - имя сервера SQL\\ <ИМЯБАЗЫДАННЫХ> - название базы данных\\ <ТИПБАЗЫ> - тип базы данных: MSSQL или PGSQL\\  <ИДЕНТИФИКАТОРВЕТКИ> - идентификатор ветки базы данных. Если ветка не указана, то будет запущена корневая ветка. | 
-| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>"  | Создает резервную копию указанной базы данных в файл. |+| /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> /backup="<ИМЯКОПИИ>"  | Создание резервной копии указанной базы данных в файл. |
 | /convert %%[/%%log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. | | /convert %%[/%%log="<ИМЯЛОГФАЙЛА>"] | Запуск конвертации базы данных. Если указан ключ /log, то сообщения, возникающие в процессе конвертации, будут записаны в лог-файл. |
 | /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. | | /showlogin | Использование SQL режима аутентификации − будет предложен диалог ввода логина и пароля. |
-| /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполняет команду системы. Если команда не использует аргумент, то кавычки можно не указывать. |+| /runcmd="<КОМАНДА> [,<АРГУМЕНТ>]" | Выполнение команды системы. Если команда не использует аргумент, то кавычки можно не указывать. |
 | /quit | Выход из программы после выполнения всех действий. | | /quit | Выход из программы после выполнения всех действий. |
 <endTableBox|Таблица 1. Параметры командной строки> <endTableBox|Таблица 1. Параметры командной строки>
 \\ \\
 == == == ==
-**Внимание!** Все команды и ключи вводятся после полного пути к файлу, указанного в кавычках. \\ Например, команда запуска Business Studio в редакции Professional, если программа установлена по пути, предлагаемому по умолчанию, будет выглядеть следующим образом: \\ // "C:\Program Files (x86)\STU-Soft\Business Studio 5\Business Studio.exe"  /professional  +**Внимание!** Все команды и ключи вводятся после полного пути к файлу, указанного в кавычках. \\ Например, команда запуска Business Studio в редакции Professional, если программа установлена по пути, предлагаемому по умолчанию, будет выглядеть следующим образом: \\ // "C:\Program Files (x86)\STU-Soft\Business Studio 6\Business Studio.exe"  /professional  
 // //
 ===== ===== ===== =====
 ===== Команды системы ===== ===== Команды системы =====
  
-Выполнение команд системы осуществляется только при запуске файла "Business Studio.exe" с одним из ключей редакции %%(/%%enterprise, /professional или /cockpit).+Выполнение команд системы осуществляется только при запуске файла "Business Studio.exe" с одним из ключей редакции %%(/%%enterprise, /professional, /ultimate или /cockpit).
  
  
Строка 39: Строка 39:
 С примерами команд можно ознакомиться ниже. С примерами команд можно ознакомиться ниже.
  
-==== Формирование статического отчёта ====+==== Формирование отчёта ====
  
-**Вид командной строки:** /runcmd="База.КлиентскиеМетоды.ВыполнитьОтчет <GUIDСТАТИЧЕСКОГООТЧЁТА>"+**Вид командной строки:** /runcmd="AppPlatform.FastReport.ExecuteReport <GUIDОТЧЁТА>"
  
 **Аргументы:** **Аргументы:**
  
-GUIDСТАТИЧЕСКОГООТЧЁТА - guid статического отчёта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка колонок" в **Окне свойств** отчёта (подробнее см. [[ru/manual/interface/edit_object#меню_окна_свойств_объекта|Меню свойств объекта]]).+GUIDОТЧЁТА - guid отчёта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка параметров" в **Окне свойств** отчёта (подробнее см. [[ru/manual/interface/edit_object#меню_окна_свойств_объекта|Меню свойств объекта]]).
  
-==== Формирование динамического отчёта ====+==== Формирование отчёта объекта ====
  
-**Вид командной строки:** /runcmd="База.КлиентскиеМетоды.ВыполнитьОтчет <GUIDДИНАМИЧЕСКОГООТЧЁТА>,<GUIDАРГУМЕНТА>"+**Вид командной строки:** /runcmd="AppPlatform.FastReport.ExecuteReport <GUIDОТЧЁТАОБЪЕКТА>,<GUIDАРГУМЕНТА>"
  
-GUIDДИНАМИЧЕСКОГООТЧЁТА - guid динамического отчёта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка колонок" в **Окне свойств** отчёта (подробнее см. [[ru/manual/interface/edit_object#меню_окна_свойств_объекта|Меню свойств объекта]]).+GUIDОТЧЁТАОБЪЕКТА - guid отчёта объекта. По умолчанию параметр скрыт. Вывести его на показ можно с помощью меню "Действия - Настройка параметров" в **Окне свойств** отчёта (подробнее см. [[ru/manual/interface/edit_object#меню_окна_свойств_объекта|Меню свойств объекта]]).
  
 GUIDАРГУМЕНТА - guid объекта, от которого вызывается отчёт. GUIDАРГУМЕНТА - guid объекта, от которого вызывается отчёт.
Строка 58: Строка 58:
 ==== Формирование HTML-публикации ==== ==== Формирование HTML-публикации ====
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.HTMLПубликация <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"+**Вид командной строки:** /runcmd="BizArch.ClientMethods.HTMLPublication <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
  
 **Аргументы:** **Аргументы:**
Строка 64: Строка 64:
 ПУТЬВЫГРУЗКИ - Путь к каталогу HTML-публикации, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст. ПУТЬВЫГРУЗКИ - Путь к каталогу HTML-публикации, например "C:\Temp\web\". Путь указывается без кавычек. Каталог должен быть создан и пуст.
  
-ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы", а также объекты всех справочников со вкладки "Управление" **Навигатора**) или имя сохраненной пометки для фильтрации **Навигатора**. HTML-публикация будет формироваться только по тем объектам, которые присутствуют в составе этой группы, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-публикация будет сформирована по всем объектам, которые присутствуют в составе группы фильтрации, установленной данным пользователем для **Навигатора**, или по всему содержимому **Навигатора** при ее отсутствии.+ИМЯГРУППЫ - Имя группы (к группам относятся объекты со вкладки "Группы объектов справочников", а также объекты всех справочников со вкладки "Методы управления" **Навигатора**) или имя сохраненной пометки для фильтрации **Навигатора**. HTML-публикация будет формироваться только по тем объектам, которые присутствуют в составе этой группы, или, если не найдена группа с таким именем, по сохраненной пометке. Имя сохраненной пометки не должно встречаться среди имен групп. Если ИМЯГРУППЫ не указано, то HTML-публикация будет сформирована по всем объектам, которые присутствуют в составе группы фильтрации, установленной данным пользователем для **Навигатора**, или по всему содержимому **Навигатора** при ее отсутствии.
  
 ==== Доформирование HTML-публикации ==== ==== Доформирование HTML-публикации ====
Строка 70: Строка 70:
 Команду можно использовать для того, чтобы закончить формирование HTML-публикации, которое прервали до его завершения. Команду можно использовать для того, чтобы закончить формирование HTML-публикации, которое прервали до его завершения.
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ДоформироватьHTMLПубликацию <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"+**Вид командной строки:** /runcmd="BizArch.ClientMethods.FinishHTMLPublicationGeneration <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
  
 **Аргументы:** **Аргументы:**
Строка 78: Строка 78:
 ==== Открытие справочника ==== ==== Открытие справочника ====
  
-**Вид командной строки:** /runcmd="База.Редактор.РедактироватьСписокОбъектов <СИСТЕМНОЕИМЯСПРАВОЧНИКА>"+**Вид командной строки:** /runcmd="AppPlatform.Editor.EditObjectList <СИСТЕМНОЕИМЯСПРАВОЧНИКА>"
  
 **Аргументы:** **Аргументы:**
Строка 86: Строка 86:
 ==== Пакетное формирование отчетов ==== ==== Пакетное формирование отчетов ====
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.СформироватьОтчетыWord <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"+**Вид командной строки:** /runcmd="BizArch.ClientMethods.GenerateReports <ПУТЬВЫГРУЗКИ>,<ИМЯГРУППЫ>"
  
 **Аргументы:** **Аргументы:**
Строка 96: Строка 96:
 ==== Запуск автоматического импорта ==== ==== Запуск автоматического импорта ====
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.Автоимпортер [<ПУТЬККАТАЛОГУ>[,<ПАКЕТИМПОРТА>[,<ИНТЕРВАЛЗАДЕРЖКИ>]]]"+**Вид командной строки:**\\ /runcmd="BizArch.ClientMethods.Autoimport [<ПУТЬККАТАЛОГУ>[,<ПАКЕТИМПОРТА>[,<ИНТЕРВАЛЗАДЕРЖКИ>]]]"
  
 **Аргументы:** **Аргументы:**
Строка 110: Строка 110:
 ==== Конвертация базы данных ==== ==== Конвертация базы данных ====
  
-**Вид командной строки:** /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit+**Вид командной строки:** /server=<ИМЯСЕРВЕРА> /db=<ИМЯБАЗЫДАННЫХ> /dbtype=<ТИПБАЗЫ> /backup="<ИМЯКОПИИ>" /convert /log="<ИМЯЛОГФАЙЛА>" /quit
  
 **Аргументы:** **Аргументы:**
Строка 117: Строка 117:
  
 ИМЯБАЗЫДАННЫХ - имя базы данных; ИМЯБАЗЫДАННЫХ - имя базы данных;
 +
 +ТИПБАЗЫ - тип базы данных MSSQL или PGSQL;
  
 ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации; ИМЯКОПИИ − имя резервной копии базы данных, которая создается до конвертации;
Строка 124: Строка 126:
 ==== Экспорт данных из базы ==== ==== Экспорт данных из базы ====
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ЭкспортироватьДанныеВФайл  <ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]"+**Вид командной строки:** /runcmd="BizArch.ClientMethods.ExportDataToFile  <ИМЯФАЙЛА>,[<ГРУППА_ПАКЕТИМПОРТА>]"
  
 **Аргументы:** **Аргументы:**
Строка 134: Строка 136:
 ==== Импорт данных в базу с использованием пакета импорта ==== ==== Импорт данных в базу с использованием пакета импорта ====
  
-**Вид командной строки:** /runcmd="БизнесМодель.КлиентскиеМетоды.ИмпортироватьДанныеИзФайлаПоПакету   <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>"+**Вид командной строки:** /runcmd="BizArch.ClientMethods.ImportDataFromPackageBasedFile 
 +   <ИМЯФАЙЛА>,<ПАКЕТИМПОРТА>"
  
 **Аргументы:** **Аргументы:**
Строка 144: Строка 147:
 ==== Удаление помеченных объектов из базы данных ==== ==== Удаление помеченных объектов из базы данных ====
  
-**Вид командной строки:** /runcmd="База.КлиентскиеКлассы.ЖурналУдаления.УдалениеПомеченныхОбъектовИзБазы [<КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>[,<ОЧИСТКА_СОБЫТИЙ>[,<ОЧИСТКА_АУДИТА>]]]"+**Вид командной строки:**\\ /runcmd="AppPlatform.ClientClasses.PhysicalDeletion.DeleteMarkedObjectsFromDatabase <ОЧИСТКА_СОБЫТИЙ>,<ОЧИСТКА_АУДИТА>;[<ПОМЕЧЕННЫЕ_НА_УДАЛЕНИЕ>,<КОРРЕКТИРОВКА_БАЗЫ>,<АВТООЧИСТКА_ССЫЛОК>,<ДЕФРАГМЕНТАЦИЯ>,<ОЧИСТКА_ОБЪЕКТОВ_ИМПОРТА>]"
  
 **Аргументы:** **Аргументы:**
  
-КОРРЕКТИРОВКА_БАЗЫ - логическая переменная, указывает необходимость проведения методов корректировки базы, можно установить значение "Нетдля ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False;+ОЧИСТКА_СОБЫТИЙ дата, либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале событий, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале событий будут удалены все записи, кроме записей на один месяц назад от текущей даты.
  
-АВТООЧИСТКА_ССЫЛОК - логическая переменная, указывает необходимость проведения автоматической очистки ссылок на помеченные объекты, можно установить значение "Нет" для ускорения процедуры удаления, например при продолжении прерванного удаления. Варианты: Да, Нет, True, False.+ОЧИСТКА_АУДИТА дата, либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале аудита, созданные до этой даты, будут удалены. Если аргумент не задан, в Журнале аудитов будут удалены все записи, кроме записей на один месяц назад от текущей даты.
  
-Значение "Да" равнозначно значению "True", значение "Нетравнозначно значению "False".+Формат задания даты - универсальный (ГГГГ-ММ-ДД) или заданный в региональных настройках операционной системы.
  
-ОЧИСТКА_СОБЫТИЙ - дата либо количество дней, отсчитываемых назад от текущей даты. Все записи в Журнале событий, созданные до этой даты, будут удаленыЕсли аргумент не задан, в Журнале событий будут удалены все записи, кроме записей на один месяц назад от текущей даты+ПОМЕЧЕННЫЕ_НА_УДАЛЕНИЕ – переменная, указывает необходимость проведения удаления данных, помеченных на удалениеМожно пропустить аргумент для ускорения процедуры удаления, например при продолжении прерванного удаления. Аргумент для использования: 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="База.Редактор.РедактироватьОбъект [<GUID>]"+**Вид командной строки:** /runcmd="AppPlatform.Editor.EditObject [<GUID>]"
  
 **Аргументы:** **Аргументы:**
Строка 170: Строка 182:
 ==== Другие команды ==== ==== Другие команды ====
  
-С синтаксисом других команд можно ознакомиться в интерфейсе администратора системы в справочнике "Действия меню пользователя" ({{bslink>Меню Администратора → Администрирование → Справочники администрирования|ShowRibbonPageOrItem?mi_Adm;miSprAdmin:Item}} -> **Действия меню пользователя**). В **Окне свойств** действия меню пользователя в параметре "Метод" содержится команда системы (Рис. 1). Например, действие "Показать справочник", в методе которого содержится указанная выше команда 2 - "Открытие справочника", позволяет открыть справочник.+С синтаксисом других команд можно ознакомиться в интерфейсе администратора системы в справочнике "Действия меню пользователя" ({{bslink>Меню Администратора → Администрирование → Объекты администрирования|ShowRibbonPageOrItem?mi_Adm;miSprAdmin:Item}} -> **Действия меню пользователя**). В параметре "Метод" содержится команда системы (Рис. 1). Например, действие "Показать справочник", в методе которого содержится указанная выше команда, позволяет открыть справочник.
  
  
-[{{ ru/manual/administration/cmd_line/autot_cmd_line_001.png?nolink |Рисунок 1. Справочник "Действия меню пользователя"}}] +[{{ ru/manual/administration/cmd_line/autot_cmd_line_003.png?nolink |Рисунок 1. Справочник "Действия меню пользователя"}}] 
  
-Действия меню пользователя используются при выполнении меню пользователя. Так действие "Показать справочник" выполняется при выборе пункта меню для открытия справочника. В **Окне свойств** меню пользователя можно посмотреть синтаксис команды. Например, чтобы посмотреть синтаксис команды для открытия **Окна справочника** "Физические лица", необходимо открыть справочник "Меню пользователя"(**Главное меню -> Администрирование -> Меню пользователя**) и открыть **Окно свойств** соответствующего меню пользователя: **МенюПользователя -> Модуль БизнесМодель -> Меню пользователя -> Справочники -> Оргструктура -> Физические лица**. Командой будет параметр "Метод" действия (см. Рис. 1), указанного в параметре "Действие", т.е. "База.Редактор.РедактироватьСписокОбъектов", а аргументом будет значение параметра "Аргумент", т.е. "БизнесМодель.ФизЛица" (Рис. 2).+Действия меню пользователя используются при выполнении меню пользователя. Так действие "Показать справочник" выполняется при выборе пункта меню для открытия справочника. В **Окне свойств** меню пользователя можно посмотреть синтаксис команды. Например, чтобы посмотреть синтаксис команды для открытия **Окна справочника** "Физические лица", необходимо открыть справочник "Меню пользователя"(**Главное меню -> Администрирование -> Меню пользователя**) и открыть **Окно свойств** соответствующего меню пользователя: **Меню Business Studio -> Меню пользователя -> Справочники -> Оргструктура -> Физические лица**. Командой будет параметр "Метод" действия (см. Рис. 1), указанного в параметре "Действие", т.е. "AppPlatform.Editor.EditObjectList", а аргументом будет значение параметра "Аргумент", т.е. "AppPlatform.Person" (Рис. 2).
  
-[{{ ru/manual/administration/cmd_line/autot_cmd_line_002.png?nolink |Рисунок 2. **Окно свойств** меню пользователя}}] +[{{ ru/manual/administration/cmd_line/autot_cmd_line_005.png?nolink |Рисунок 2. **Окно свойств** меню пользователя}}] 
  
-Таким образом, если, например, необходимо открыть справочник "Физические лица" в базе данных с названием "BASE", которая находится на сервере "SQLSERVER", а Business Studio установлена по пути "C:\Program Files (x86)\STU-Soft\Business Studio 4.2\", то командная строка будет выглядеть следующим образом:+Например, чтобы открыть справочник "Физические лица" в базе данных с названием "BASE", которая находится на сервере "SQLSERVER", нужно в командной строке ввести:
  
-"C:\Program Files (x86)\STU-Soft\Business Studio 4.2\Business Studio.exe" /enterprise /server=SQLSERVER /db=BASE /runcmd="База.Редактор.РедактироватьСписокОбъектов БизнесМодель.ФизЛица".+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"
  
  
Строка 190: Строка 202:
  
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +{(rater>id=ru_manual_administration_cmd_line|name=Командная строка|type=vote|trace=ip|headline=off)}
Driven by DokuWiki